Deprecation Update
This Add Campaign Bulk Data API will be deprecated by 31st Dec 2024.
We recommend to start using the new version of the Add Bulk Campaign Data API (refer here).
The Add Campaign Bulk Data API facilitates the bulk addition of data to any outbound campaign. The data, which includes numbers/leads, is structured with a map file containing headers followed by a sequential listing of data corresponding to the map file. For example, it may include fields such as phone number, Name, Priority, and skill.
The data must be entered manually following the example format below.
{"map":["PhoneNumber","Name","Priority","AgentId","skill"],"data":[["81XXXXXXX8","Ironman",6,"Bobby","Skillname"],["86XXXXXXXX0","KommuramBheem",7,"Bobby","GeneralSkill"],["81XXXXXX8","CaptainAmerica",8,"Bobby","Skillname"]]}
To access this API the following parameters MUST be passed.
| Parameter | Description |
|---|---|
| api_key* | CloudAgent admin login |
| campaign_name* | CloudAgent account name |
| bulkData* | Data to be inserted |
Note
- The maximum count of data to be added is 200 per request.
- The timestamp between two requests for passing data is 30 seconds.
- Ensure that the added data aligns with the map file configured for the campaign.
- Parameters with ‘*’ are mandatory parameters.
Possible responses
| Success response | { "message": [ { "PhoneNumber": "81XXXXXX8", "Status": "SuccessFully Updated" }, { "PhoneNumber": "86XXXXXXX0", "Status": "SuccessFully Updated" }, { "PhoneNumber": "81XXXXXX8", "Status": "SuccessFully Updated" } ] } |
| apikey missing / empty / invalid | {"status": "failure", "message": "no user found"} |
| campiagn name missing / empty | {"status": "error", "message": "please provide campaign details"} |
| campiagn name invalid | {"status": "failure", "message": "no user found"} |
| Trying back-to-back requests | {"status": "error", "message": "Already one process is running please try after some time"} |
| 'Added data' - missing / empty / invalid format / map word missing / word data missing | {"status": "failure", "message": "Please provide valid data"} |
| PhoneNumber value missing in bulk data | {"message": [{ "PhoneNumber": null, "Name": "Legend", "Skill": "PROGRESSIVE_SKILL", "Status": "phone number should be numeric and must be between 3 to 16 digits and allows prefix +"} |
| if data is not as per map fields | {"message": [{ "PhoneNumber":"" , "Name": "Legend", "Skill": "PROGRESSIVE_SKILL", "Status": "phone number should be numeric and must be between 3 to 16 digits and allows prefix +"} |
| Adding data to an inbound campaign | {"status": "failure", "message": "no user found"} |
| if campaign-mapped file and API-mapped file are not matching | "PhoneNumber": "914030247113", "Name": null, "Status": "SuccessFully Updated" |
Further Insights
By default, the domain name is https://in1-ccaas-api.ozonetel.com. Please refer here to change based on the need.