goGetCampaignInfo

Description

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

URL - Method POST

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

Required Parameters

Parameter	Value	Description
goAction	getUserInfo	Action to perform
goUser	MyUser	API authorized user.
goPass	MyPass	Authorized user's password.
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.

Example Request (curl)

curl -X POST https://domain.croco-dial.net/goAPIv2/goCampaigns/goAPI.php \
  -d "goAction=getUserInfo" \
  -d "goUser=MyUser" \
  -d "goPass=MyPass" \
  -d "campaign_id=MyCampaignID" \
  -d "responsetype=json"

  Example Response (200 OK)

{
  "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": 99759656,
    "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).