Skip to main content

Conference recording stop

POST 
/conferences/:id/actions/record_stop

Stop recording the conference.

Expected Webhooks (see callback schema below):

  • conference.recording.saved

Request ​

Path Parameters

    id stringrequired

    Specifies the conference to stop the recording for by id or name

Body

required

Stop recording conference request

    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 any command with the same command_id for the same call_control_id.

Responses ​

200: Successful response upon making a conference command.

Schema

    data

    object

    result stringrequired

401: Unauthorized

404: Conference does not exist

422: Unprocessable entity

Callbacks ​

Request samples

curl -L 'https://api.telnyx.com/v2/conferences/:id/actions/record_stop' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
  "client_state": "aGF2ZSBhIG5pY2UgZGF5ID1d",
  "command_id": "891510ac-f3e4-11e8-af5b-de00688a4901"
}'

Response samples

{
  "data": {
    "result": "ok"
  }
}