This API is used to set the status of the campaign to start or stop. The action parameter MUST be "Start" to start the campaign or "Stop" to stop the campaign.

👍
Note:
Make sure the admin setting 'API Authentication' is set to 'BASIC_AUTH', If you are using this API.

📘
APIs Domain Name
For domestic ccaas - enter the domain: in1-ccaas-api.ozonetel.com
For international ccaas - enter the domain: api.ccaas.ozonetel.com
For Partners - enter the respective URL

Header parameters

Parameter	Description
apiKey*	Your CloudAgent account API Key
Content-Type	application/json

Body Params

{
"userName": "xxxxx",
"campaignName": "xxxxx",
"action": "Stop",
"process": true
}

Parameter	Description
userName*	Your CloudAgent account username
campaignName*	Name of the campaign, as configured in the CloudAgent account.
action*	"Start" to start the campaign. "Stop" to stop the campaign.
process*	Should be - true

Possible Responses


Success response (campaign started)	"status": "SUCCESS" "message": "SUCCESSFULLY UPDATED, Progressive was started"}
Success response (campaign stopped)	"status": "SUCCESS" "message": "SUCCESSFULLY UPDATED, Progressive was stopped"
Error	"status": "failure" "message": "All parameters are mandatory"

200Successful response