Update | SignalWire

Use this endpoint for the Queue Members method to modify the properties of a queue member that is actively waiting in a call queue.

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.

Request examples

1 const { RestClient } = require('@signalwire/compatibility-api')
2 const client = RestClient('YourProjectID', 'YourAuthToken', { signalwireSpaceUrl: 'example.signalwire.com' })
3 
4 client.queues('QueueSid')
5       .members('CallSid')
6       .update()
7       .then(member => console.log(member.callSid))
8       .done();

Request: dequeue from front of queue

Dequeue the member that is waiting at the front of the queue.

1 const { RestClient } = require('@signalwire/compatibility-api')
2 const client = RestClient('YourProjectID', 'YourAuthToken', { signalwireSpaceUrl: 'example.signalwire.com' })
3 
4 client.queues('QueueSid')
5       .members('Front')
6       .update({url: 'http://your-application.com/docs/voice.xml', method: 'POST'})
7       .then(member => console.log(member.callSid))
8       .done();

Request: dequeue particular member

Dequeue a particular member by specifying their CallSid. Only the initial dequeue request will return a 200 response. All other dequeue requests on the same CallSid will result in a 400 response.

1 const { RestClient } = require('@signalwire/compatibility-api')
2 const client = RestClient('YourProjectID', 'YourAuthToken', { signalwireSpaceUrl: 'example.signalwire.com' })
3 
4 client.queues('QueueSid')
5       .members('CallSid')
6       .update({url: 'http://your-application.com/docs/voice.xml', method: 'POST'})
7       .then(member => console.log(member.callSid))
8       .done();