This API is used to upload bulk data to outbound campaigns by sending the data in a file. Both .xlsx and .csv file formats are allowed to upload the data.
Prerequisite
To access this API we need to pass all the following parameters:
Parameters | Description |
---|---|
username* | CloudAgent account user name. |
apiKey* | The API key will be available in the CloudAgent admin login. |
file* | Both .xlsx and .csv formats are supported for uploading the data. |
campaignName* | The data uploaded for this campaign. |
callBackUrl* | This parameter is to receive a response following the uploading process. ** Post request, the response will be attached in the body. |
action | start - Pass the action value as 'start' when the campaign is not running. Once the API is triggered, the file upload process will commence, and upon completion, the campaign will automatically start. stop - This action parameter stops the campaign irrespective of the file upload process. Passing no value - The file upload process will start if the campaign is in a stopped state. |
Header Parameter -accept | application/json |
Note
Parameters with ‘*’ are considered to be mandatory parameters
Responses in JSON
Success authentication and campaign check | "status": "success" |
Request bucket full | "status": "error" |
Authentication Failed | "status": "error" |
File not found | "status": "error" |
File is not excel | "status": "error" |
Campaign not found | "status": "error" |
Campaign is in running state | "status": "error" |
Callback responses
Data upload success | "status": "success" |
Data upload failed | "status": "error" |
File validation error
PhoneNumber column does not exist | "status": "error" |
Campaing type is Agent wise and Agent | "status": "error" |
Campaign type is Skill wise and Skill | "status": "error" |
Empty file | "status": "error" |
PhoneNumber Not Valid | "status": "error" |
Campaign type is Agentwise and found | "status": "error" |
Campaign type is Skill-wise and found invalid SkillName | "status": "error" |
Columns more than 40 | "status": "error" |
Name column exceeds 100 character | "status": "error" |
Data limit exceeded | "status": "error" |
**All file validation related responses will be sent while uploading the file.
Note:
DataLimit:
- 50000 records are allowed to upload with a single request.
RateLimit:
- Per user 1 request in a minute.
Campaign side data upload conditions:
- The campaign should not be in a running state.
- At a time single upload request is processed for any campaign. No concurrent request against the campaign is allowed.
Further Insights
By default, the domain name is https://in1-ccaas-api.ozonetel.com. Please refer here to change based on the need.