Call Commands

Update client state

Updates the client state associated with the call. Client state is an opaque value echoed back in subsequent webhooks for the call, letting you correlate events with your application's state.

put/calls/{call_control_id}/actions/client_state_update

Request

  • Base URL
    https://api.telnyx.com/v2
  • URL
    https://api.telnyx.com/v2/calls/{call_control_id}/actions/client_state_update
  • Auth
    HTTP bearer

Path parameters

call_control_idstring required

Unique identifier and token for controlling the call

Request body

client_statestring required

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

Example request

{
  "client_state": "aGF2ZSBhIG5pY2UgZGF5ID1d"
}

Response

Successful response upon making a call control command.

Example response

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

Changes

No recorded changes to this operation across all 89 revisions of this API.