The Add Campaign Bulk Data (V4) API facilitates the bulk addition of data to Outbound Campaigns (Dialers). This data comprising numbers/leads is structured with mapped headers, including PhoneNumber, Name, Priority, Skill, etc, for integration into the dialer.
When you call this API multiple times, the data is stored in a queue and subsequently added to the outbound campaign in a queued manner.
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"]]}
Note
- The maximum count of data to be added is 500 per request.
- Maximum of 5 Requests allowed per minute.
- Parameters with ‘*’ are mandatory parameters.
To access this API the following parameters MUST be passed.
| Parameter | Description |
|---|---|
| apiKey* | Your CloudAgent account API key. Available in your account admin login. |
| campaignName* | Name of the campaign to which the data is to be added. |
| bulkData* | Data to be inserted |
| userName* | Your CloudAgent account username |
| action | start - Setting the action parameter to "start" initiates the campaign as soon as the data upload process is completed. This is not a mandatory parameter. |
| checkDuplicate | "true" - If passed true, API checks for the duplicate phone numbers and adds only the unique numbers "false" - API doesn't check for duplicate numbers if passed false. |
| callBackUrl | Add the call-back URL if needed. It should be publically accessible. |
Possible Responses
| Success response | API Response: "{""transactionId"": ""129171716445505819319510"", ""status"": ""success"", ""message"": ""queued successfully""} Callback response: { "data": { "totalNoUploaded": "xxxx", "numbersProcessed": "xxxx", "numbersNotProcessed": "xx", "failedFilePath": " xxxx " , "transactionId": "1292017169670681719733108", "status": "Success", "message": "File Successfully uploaded.", "startDateTime": "2024-05-29 12:47:56", "endDateTime": "2024-05-29 12:48:19" } } Note: See here for the sample data response. |
| Passing Invalid apiKey Value | {"status": "error","message": "Invalid userName or apiKey"} |
| Missing apiKey Value / Passing Invalid apiKey Key / Missing apiKey key | {"status": "error","message": "apiKey should not be empty"} |
| Passing Invalid userName Value | {"status": "error","message": "Invalid userName or apiKey"} |
| Missing userName Value / Passing Invalid userName Key / Missing userName key | {"status": "error","message": "userName should not be empty"} |
| Passing Invalid CampaignName Key | {"status": "error","message": "campaignName should not be empty"} |
| Passing Invalid CampaignName Value | {"status": "error","message": "Invalid Campaign Name"} |
| Missing Campaign Name Key / Missing Campaign Name Value | {"status": "error","message": "campaignName should not be empty"} |
| Passing Invalid bulkData Key | "{ ""status"": ""failure"", ""message"": ""Please provide valid data"" }" |
| Passing Invalid bulkData Value | "{ ""status"": ""failure"", ""message"": ""Please provide valid data"" }" |
| Missing bulkData Key | "{ ""status"": ""failure"", ""message"": ""Please provide valid data"" }" |
| Missing bulkData Value | "{ ""status"": ""failure"", ""message"": ""Please provide valid data"" }" |
| word PhoneNumber missing in bulk data map field value | "API Response : {""transactionId"": ""1292017169670681719733108"", ""status"": ""success"",""message"": ""queued successfully""} CallBack response : { "data": { "totalNoUploaded": "xxxx", "numbersProcessed": "xxxx", "numbersNotProcessed": "xx", "failedFilePath": " xxxx " , "transactionId": "1292017169670681719733108", "status": "Fail", "message": "File Failed to Upload.", "startDateTime": "2024-05-29 12:47:56", "endDateTime": "2024-05-29 12:48:19" } } |
| If data is not as per map fields | "API Response : {""transactionId"": ""129861716888265726411532"", ""status"": ""success"",""message"": ""queued successfully""} CallBack response : { "data": { "totalNoUploaded": "xxxx", "numbersProcessed": "xxxx", "numbersNotProcessed": "xx", "failedFilePath": " xxxx ", "transactionId": "129861716888265726411532", "status": "Fail", "message": "File Failed to Upload.", "startDateTime": "2024-05-29 12:47:56", "endDateTime": "2024-05-29 12:48:19" } } |
| Adding data to inbound campaign | {"status": "error","message": "Invalid Campaign Name"} |
| If the campaign-mapped file and API-mapped file not matching | "API Response : {""transactionId"": ""129861716888265726411532"", ""status"": ""success"",""message"": ""queued successfully""} CallBack response : { "data": { "totalNoUploaded": "xxxx", "numbersProcessed": "xxxx", "numbersNotProcessed": "xx", "failedFilePath": " xxxx " , "transactionId": "129861716888265726411532", "status": "Fail", "message": "File Failed to Upload.", "startDateTime": "2024-05-29 12:47:56", "endDateTime": "2024-05-29 12:48:19" } } |
| More than 5 hits per minute. | {"status": "error","message": "too many Requests and failed to add Data to queue"} |
| Callback Url response for successful case of leads upload. | { "data": { "totalNoUploaded": "xxxx", "numbersProcessed": "xxxx", "numbersNotProcessed": "xx", "failedFilePath": " xxxx " , "transactionId": "1292017169670681719733108", "status": "Success", "message": "File Successfully uploaded.", "startDateTime": "2024-05-29 12:47:56", "endDateTime": "2024-05-29 12:48:19" } } |
| Callback Url response for a failed case of leads upload. | CallBack response : { "data": { "totalNoUploaded": "xxxx", "numbersProcessed": "xxxx", "numbersNotProcessed": "xx", "failedFilePath": " xxxx " , "transactionId": "1292017169670681719733108", "status": "Fail", "message": "File Failed to Upload.", "startDateTime": "2024-05-29 12:47:56", "endDateTime": "2024-05-29 12:48:19" } } |
Sample response with failed file path:
Please note that the failed file path is a pre-signed URL, valid for 24 hours.
{"data":"{"totalNoUploaded":"6","numbersProcessed":"2","numbersNotProcessed":"4","failedFilePath":"https://etl-dataprocessing.s3.ap-south-1.amazonaws.com/172067852912917131638630_error.csv?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIA5D7NL2UC6QCNZQO6%2F20240711%2Fap-south-1%2Fs3%2Faws4_request&X-Amz-Date=20240711T061551Z&X-Amz-Expires=86400&X-Amz-SignedHeaders=host&X-Amz-Security-Token=IQoJb3JpZ2luX2VjEI3%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaCmFwLXNvdXRoLTEiSDBGAiEAvIU05scvsOlZASqNNnL1R1yhAIhZKwFKFZaySjh%2B9j4CIQDPeB5XSyr0vnJt4dYGfNqyD45mAUP%2FoxjF7ZQWU1UwMyrABQhXEAAaDDkwMTkwNDA2MTcwMSIMHyMJW2sFBz4dEZ56Kp0FvoIeQLtbzPqvYcd2yvukoYF5aJIYDM5d0Kdr17Sib3VIbr%2BKH87cWLps%2FgasNtk6FV3stCoCjaF3RUu6AIQtlYLxKCSkh%2FpUMOu1NmSSa4gYojkbpkA5jN4%2BP1JphR5OkABd%2F1G2ZVlRxKgTmMUVLZhDoAGQqhlLPHGmPM0sNe5etHiElf92bM1xYKpGkDcbrGipV1qdvT8F%2BvV3etmHe7NJ8sooAp%2Fxv72kcemgXZrOfSdKEjgbFvrd8S4xGqF49DQLIVOnBfKmtr6GfN%2FY2%2FimzCA5S1Ayta%2BXood2iVwduFqRheHb1zlEm8XBKR4TIUdnB54%2F9NHcQI3%2FtOEdEH2LtShUr5nwXc1HRW9qb3b3DMn6kgvwjvwJCGKWnud0QwdOBQNKi4aveibzGL89oJGwLaa%2FplMMTDqMHF0MHnPUO%2FIc8hHy3tmSzt1LGD8M6lVUeSj9OKI1MgIDFdFrS3HCoK7nyoY8a8mCEO2037Le6jP20Sbwtkjsac8l6ivr4GmREYDVs0ig%2BomHCYgtoLHUN2AQRs7MpOi1rEF4mh8TIYD5qbwP15CovxPaxQeR4QjpmHBRyMXUVtBbH2hhLlE5ohrLMBHs6MboDTJ9ynRxrvQ%2FHcSEmF%2Bf8aitRbM%2BjQZ8%2FbHk11qgLs62LJNcferpUZjarsvdFG435ZQutWeRuyIAxb37Y67Yv2fEfLE5E5bSLW7DfXPkNzo7YTZPDsmT4LHDAES3FQbJsVzZsjGXzOo%2F97tzn6V5Z5x2lowzdIYIEwRa4YQUGStjIyPpY%2BkNFi93Z4NiHtPz%2ByHF0le54Jy06F7LY%2BFm5Bc0ZzRqSb1GQlqo5ndy3o1qqpT2bMW2ngK%2BRWR2p9TBnKN7Msk7Vw%2FmVGjEJyo4hXZqMKTZvbQGOrAB1yoQCAlEPtwrPDXHVb6ZzEE0sWYXmyTjzvUMnmFZmBAcdL03wSA0hladm0jbDD2CE%2Fd%2FncNlq3BPir6QTBQiIJiuuY1MjdQrzAyN9lsRmdpeMxLiM2N5n1swVBBrCZZPPoOHF0oUstzjPt5TwIj3jdNO%2BzcbaYzR%2Blmohyfin74YmVZSxQBSR0gfS2dISXXO7Prb%2BIayHDu5cpZytMUNMM5C6M%2F4u7h8O9coWr0%2B63U%3D&X-Amz-Signature=dad6909867eb45be476dde2c751776975659fdb2841d89d9b3dcf018b28baf34", "transactionId":"172067852912917131638630","status":"Success","message":"File Successfully uploaded.","startDateTime":"2024-07-11 11:45:29","endDateTime":"2024-07-11 11:45:54"}"}