Campaigns

• Get Specific Campaign Details
• Fetch All Campaigns Information
• Get Current Leads on Hopper by Campaign

Get Specific Campaign Details

API: getCampaignInfo

Description

Retrieves detailed information about a specific campaign, including its settings, dial statuses, configurations, and associated transfer groups.

🔗 URL

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

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

📝 Required Parameters

Parameter	Value	Description
goAction	getCampaignInfo	Action to retrieve campaign details and settings.
goUser	MyUser	API authorized user.
goPass	MyPass	Password for the API authorized user.
campaign_id	MyCampaignID	The ID of the campaign you want to retrieve information for.
responsetype	json/xml	Format 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=getCampaignInfo&goUser=MyUser&goPass=MyPass&campaign_id=MyCampaignID&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=getCampaignInfo" \
  --data-urlencode "goUser=MyUser" \
  --data-urlencode "goPass=Mypass" \
  --data-urlencode "responsetype=json" \
  --data-urlencode "campaign_id=11111111"

  Example Response

{
  "result": "success",
  "data": {
    "campaign_id": "1234567",
    "campaign_name": "CUTSERVICE",
    "active": "Y",
    "dial_status_a": null,
    "dial_status_b": "",
    "lead_order": "DOWN_LAST_CALL_TIME",
    "hopper_level": 1000,
    "auto_dial_level": "3",
    "next_agent_call": "longest_wait_time",
    "local_call_time": "24hrs",
    "dial_timeout": 30,
    "dial_prefix": "903",
    "campaign_cid": "123456789",
    "campaign_script": "SCRIPT001",
    "campaign_recording": "ALLFORCE",
    "closer_campaigns": "AGENTDIRECT, CUTSERVICE",
    "drop_call_seconds": 1,
    "drop_action": "IN_GROUP",
    "wrapup_seconds": 0,
    "manual_dial_list_id": 999999999,
    "queue_priority": 50,
    "default_xfer_group": "AGENTDIRECT",
    "survey_method": "AGENT_XFER",
    "survey_dtmf_digits": "1238",
    "survey_xfer_exten": "8300",
    "use_internal_dnc": "Y",
    "manual_dial_timeout": "30",
    "three_way_call_cid": "CAMPAIGN",
    "three_way_dial_prefix": "903",
    "callback_days_limit": 0,
    "campaign_description": null,
    "campaign_calldate": "2025-05-07 11:51:49"
  },
  "campaign_type": "OUTBOUND",
  "custom_fields_launch": "ONCALL"
}

Response Structure

Field	Type	Description
data	object	Contains all the campaign details.
└── campaign_id	string	Unique ID of the campaign.
└── campaign_name	string	The name of the campaign.
└── active	string	Whether the campaign is active (Y) or not (N).
└── dial_status_a to dial_status_e	string	The dial statuses associated with the campaign.
└── lead_order	string	Specifies the order of leads in the hopper.
└── hopper_level	number	Number of leads loaded into the hopper.
└── auto_dial_level	string	The auto-dial level for the campaign.
└── next_agent_call	string	Specifies the method for the next agent call assignment.
└── local_call_time	string	Time restrictions for dialing.
└── dial_timeout	number	Time in seconds before the call times out.
└── dial_prefix	string	The prefix added to dialed numbers.
└── campaign_cid	string	Caller ID for the campaign.
└── campaign_script	string	The script associated with the campaign.
└── campaign_recording	string	Indicates the call recording policy.
└── closer_campaigns	string	List of related closer campaigns.
└── drop_call_seconds	number	Seconds before considering the call as "dropped".
└── drop_action	string	Action to take when a call is dropped.
└── wrapup_seconds	number	Time for agents to wrap up after a call.
└── wrapup_message	string	Message displayed during the wrap-up.
└── manual_dial_list_id	number	List ID for manual dialing.
└── queue_priority	number	Priority of this campaign in the call queue.
└── default_xfer_group	string	Default transfer group for calls.
└── survey_method	string	Method for handling survey calls (e.g., AGENT_XFER).
└── survey_dtmf_digits	string	DTMF digits used for survey responses.
└── survey_xfer_exten	string	Extension for survey transfers.
└── use_internal_dnc	string	Whether the campaign uses the internal Do Not Call list (Y/N).
└── manual_dial_timeout	string	Timeout for manual dial attempts.
└── three_way_call_cid	string	Caller ID for three-way calls.
└── three_way_dial_prefix	string	Dial prefix for three-way calls.
└── callback_days_limit	number	Maximum days allowed for scheduled callbacks.
└── campaign_description	string	Optional description of the campaign.
└── campaign_calldate	string	The last call date for this campaign.
campaign_type	string	Specifies if the campaign is INBOUND, OUTBOUND, or BLENDED.
custom_fields_launch	string	Indicates if custom fields are launched during the call (ONCALL).

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

