Queue Members

Get queue member

Retrieves one call that is waiting in a voice queue. Use List queue members to find waiting calls or Get next queue member to inspect the caller at the front of the queue.

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/{id}

Request

  • Base URL
    https://{Your_Space_Name}.signalwire.com
  • URL
    https://{Your_Space_Name}.signalwire.com/api/relay/rest/queues/{queue_id}/members/{id}
  • Auth
    HTTP basic

Path parameters

queue_idstring uuid required

Universal Unique Identifier.

Unique ID of the queue.

idstring uuid required

Universal Unique Identifier.

The unique identifier (ID) of the queue member.

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 operation changes found yet. Some revisions have not been checked.