Stop outbound VoiceAgent calls
Emergency stop for outbound VoiceAgent dialing.
Queued calls are cancelled and calls already in progress are ended within a few seconds, through the normal call-end path — billing, call records and analytics stay correct. Inbound calls are unaffected, as is the outbound traffic of every other company.
The stop expires on its own after duration_seconds, so a forgotten stop cannot silence an account indefinitely. Sending the request again overwrites the window; sending duration_seconds: 0 lifts it early.
By default the stop covers all of the company’s outbound calls. Supply voice_agent_id to stop a single VoiceAgent while the others keep dialing.
Queued calls cancelled by a stop are not dialed later when the window expires — they are marked declined and removed.
This endpoint is rate limited to 10 requests per minute per company, below the API-wide default of 60 — a single request already stops the whole company.
Authorizations
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
How long to stop outbound dialing, in seconds. 0 cancels a stop that is currently active for the same scope. Maximum 86400 (24 hours).
0 <= x <= 86400600
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.
"681b0639876543cfbc3d6b55"
Optional free text recorded in the audit log.
256"runaway campaign"
Response
Outbound dialing stopped, or resumed when duration_seconds was 0.
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.
1786966737
Number of queued outbound calls this request cancelled.
3
True when the request lifted an existing stop instead of setting one.
false
Related topics
Initiate VoiceAgent callCloudTalk REST API v1.7 — Complete Developer ReferenceCloudTalk REST API: Call Center Automation Platform