Terminate All Calls by Agent ID

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 '{ "agent_id": "00000000-0000-4000-8000-000000000110" }'

{ "message": "Calls terminated successfully!" }

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 '{ "agent_id": "00000000-0000-4000-8000-000000000110" }'

{ "message": "Calls terminated successfully!" }

string

required

Your Ringg AI API key.

string

required

The agent’s ID (find it). Example: 00000000-0000-4000-8000-000000000110

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 '{ "agent_id": "00000000-0000-4000-8000-000000000110" }'

{ "message": "Calls terminated successfully!" }

Only outbound calls created in the last 7 days are cancelled. In-progress and completed calls are handled as for by campaign; the agent’s campaigns keep their status.

Errors

200 is returned even when no call matched the ID; check the calls in call history.
401: X-API-KEY is missing or invalid.
422: no field, more than one way of choosing calls at once, or a field of the wrong type.

Introduction

Agents

Inventory

Calling

Monitoring

Account

Terminate All Calls by Agent ID

Errors

​Errors

Errors