get https://{domainname}/ca_apis/getAvailableCampaigns
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 | "status": "success", "message": [ {"CampaignID": "XXXXX", "Campaign": "campaignname", "XXXXXX", "UserName": "username", "XXXXXX", "Position": "state", "DID": "9140XXXXX", "CampaignType": "campaignType" |
| Invalid apikey/username | "campaign": {}, "code": "401", "message": "User Does not Exists.", "status": "Error" |