get https://{domainname}/ca_apis/getScheduledData
Schedule Data Status API is used to verify the status of the data scheduled to be added to the dialer(outbound campaign).
To use this API with the help of a token, follow these steps:
- Generate the Token: Use the 'Generate Token' API to obtain an authentication token.
- Enter the Token ID: Navigate to the right section of this page, under the 'AUTHORIZATION' tab. Here, input the generated token ID.
- With the token entered, pass the below header and body parameters:
Header parameters
| Parameter | Description |
|---|---|
| Content-Type | application/json |
Body Params
{
"userName":"Test"
}
Possible responses
| Success response | "status": "success", "message": { "Id": "XX", "api_key": "KKXXXXXXXXXXXX", "CreatedDate": "YYYY-MM-DD HH:MM:SS", "ScheduleTime": "YYYY-MM-DD HH:MM:SS", "ScheduleParams": "api_key=KKXXXXXXXXXXXX&campaign_name=XXXXXX&action=START&format=json&PhoneNumber=04XXXXXXXXX&Name=SXXXXXX&ScheduledTime=YYYY-MM-DD+HH%3AMM%3ASS&skill=XX XXXXX&AgentID=XXXXXX&Priority=2", "RequestTime": "YYYY-MM-DD HH:MM:SS", "IsRequestSent": "1", "Response": "{"status": "SUCCESS" "message": "SuccessFully Updated, Progressive was started"}"}, |
| Invalid api_key | "status": "success" "message": "null" |