Skip to main content

Enqueue call

POST 
/calls/:call_control_id/actions/enqueue

Put the call in a queue.

Request​

Path Parameters

    call_control_id stringrequired

    Unique identifier and token for controlling the call

Body

required

Enqueue call request

    queue_name string

    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.

    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.

    max_wait_time_secs integer

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

    max_size integer

    Default value: 100

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

Responses​

200: Successful response upon making a call control command.

Schema

    data

    object

    result string

default: Unexpected error

Schema

    errors

    Error[]

  • Array [

    • code integerrequired
    title stringrequired
    detail string

    source

    object

    pointer json-pointer

    JSON pointer (RFC6901) to the offending entity.

    parameter string

    Indicates which query parameter caused the error.

    meta object

  • ]

Callbacks​

Request samples

curl -L 'https://api.telnyx.com/v2/calls/:call_control_id/actions/enqueue' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
  "queue_name": "support",
  "max_wait_time_secs": 600,
  "max_size": 20,
  "client_state": "aGF2ZSBhIG5pY2UgZGF5ID1d",
  "command_id": "891510ac-f3e4-11e8-af5b-de00688a4901"
}'

Response samples

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