Sign in
Queue Members

Get next queue member

Retrieves the call at the front of one voice queue without removing it. Use it to inspect which waiting caller would be handled next; use Get queue member for a specific member ID. This read does not dequeue or redirect the call.

Permissions

The API token used to authenticate must have the following scope(s) enabled to make a successful request: Voice.

Learn more about API scopes.

get/api/relay/rest/queues/{queue_id}/members/next

Path parameters

queue_idstring uuid required

Universal Unique Identifier.

Unique ID of the queue.

Response

The request has succeeded.

call_idstring uuid required

Universal Unique Identifier.

project_idstring required

The ID of the project associated with this queue member.

queue_idstring required

The ID of the queue associated with this queue member.

positioninteger required

Queue member position in the queue.

uristring required

The URL of this queue member.

wait_timeinteger

Wait time in seconds since the member was enqueued. If not yet enqueued, it will be null.

date_enqueuedstring date-time

When the queue member was last enqueued.

Example response

{
  "project_id": "d421473b-d696-449a-a1a1-4ddd83d2d0e5",
  "queue_id": "596e2dea-a269-4765-a0b4-01b82d11c120",
  "position": 2,
  "uri": "/api/relay/rest/queues/596e2dea-a269-4765-a0b4-01b82d11c120/members/596e2dea-a269-4765-a0b4-01b82d11c120",
  "wait_time": 172975
}

Changes

No changes found, but 3 of the 137 revisions have a changelog that could not be searched — this endpoint may have changed in one of them.