This API is used to retrieve all the campaign information. The information that can be retrieved is the CampaignId, Campaign name, Username, Position (whether in a ready state or not), DID, and Campaign type (Inbound, Preview, Chat, IVR, Progressive, and Predictive).
Note:
Make sure the admin setting 'API Authentication' is set to 'BASIC_AUTH', If you are using this API.
Header parameters
| Parameter | Description |
|---|---|
| apiKey* | Your CloudAgent account API Key |
| Content-Type | application/json |
Body Params
{
"userName":"Test" }
Possible responses
Success response | { "message": [ { "Position": "READY", "CampaignID": 2, "DID": "91xxxxx9", "FallBackDID": null, "FallbackDynamicDID": null, "Campaign": "Progressive_91xxx9", "DynamicDID": null, "UserName": "xxx", "CampaignType": "Progressive" }, { "Position": "RUNNING", "CampaignID": 3, "DID": "91xxxxx9", "FallBackDID": null, "FallbackDynamicDID": null, "Campaign": "In_Tosca", "DynamicDID": null, "UserName": "xxx", "CampaignType": "InBound" } ], "status": "success" } |
Invalid apikey/username | { "status": "false", "message": "Invalid User Details", "data": null } |