Stop gather

POST 
/calls/:call_control_id/actions/gather_stop

Stops previously started gather

Expected Webhooks:

• Gather ended

Path Parameters

call_control_id stringrequired

Unique identifier and token for controlling the call

application/json

Body

required

client_state string

Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string.

command_id string

Use this field to avoid duplicate commands. Telnyx will ignore commands with the same "command_id".

200: Successful response

application/json

• Schema
• Example (from schema)

Schema

result stringrequired

{
  "result": "ok"
}

422: Error response

application/json

• Schema
• Example (from schema)

Schema

code stringrequired
title stringrequired
detail stringrequired

{
  "code": "90015",
  "title": "Invalid Call Control ID",
  "detail": "The call_control_id provided was not valid."
}

Request samples

• cURL

---

curl -L 'https://api.telnyx.com/calls/:call_control_id/actions/gather_stop' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d '{
  "client_state": "aGF2ZSBhIG5pY2UgZGF5ID1d",
  "command_id": "891510ac-f3e4-11e8-af5b-de00688a4901"
}'

Response samples

• 200
• 422

---

{
  "result": "ok"
}

{
  "code": "90015",
  "title": "Invalid Call Control ID",
  "detail": "The call_control_id provided was not valid."
}