post https://{domainname}/cloudAgentRestAPI/index.php/CloudAgent/CloudAgentAPI/addCamapaignData
Deprecated
This Add Campaign Data API will be deprecated by 30th September 2024.
We recommend to start using the new Add campaign Data APIs
Add campaign data API is used to add data to any outbound campaign(dialer). Create an outbound campaign in your CloudAgent account, and use this API to add data/records for the same. One can also manually add data to the dialer by uploading an excel sheet. However by using this API, the same can be automated. This API may be used to trigger as and when you get leads into your CRM application.
To access this API the following parameters MUST be passed.
| Parameter | Description |
|---|---|
| api_key* | Available in CloudAgent after admin login |
| campaign_name* | Name of the campaign where the data to be added |
| agentId | Unique id for every agent irrespective to campaign |
| skill | Unique skill assigned to agents to which the call is routed. |
| PhoneNumber* | Phone number of the lead |
| Name | Optional name to the phone number or lead being added. |
| checkDuplicate | Checks for any duplicate numbers in the campaign. If TRUE, avoids adding duplicate numbers to the campaign. |
| action | If START, starts the campaign simultaneous to adding data. |
| Priority | The higher the priority value(1-99) assigned to the phoneNumber, the faster the number gets dialed. |
| ExpiryDate | It Is the last date set to the number to be valid in the dialer. Format is YYYY-MM-DD |
Note
- Parameters with ‘*’ are mandatory parameters.
- Along with "PhoneNumber", other headers/parameters can also be added to the dialer as per the mapping file given in the desired outbound campaign. Ex: Name, Email, City, Service, OrderNumber, etc.
- By default, this API allows 100 requests per minute.
Possible responses
| Invalid api_key | "status": "FAIL" "message": "No User Found" |
| checkDuplicate | "status": "SUCCESS" "message": "Number Already Exist" |
| Missing PhoneNumber | "status": "FAIL" "message": "Phone Number is Empty!" |
| action | "status": "SUCCESS" "message": "Successfully Updated, Progressive was started" |
| Adding DND phone numbers | "status": "FAIL" "message": "PhoneNumber Added is a DND Number" |
Further Insights
By default, the domain name is https://in1-ccaas-api.ozonetel.com. Please refer here to change based on the need.