curl --request PATCH "https://prod-api.ringg.ai/ca/api/v0/campaign/terminate" \
--header "X-API-KEY: $RINGG_API_KEY" \
--header "Content-Type: application/json" \
--data '{ "mobile_numbers": ["+919876543210", "+919876543211"] }'
{ "message": "Calls terminated successfully!" }
Terminate Calls by Numbers
Stop all queued and retry calls to up to 100 phone numbers across every campaign in the workspace, for example to honour an opt-out from all your calls.
PATCH
/
campaign
/
terminate
curl --request PATCH "https://prod-api.ringg.ai/ca/api/v0/campaign/terminate" \
--header "X-API-KEY: $RINGG_API_KEY" \
--header "Content-Type: application/json" \
--data '{ "mobile_numbers": ["+919876543210", "+919876543211"] }'
{ "message": "Calls terminated successfully!" }
string
required
Your Ringg AI API key.
string[]
required
Up to 100 numbers, each with country code. Example:
["+919876543210", "+919876543211"]curl --request PATCH "https://prod-api.ringg.ai/ca/api/v0/campaign/terminate" \
--header "X-API-KEY: $RINGG_API_KEY" \
--header "Content-Type: application/json" \
--data '{ "mobile_numbers": ["+919876543210", "+919876543211"] }'
{ "message": "Calls terminated successfully!" }
Errors
400: a number has no call, or no call that can still be terminated, for exampleMobile numbers not found in campaign: ….401:X-API-KEYis missing or invalid.422: no field, more than 100 numbers, or a field of the wrong type.
Was this page helpful?