get https://{domainname}/ca_apis/campaignStatus
This API is used to know the status of the campaign, in other words, it can be used to retrieve the position of the campaign, whether the campaign is running or not or in a ready position or not.
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",
"campaignName":"name"
}
Possible responses
| Success response | "status": "success", "message": [ { "CampaignID": "256", "CampaignName": "Preview_naw", "UserName": "qa_testing", "Position": "READY" }, { "CampaignID": "260", "CampaignName": "test_chat1", "UserName": "qa_testing", "Position": "READY" }, { "CampaignID": "261", "CampaignName": "ivr_test", "UserName": "qa_testing", "Position": "READY" }, { "CampaignID": "263", "CampaignName": "hari_prog_none", "UserName": "qa_testing", "Position": "COMPLETED" } |
| Error | "status": "failure" "message": "All parameters are mandatory" |
| Invalid user_name | "status": "failure", "message": "no record found" |