Skip to main content

Fetch All Campaigns Information

API: goGetAllCampaigns


Description

This endpoint provides a detailed list of all campaigns configured in the system, along with their properties and current status. The response includes essential information about each campaign, such as the name, dialing method, auto-dial level, and its activation status.

🔗 URL

https://DOMAIN.croco-dial.net/goAPIv2/goCampaigns/goAPI.php

Note: Replace DOMAIN with the specific domain you want to query.


📝 Required Parameters

ParameterValueDescription
goActiongoGetAllCampaignsAction to retrieve all campaigns.
goUserMyUserAPI authorized user.
goPassMyPassPassword for the API authorized user.
responsetypejson/xmlFormat of the response (json recommended).

Note: This endpoint uses body parameters for authentication instead of tokens or headers.

Request Examples:

GET:

curl -X GET "https://DOMAIN.croco-dial.net/goAPIv2/goCampaigns/goAPI.php?goAction=goGetAllCampaigns&goUser=MyUser&goPass=MyPass&responsetype=json"

POST (Form Data):

If you prefer to send the data as form parameters:

curl -X POST "https://DOMAIN.croco-dial.net/goAPIv2/goCampaigns/goAPI.php" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "goAction=goGetAllCampaigns" \
  --data-urlencode "goUser=MyUser" \
  --data-urlencode "goPass=Mypass" \
  --data-urlencode "responsetype=json"

  Example Response

{
    "result": "success",
    "data": {
        "rows": [
            {
                "id": "99999999",
                "campaign_name": "SERVERS",
                "dialer": "Y",
                "campaign_vdad_exten": "Y",
                "list_order_mix": "Y",
                "dial_method": "POWER DIAL",
                "auto_dial_level": "3",
                "active": "Y"
            },
            {
                "id": "88888888",
                "campaign_name": "DEFAULT",
                "dialer": "N",
                "campaign_vdad_exten": "Y",
                "list_order_mix": "Y",
                "dial_method": "POWER DIAL",
                "auto_dial_level": "0",
                "active": "Y"
            },
            {
                "id": "77777777",
                "campaign_name": "COLLECTIONS",
                "dialer": "Y",
                "campaign_vdad_exten": "Y",
                "list_order_mix": "Y",
                "dial_method": "POWER DIAL",
                "auto_dial_level": "2",
                "active": "Y"
            },
          ...
         ]
    }
}

📌 Response Fields

FieldDescription
idUnique identifier of the campaign.
campaign_nameName of the campaign.
dialerIndicates if the campaign is configured for auto-dial (Y) or not (N).
campaign_vdad_extenDefines if the campaign uses Answering Machine Detection (AMD).
list_order_mixIndicates if the leads are mixed during the dialing process.
dial_methodThe dialing method used: "POWER DIAL", "PREDICTIVE",  or "PREVIEW".
auto_dial_levelAuto-dial level (number of channels per agent).
activeSpecifies if the campaign is active (Y) or inactive (N).