Skip to navigation
CallingQueue Members

Get queue member

View as MarkdownOpen in Claude

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.

Authentication

AuthorizationBasic

SignalWire Basic Authentication using Project ID and API Token.

The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password.

Example:

Authorization: Basic base64(project_id:token)

Path parameters

queue_idstringRequiredformat: "uuid"
Unique ID of the queue.
idstringRequiredformat: "uuid"

The call ID of the queue member, as returned in the member’s call_id. Queue members have no separate ID.

Response

The request has succeeded.
call_idstringformat: "uuid"
The call ID of the queue member.
project_idstring
The ID of the project associated with this queue member.
queue_idstring
The ID of the queue associated with this queue member.
positioninteger
Queue member position in the queue.
uristring
The URL of this queue member.
wait_timeinteger or null
Wait time in seconds since the member was enqueued. If not yet enqueued, it will be null.
date_enqueueddatetime or null

When the queue member was last enqueued, or null if not yet enqueued.

Errors

500
Internal Server Error