Parameter	Value	Description
goAction	goGetAllCampaigns	Action to retrieve all campaigns.
goUser	MyUser	API authorized user.
goPass	MyPass	Password for the API authorized user.
responsetype	json/xml	Format 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

Field	Description
id	Unique identifier of the campaign.
campaign_name	Name of the campaign.
dialer	Indicates if the campaign is configured for auto-dial (Y) or not (N).
campaign_vdad_exten	Defines if the campaign uses Answering Machine Detection (AMD).
list_order_mix	Indicates if the leads are mixed during the dialing process.
dial_method	The dialing method used: "POWER DIAL", "PREDICTIVE",  or "PREVIEW".
auto_dial_level	Auto-dial level (number of channels per agent).
active	Specifies if the campaign is active (Y) or inactive (N).

Get Current Leads on Hopper by Campaign

API: getLeadsOnHopper

Description

This endpoint retrieves all leads currently in the hopper for a specific campaign. The hopper is a queue of leads that are ready to be dialed. The response includes detailed lead information such as loan ID, phone number, call disposition, source, list name, and an HTML button to delete the lead.

🔗 URL

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

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

📝 Required Parameters

Parameter	Value	Description
goAction	getLeadsOnHopper	Action to get the leads for a specific campaign.
goUser	MyUser	API authorized user.
goPass	MyPass	Password for the API authorized user.
campaign_id	ID-Campaign (number)	Campaign identifier to search hopper.
responsetype	json/xml	Format 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=getLeadsOnHopper&goUser=MyUser&goPass=MyPass&responsetype=json&campaign_id=123456"

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=getLeadsOnHopper" \
  --data-urlencode "goUser=MyUser" \
  --data-urlencode "goPass=Mypass" \
  --data-urlencode "campaign_id=123456" \
  --data-urlencode "responsetype=json"

  Example Response

{
  "result": "success",
  "data": {
    "rows": [
      {
        "lead_id": "10001",
        "last_local_call_time": "2025-06-01 14:23:45",
        "loan_id": "LN123456",
        "phone_number": "5551234567",
        "state": "CA",
        "disposition": "NEW",
        "count": 0,
        "gmt_offset_now": "-8.00",
        "hopper_id": "5001",
        "alt_dial": "MAIN",
        "list_name": "Default Leads List",
        "list_id": "901",
        "priority": 99,
        "source": "WEBFORM",
        "numrows": 2,
        "delete": "<button class=\"btn btn-delete\"><i class=\"fa fa-trash\" aria-hidden=\"true\"></i></button>"
      },
      {
        "lead_id": "10002",
        "last_local_call_time": "2025-06-01 13:12:09",
        "loan_id": "LN654321",
        "phone_number": "5559876543",
        "state": "TX",
        "disposition": "CALLBK",
        "count": 1,
        "gmt_offset_now": "-6.00",
        "hopper_id": "5002",
        "alt_dial": "ALT",
        "list_name": "Follow-up List",
        "list_id": "902",
        "priority": 90,
        "source": "IMPORT",
        "numrows": 2,
        "delete": "<button class=\"btn btn-delete\"><i class=\"fa fa-trash\" aria-hidden=\"true\"></i></button>"
      }
    ],
    "headers": [
      { "title": "Loan ID", "field": "loan_id" },
      { "title": "Phone Number", "field": "phone_number" },
      { "title": "Disposition", "field": "disposition" },
      { "title": "Count", "field": "count" },
      { "title": "Source", "field": "source" },
      { "title": "List Name", "field": "list_name" },
      { "title": "Lead ID", "field": "lead_id" },
      { "title": "Delete", "field": "delete", "formatter": "html" }
    ],
    "html": "<div class=\"toggleTitlesAction tabulator-Y3Yc\" style=\"width: 90%\">...</div>",
    "content": "table"
  }
}

📌 Response Fields

Field Name	Description
lead_id	Unique identifier of the lead
last_local_call_time	Timestamp of the last local call to the lead (if any)
loan_id	Vendor lead code (often a unique external ID like a loan or case ID)
phone_number	Lead's phone number
state	US State (if available) from lead data
disposition	Status or outcome of the last interaction (e.g., NEW, CALLBK, SALE)
count	Number of times this lead has been called
gmt_offset_now	GMT offset of the lead's time zone
hopper_id	Internal hopper ID (queue ID)
alt_dial	Alternative dialing method or flag
list_name	Name of the list this lead belongs to
list_id	ID of the list
priority	Lead priority in the hopper
source	Source of the lead (e.g., WEB, IMPORT)
numrows	Total number of rows returned (same for all rows, used for frontend)
delete	HTML snippet for a delete button (used in frontend UI)