post
https://{domainname}/APIServices/campaignControl/outbound
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Use this API to delete an outbound campaign within your CloudAgent account.
In the BODY PARAMS provide the following required parameters.
For domestic ccaas - enter the domain: api.cloudagent.ozonetel.com
For International ccaas - enter the domain: ccaas.ozonetel.com
Rate Limit
2 request per minute per user.
| Parameter (newKey) | Description (New value) |
|---|---|
| username* | Provide the CloudAgnet account name |
| campaignName* | Name of the campaign to be deleted |
| apiKey* | Provide the API key of your account. Available in CloudAgent after admin login |
| action* | To delete a campaign - "delete" |
| campaignType* | "Preview" / "Progressive" / "IVR" / "Predictive" |
Possible Responses
| Deleting the campaign while the campaign is in Running state | "{ ""Message"": ""Please change the campaign status to Ready or Completed to delete the campaign."" }" |
| Deleting the campaign while the campaign is in Ready state | "{ ""Message"": ""Campaign XXXXXX deleted Successfully."" }" |
| Deleting the campaign while the campaign is in Completed state | "{ ""Message"": ""Campaign XXXXX deleted Successfully."" }" |
| If the campaign is not available. | "{ ""Message"": ""Campaign not found."" }" |