For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Log inSign up
Support
  • Core
    • Overview
    • Authorization
    • Base URL
    • Data formats
    • Paging
    • Error codes
    • Permissions
  • Calling
      • GETGet next queue member
      • GETGet queue member
      • GETList queue members
  • Datasphere
  • Logs
  • Messaging
  • Phone Number Management
  • Platform
  • Resource Management
LogoLogoSignalWire Docs
Log inSign up
Support
CallingQueue Members

Get next queue member

|View as Markdown|Open in Claude|
GET
https://{your_space_name}.signalwire.com/api/relay/rest/queues/:queue_id/members/next
GET
/api/relay/rest/queues/:queue_id/members/next
$curl https://{your_space_name}.signalwire.com/api/relay/rest/queues/queue_id/members/next \
> -u "<project_id>:<api_token>"
1{
2 "call_id": "596e2dea-a269-4765-a0b4-01b82d11c120",
3 "project_id": "d421473b-d696-449a-a1a1-4ddd83d2d0e5",
4 "queue_id": "596e2dea-a269-4765-a0b4-01b82d11c120",
5 "position": 2,
6 "uri": "/api/relay/rest/queues/596e2dea-a269-4765-a0b4-01b82d11c120/members/596e2dea-a269-4765-a0b4-01b82d11c120",
7 "wait_time": 172975,
8 "date_enqueued": "2024-01-15T09:30:00Z"
9}

Retrieves the next member in the queue without dequeuing.

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.

Was this page helpful?
Previous

Get queue member

Next
Built with

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.

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
Wait time in seconds since the member was enqueued. If not yet enqueued, it will be null.
date_enqueueddatetime
When the queue member was last enqueued.

Errors

401
Unauthorized Error
404
Not Found Error
500
Internal Server Error

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)