get https://{domainname}/CAServices/Campaign/DeleteCampaignData.php
Deprecation Update
This API will be deprecated by 30th Nov 2024.
We recommend to start using the new version of the Delete Campaing Bulk Data APIs.
This API is used to delete campaign bulk data based on status, PhoneNumber, skill, and agentid.
To access this API we need to pass the following parameters.
| Parameter | Description |
|---|---|
| apiKey* | Available in CloudAgent admin login |
| userName* | CloudAgent account name |
| campaignName* | CloudAgent Campaign Name |
| status | status can be only Success/Fail/Pending |
| agentId | Can delete particular agent data for AgentWise-type campaigns |
| skill | Can delete particular skill data for SkillWise type campaigns |
| phoneNumber | Can delete a particular phone number |
Note
- Parameters with ‘*’ are considered to be mandatory parameters.
- Rate Limit: 100 request per minute.
Possible responses
| Success response for Campaign | "status": "success" "message": "4 Records Deleted Successfully" |
| If userName is Empty | "status": "error" "message": "userName should not be empty" |
| If apiKey is Empty | "status": "error" "message": "apiKey should not be empty" |
| If Invalid status is passed | "status": "error "message": "status should be only Success/Fail/Pending" |
| If invalid apiKey or userName is passed | "status": "error" "message": "userName or apiKey is Invalid" |
| If invalid campaignName is passed | "status": "error" "message": "campaignName is Invalid" |
| If invalid agentId is passed for AgentWise Campaigns | "status": "error" "message": "please pass valid AgentId" |
| If invalid skill is passed for skill wise campaigns | "status": "error" "message": "please pass valid skill" |
Further Insights
By default, the domain name is https://in1-ccaas-api.ozonetel.com. Please refer here to change based on the need.