Sign in

v51

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-014102371.0 MB
Queue

Update the queue details

Updates the details of the queue identified by the given ID.

put/queues/{id}

Path parameters

idstring required

Request body

namestring required
detailstring required
routing_method'' | 'random' required
tag_idsstring[] required
wait_flow_idstring required

Flow ID for the wait queue.

wait_timeoutinteger required
service_timeoutinteger required

Example request

{
  "routing_method": "random"
}

Response

The updated queue details.

idstring uuid

The unique identifier of the queue. Returned from the POST /queues or GET /queues response.

customer_idstring uuid

The unique identifier of the customer who owns this queue. Returned from the GET /customers response.

namestring

Display name of the queue.

detailstring

Detailed description of the queue.

routing_method'' | 'random'
tag_idsstring[]

List of tag IDs assigned to this queue. Returned from the POST /tags or GET /tags response.

direct_hashstring

Hash for direct access via SIP URI sip:direct.<hash>@sip.voipbin.net. Returned from the resource's direct_hash field.

wait_flow_idstring uuid

The flow ID executed while callers wait in queue. Returned from the POST /flows or GET /flows response.

wait_timeoutinteger

Wait queue timeout in milliseconds.

service_timeoutinteger

Service queue timeout in milliseconds.

wait_queuecall_idsstring[]

List of queuecall IDs currently waiting. Returned from the GET /queuecalls response.

service_queuecall_idsstring[]

List of queuecall IDs currently being serviced. Each ID is returned from the GET /queuecalls response.

total_incoming_countinteger

Total incoming call count.

total_serviced_countinteger

Total serviced call count.

total_abandoned_countinteger

Total abandoned call count.

tm_createstring date-time

The creation timestamp.

tm_updatestring date-time

The last update timestamp.

tm_deletestring date-time

The deletion timestamp.

Example response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  "name": "Sales Queue",
  "detail": "Handles incoming sales inquiries",
  "routing_method": "random",
  "tag_ids": [
    "b1a2c3d4-e5f6-7890-abcd-ef1234567890"
  ],
  "direct_hash": "a8f3b2c1d4e5",
  "wait_flow_id": "d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f90",
  "wait_timeout": 300000,
  "service_timeout": 600000,
  "wait_queuecall_ids": [
    "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  ],
  "service_queuecall_ids": [
    "c3d4e5f6-a7b8-9c0d-1e2f-3a4b5c6d7e8f"
  ],
  "total_incoming_count": 150,
  "total_serviced_count": 120,
  "total_abandoned_count": 10,
  "tm_create": "2026-01-15T09:30:00.000000Z",
  "tm_update": "2026-01-16T14:20:00.000000Z",
  "tm_delete": "2026-01-17T18:45:00.000000Z"
}