Schedule Campaign Data API adds data to the dialer(Outbound campaign) at a scheduled time. Time can be scheduled by including the parameter “ScheduledTime” in the request. Data(numbers/leads) consists of mapping(Headers) sequence listing PhoneNumber, Name, ExpiryDate ScheduledTime, etc., while adding to the dialer.

📘
APIs Domain Name
For domestic ccaas - enter the domain: in1-ccaas-api.ozonetel.com
For international ccaas - enter the domain: api.ccaas.ozonetel.com
For Partners - enter the respective URL

❗️
Rate Limit
The API allows a maximum of 100 numbers per request.

👍
Note:

Data can be scheduled for any date within the next 30 days from today and will be added to the campaign on that day.

Set the checkDuplicate parameter to "true" if you want to filter out duplicates and only add unique entries to the data.

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 (Example format)

{"userName":"xxxx","campaignName":"xxxx","checkDuplicate":true,"bulkData":{"map":["PhoneNumber","Name","ExpiryDate","ScheduledTime"],"data":[["81xxxxxx8","Agent1","2025-07-11 15:35:00","2025-02-13 21:14:00"],["1234565432","Agent2","2025-07-11 15:35:00","2025-02-13 21:14:00"],["63xxxxxxx2","Agent3","2025-07-11 15:35:00","2025-02-13 21:14:00"]]}}

Possible responses

Success Response

{
    "message": [        
 {
            "Response": "success",
            "msg": "Data updated successfully",
            "campaign_name": "xxx",
            "ExpiryDate": null,
            "ScheduleTime": "2026-03-12 13:43:00",
            "skill": null,
            "index": 3,
            "PhoneNumber": "+91xxxx8",
            "AgentID": "xxx",
            "rowId": 169201
        }
    ],
    "status": "success"
}

Error Responses


Invalid api_key	"status": "error" "message": "api_key or campaign_name is invalid or not found"
Invalid Campaign name	"status: "error" "message": "api_key or campaign_name is invalid or not found"
Missing ScheduledTime	"status": "error" "message": "Mandatory parameter ScheduledTime is in bulkData map"
Missing bulkData	"status": "error" "message": { "0-0": "Success response", "0-1": ""status": "s}
Missing PhoneNumber	"status": "success", "message": { "0-0": "Success response", "0-1": ""status": "success",\n"message": [{"Response": "success",\n"ScheduleTime": "YYYY-MM-DD HH:MM:SS",\n"campaign_name": "Schedxxxx",\n"PhoneNumber": "040XXXXX",\n"Name": "NameXXX2",\n"AgentID": "AgentID2XXX",\n"skill": "Skill_2",\n"msg": "Data updated successfully",\n"index": "0"", "1-0": "Invalid api_key", "1-1": ""status": "error"\n"message": "api_key or campaign_name is invalid or not found"", "2-0": "Invalid Campaign name", "2-1": ""status: "error"\n"message": "api_key or campaign_name is invalid or not found"", "3-0": "Missing ScheduledTime", "3-1": ",
Invalid Date format	"status": "error" message": "Wrong Date format"
When the scheduled time is more than 30days from today	{ "message": "ScheduledTime exceeds 30 days limit at index xx","status": "error" }
Invalid Expiry date	{ "status": "Error","message": "Invalid date format. Please pass date in format yyyy-MM-dd HH:mm:ss or yyyy-MM-dd"}

200Successful response