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
GuidesReference
GuidesReference
    • Core
      • Overview
    • Agents
      • Overview
      • AgentBase
      • AgentServer
      • Configuration
      • ContextBuilder
      • DataMap
      • FunctionResult
      • Helper Functions & Utilities
      • LiveWire
      • PomBuilder
      • Prefabs
      • SkillBase
      • SkillManager
      • SkillRegistry
      • Skills
      • SwaigFunction
      • SwmlBuilder
      • SWMLService
    • RELAY
      • Overview
      • Actions
      • Call
      • Constants
      • Events
      • Message
      • RelayClient
      • RelayError
    • REST Client
      • Overview
      • Addresses
      • Calling
      • ChatResource
      • Compat
        • Accounts
        • Applications
        • Calls
        • Conferences
        • Faxes
        • LAML Bins
        • Messages
        • Phone Numbers
        • Queues
          • create
          • delete
          • dequeueMember
          • get
          • getMember
          • list
          • listMembers
          • update
        • Recordings
        • Tokens
        • Transcriptions
      • Datasphere
      • Fabric
      • ImportedNumbersResource
      • Logs
      • LookupResource
      • MFA
      • Number Groups
      • Phone Numbers
      • Project
      • PubSubResource
      • Queues
      • Recordings
      • Registry
      • RestClient
      • RestError
      • Short Codes
      • SIP Profile
      • Verified Callers
      • Video
LogoLogoSignalWire Docs
Log inSign up
Support
On this page
  • Response Example
  • Example
REST ClientCompatQueues

dequeueMember

|View as Markdown|Open in Claude|
Was this page helpful?
Edit this page
Previous

get

Next
Built with

Dequeue a member from a queue, redirecting the call to a new LAML URL.

Path parameters

AccountSidstringRequiredformat: "uuid"
The unique identifier for the account this Queue is associated with.
QueueSidstringRequiredformat: "uuid"
The unique identifier for the queue.
CallSidstringRequired
The unique identifier for the call, or the special value 'Front' to reference the member at the front of the queue.

Request

UrlstringRequiredformat: "uri"
The URL to redirect the dequeued member to. This URL should return cXML instructions for handling the call.
MethodenumOptionalDefaults to POST
The HTTP method to use when requesting the URL. Default is `POST`.
Allowed values:

Response

call_sidstringRequiredformat: "uuid"
The unique identifier for the call.
account_sidstringRequiredformat: "uuid"
The unique identifier for the account.
queue_sidstringRequiredformat: "uuid"
The unique identifier for the queue.
date_enqueuedstringRequired
The date and time, in RFC 2822 format, when the member was enqueued.
positionintegerRequired>=1
The position of the member in the queue (1-indexed).
wait_timeintegerRequired>=0
The wait time, in seconds, since the member was enqueued.
member_typestringRequired
The type of the queue member.
uristringRequired
The URI of this resource, relative to the API base URL.

Response Example

Response
1{
2  "call_sid": "b3877c40-da60-4998-90ad-b792e98472ca",
3  "account_sid": "b3877c40-da60-4998-90ad-b792e98472af",
4  "queue_sid": "b3877c40-da60-4998-90ad-b792e98472qu",
5  "date_enqueued": "Wed, 26 Sep 2018 18:00:00 +0000",
6  "position": 1,
7  "wait_time": 30,
8  "member_type": "laml_call",
9  "uri": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Queues/b3877c40-da60-4998-90ad-b792e98472qu/Members/b3877c40-da60-4998-90ad-b792e98472ca.json"
10}

Example

1import { RestClient } from "@signalwire/sdk";
2
3const client = new RestClient({
4  project: "your-project-id",
5  token: "your-api-token",
6  host: "your-space.signalwire.com"
7});
8
9await client.compat.queues.dequeueMember(
10  "QU...", "CA...",
11  { Url: "https://example.com/dequeue" }
12);