Skip to main content
POST
Stop outbound VoiceAgent calls

Authorizations

Authorization
string
header
required

HTTP Basic Authentication. Use your API Access Key ID as the username and your API Access Key Secret as the password. Generate keys in the CloudTalk Dashboard under Account -> Settings -> API Keys (https://dashboard.cloudtalk.io/menu/account/settings/API-keys).

Body

application/json
duration_seconds
integer
required

How long to stop outbound dialing, in seconds. 0 cancels a stop that is currently active for the same scope. Maximum 86400 (24 hours).

Required range: 0 <= x <= 86400
Example:

600

voice_agent_id
string

Restrict the stop to a single VoiceAgent. Omit to stop all of the company's outbound calls. Must be a VoiceAgent belonging to your company.

Example:

"681b0639876543cfbc3d6b55"

reason
string

Optional free text recorded in the audit log.

Maximum string length: 256
Example:

"runaway campaign"

Response

Outbound dialing stopped, or resumed when duration_seconds was 0.

killed_until_unix
integer<int64>

Unix timestamp (seconds) at which the stop expires and dialing resumes on its own. This is a point in time, not a duration. 0 after a cancel.

Example:

1786966737

drained_count
integer

Number of queued outbound calls this request cancelled.

Example:

3

cancelled
boolean

True when the request lifted an existing stop instead of setting one.

Example:

false