Use this API to get the dial status data for an outbound campaign.
To access this API, pass all the following parameters. (* are mandatory)
Parameter | Description |
---|---|
fromDate | Provide the date in the format (YYYY-MM-DD HH:MM:SS) |
toDate | Provide the date in the format (YYYY-MM-DD HH:MM:SS) |
sortby | Pass this parameter as "0" (Zero) - If passed as zero the API fetches all the campaign data. |
status* |
|
dialstatus* |
|
dispositions* |
|
campaignName* | Provide the campaign name |
userName* | Your CloudAgent account username |
callBackUrl* | Give the callback URL |
Points to Remember
- Data can be fetched for a single campaign at a time.
- Allows 10 request per minute.
Possible Responses
Passing Invalid apiKey Key | "{""status"": ""error"", |
Passing Invalid apiKey Value | {"status": "error","message": "Authentication failed","uniqueId": ""} |
Missing apiKey key | "{""status"": ""error"", |
Missing apiKey Value | {"status": "error","message": "apiKey is invalid","uniqueId": ""} |
Passing Invalid userName Key | {"status": "error","message": "userName is invalid","uniqueId": ""} |
Passing Invalid userName Value | {"status": "error","message": "Authentication failed","uniqueId": ""} |
Missing userName key | {"status": "error","message": "userName is invalid","uniqueId": ""} |
Missing userName Value | {"status": "error","message": "userName is invalid","uniqueId": ""} |
Passing Invalid CampaignName Key | "{""status"": ""error"",""message"": ""campaignName is invalid"", |
Passing Invalid CampaignName Value | "{""status"": ""error"",""message"": ""campaignName is invalid"", |
Missing Campaign Name Key | "{""status"": ""error"",""message"": ""campaignName is invalid"", |
Missing Campaign Name Value | "{""status"": ""error"",""message"": ""campaignName is invalid"", |
Passing Invalid callBackUrl Key | "{""status"": ""error"",""message"": ""callBackUrl cannot be empty (OR) it should contain ‘http://test.com/’ or 'https://test.com/"", |
Passing Invalid callBackUrl Value | "{""status"": ""error"",""message"": ""callBackUrl cannot be empty (OR) it should contain ‘http://test.com/’ or 'https://test.com/"", |
Missing callBackUrl Key | "{""status"": ""error"",""message"": ""callBackUrl cannot be empty (OR) it should contain ‘http://test.com/’ or 'https://test.com/"", |
Missing callBackUrl Value | "{""status"": ""error"",""message"": ""callBackUrl cannot be empty (OR) it should contain ‘http://test.com/’ or 'https://test.com/"", |