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 '{
"campaign_id": "00000000-0000-4000-8000-000000000103",
"mobile_numbers": ["+919876543210", "+919876543211"]
}'
{ "message": "Calls terminated successfully!" }
Terminate Calls by Campaign Numbers
Stop calls to up to 100 phone numbers inside one campaign while the rest of it keeps running, for example when a contact asks not to be called again.
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 '{
"campaign_id": "00000000-0000-4000-8000-000000000103",
"mobile_numbers": ["+919876543210", "+919876543211"]
}'
{ "message": "Calls terminated successfully!" }
The same numbers in other campaigns are still called; to stop a number everywhere, use by numbers.
string
required
Your Ringg AI API key.
string
required
The campaign’s ID. Example:
00000000-0000-4000-8000-000000000103string[]
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 '{
"campaign_id": "00000000-0000-4000-8000-000000000103",
"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?