Sign in
Call Commands

Enqueue call

Places the call into a queue, where it waits until it is removed or bridged to another leg. Queue behavior is configured through the request body.

post/calls/{call_control_id}/actions/enqueue

Path parameters

call_control_idstring required

Unique identifier and token for controlling the call

Request body

client_statestring

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

command_idstring

Use this field to avoid duplicate commands. Telnyx will ignore any command with the same command_id for the same call_control_id.

keep_after_hangupboolean

If set to true, the call will remain in the queue after hangup. In this case bridging to such call will fail with necessary information needed to re-establish the call.

max_sizeinteger

The maximum number of calls allowed in the queue at a given time. Can't be modified for an existing queue.

max_wait_time_secsinteger

The number of seconds after which the call will be removed from the queue.

queue_namestring required

The name of the queue the call should be put in. If a queue with a given name doesn't exist yet it will be created.

Example request

{
  "client_state": "aGF2ZSBhIG5pY2UgZGF5ID1d",
  "command_id": "891510ac-f3e4-11e8-af5b-de00688a4901",
  "max_size": 20,
  "max_wait_time_secs": 600,
  "queue_name": "support"
}

Response

Successful response upon making a call control command.

Example response

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

Changes

Changed in 2 of the 61 revisions of this API.7

  • 1571b0380bd73See the full diff
    • ▲

      the response's body type/format changed from object/ to / for status default

      response-body-type-changed

    • ▲

      the errors/items/ response's property type/format changed from object/ to / for status default

      response-property-type-changed

    • ▲

      the errors/items/code response's property type/format changed from integer/int32 to string/integer for status default

      response-property-type-changed

    This revision also has 64 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 8f5f4e5379944See the full diff
    • ▲

      the response's body type/format changed from / to object/ for status default

      response-body-type-changed

    • ▲

      the errors/items/ response's property type/format changed from / to object/ for status default

      response-property-type-changed

    • ▲

      the errors/items/code response's property type/format changed from string/integer to integer/int32 for status default

      response-property-type-changed

    • ▲

      the errors/items/source/pointer response's property type/format changed from string/json-pointer to string/ for status default

      response-property-type-changed

    This revision also has 41 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog