Worker Reservation Resource

Worker Reservations represent the current and past reservations for a Worker. Current Reservations can be accepted using the Reservation instance resource.

Reservation Properties

Property nameTypeRequiredDescriptionChild properties

accountSidSID<AC>

Optional

Not PII

The SID of the Account that created the WorkerReservation resource.

Pattern: ^AC[0-9a-fA-F]{32}$Min length: 34Max length: 34

dateCreatedstring<date-time>

Optional

Not PII

The date and time in GMT when the resource was created specified in ISO 8601 format.

dateUpdatedstring<date-time>

Optional

Not PII

The date and time in GMT when the resource was last updated specified in ISO 8601 format.

reservationStatusenum<string>

Optional

Not PII

Possible values:

pendingacceptedrejectedtimeoutcanceledrescindedwrappingcompleted

sidSID<WR>

Optional

Not PII

The unique string that we created to identify the WorkerReservation resource.

Pattern: ^WR[0-9a-fA-F]{32}$Min length: 34Max length: 34

taskSidSID<WT>

Optional

Not PII

The SID of the reserved Task resource.

Pattern: ^WT[0-9a-fA-F]{32}$Min length: 34Max length: 34

workerNamestring

Optional

Not PII

The friendly_name of the Worker that is reserved.

workerSidSID<WK>

Optional

Not PII

The SID of the reserved Worker resource.

Pattern: ^WK[0-9a-fA-F]{32}$Min length: 34Max length: 34

workspaceSidSID<WS>

Optional

Not PII

The SID of the Workspace that this worker is contained within.

Pattern: ^WS[0-9a-fA-F]{32}$Min length: 34Max length: 34

urlstring<uri>

Optional

Not PII

The absolute URL of the WorkerReservation resource.

linksobject<uri-map>

Optional

Not PII

The URLs of related resources.

Fetch a WorkerReservation resource

GET https://taskrouter.twilio.com/v1/Workspaces/{WorkspaceSid}/Workers/{WorkerSid}/Reservations/{Sid}

Path parameters

Property nameTypeRequiredPIIDescription

workspaceSidSID<WS>

required

Not PII

The SID of the Workspace with the WorkerReservation resource to fetch.

Pattern: ^WS[0-9a-fA-F]{32}$Min length: 34Max length: 34

workerSidSID<WK>

required

Not PII

The SID of the reserved Worker resource with the WorkerReservation resource to fetch.

Pattern: ^WK[0-9a-fA-F]{32}$Min length: 34Max length: 34

sidSID<WR>

required

Not PII

The SID of the WorkerReservation resource to fetch.

Pattern: ^WR[0-9a-fA-F]{32}$Min length: 34Max length: 34

Fetch a Reservation

1// Download the helper library from https://www.twilio.com/docs/node/install
2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4// Find your Account SID and Auth Token at twilio.com/console
5// and set the environment variables. See http://twil.io/secure
6const accountSid = process.env.TWILIO_ACCOUNT_SID;
7const authToken = process.env.TWILIO_AUTH_TOKEN;
8const client = twilio(accountSid, authToken);
9
10async function fetchWorkerReservation() {
11  const reservation = await client.taskrouter.v1
12    .workspaces("WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
13    .workers("WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
14    .reservations("WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
15    .fetch();
16
17  console.log(reservation.accountSid);
18}
19
20fetchWorkerReservation();

Response

1{
2  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
3  "date_created": "2014-05-14T10:50:02Z",
4  "date_updated": "2014-05-15T16:03:42Z",
5  "links": {
6    "task": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
7    "worker": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
8    "workspace": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
9  },
10  "reservation_status": "accepted",
11  "sid": "WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
12  "task_sid": "WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
13  "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Reservations/WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
14  "worker_name": "Doug",
15  "worker_sid": "WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
16  "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
17  "attention": 0
18}

Read multiple WorkerReservation resources

GET https://taskrouter.twilio.com/v1/Workspaces/{WorkspaceSid}/Workers/{WorkerSid}/Reservations

Path parameters

Property nameTypeRequiredPIIDescription

workspaceSidSID<WS>

required

Not PII

The SID of the Workspace with the WorkerReservation resources to read.

Pattern: ^WS[0-9a-fA-F]{32}$Min length: 34Max length: 34

workerSidSID<WK>

required

Not PII

The SID of the reserved Worker resource with the WorkerReservation resources to read.

Pattern: ^WK[0-9a-fA-F]{32}$Min length: 34Max length: 34

Query parameters

Property nameTypeRequiredPIIDescription

reservationStatusenum<string>

Optional

Not PII

Returns the list of reservations for a worker with a specified ReservationStatus. Can be: pending, accepted, rejected, timeout, canceled, or rescinded.

Possible values:

pendingacceptedrejectedtimeoutcanceledrescindedwrappingcompleted

pageSizeinteger<int64>

Optional

Not PII

How many resources to return in each list page. The default is 50, and the maximum is 1000.

Minimum: 1Maximum: 1000

pageinteger

Optional

Not PII

The page index. This value is simply for client state.

Minimum: 0

pageTokenstring

Optional

Not PII

The page token. This is provided by the API.

List multiple Reservations

1// Download the helper library from https://www.twilio.com/docs/node/install
2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4// Find your Account SID and Auth Token at twilio.com/console
5// and set the environment variables. See http://twil.io/secure
6const accountSid = process.env.TWILIO_ACCOUNT_SID;
7const authToken = process.env.TWILIO_AUTH_TOKEN;
8const client = twilio(accountSid, authToken);
9
10async function listWorkerReservation() {
11  const reservations = await client.taskrouter.v1
12    .workspaces("WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
13    .workers("WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
14    .reservations.list({ limit: 20 });
15
16  reservations.forEach((r) => console.log(r.accountSid));
17}
18
19listWorkerReservation();

Response

1{
2  "meta": {
3    "first_page_url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Reservations?PageSize=50&Page=0",
4    "key": "reservations",
5    "next_page_url": null,
6    "page": 0,
7    "page_size": 50,
8    "previous_page_url": null,
9    "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Reservations?PageSize=50&Page=0"
10  },
11  "reservations": [
12    {
13      "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
14      "date_created": "2014-05-14T10:50:02Z",
15      "date_updated": "2014-05-15T16:03:42Z",
16      "links": {
17        "task": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
18        "worker": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
19        "workspace": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
20      },
21      "reservation_status": "accepted",
22      "sid": "WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
23      "task_sid": "WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
24      "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Reservations/WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
25      "worker_name": "Doug",
26      "worker_sid": "WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
27      "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
28      "attention": 0
29    }
30  ]
31}

Update a WorkerReservation resource

POST https://taskrouter.twilio.com/v1/Workspaces/{WorkspaceSid}/Workers/{WorkerSid}/Reservations/{Sid}

To indicate that a Worker has accepted or rejected a Reservation, you make an HTTP POST request to a Reservation instance resource URI.

You can issue a simple Accept or Reject request. You can also issue an Instruction, like Dequeueing or Calling, similar to Responding to an Assignment Callback.

(warning)

Warning

Tasks are automatically canceled after 10 rejections.

See Manually accepting or rejecting a reservation for more information.

Headers

Property nameTypeRequiredPIIDescription

ifMatchstring

Optional

Not PII

The If-Match HTTP request header

Path parameters

Property nameTypeRequiredPIIDescription

workspaceSidSID<WS>

required

Not PII

The SID of the Workspace with the WorkerReservation resources to update.

Pattern: ^WS[0-9a-fA-F]{32}$Min length: 34Max length: 34

workerSidSID<WK>

required

Not PII

The SID of the reserved Worker resource with the WorkerReservation resources to update.

Pattern: ^WK[0-9a-fA-F]{32}$Min length: 34Max length: 34

sidSID<WR>

required

Not PII

The SID of the WorkerReservation resource to update.

Pattern: ^WR[0-9a-fA-F]{32}$Min length: 34Max length: 34

Request body parameters

Encoding type:application/x-www-form-urlencoded

SchemaExample

Property nameTypeRequiredDescriptionChild properties

reservationStatusenum<string>

Optional

Not PII

Possible values:

pendingacceptedrejectedtimeoutcanceledrescindedwrappingcompleted

workerActivitySidSID<WA>

Optional

Not PII

The new worker activity SID if rejecting a reservation.

Pattern: ^WA[0-9a-fA-F]{32}$Min length: 34Max length: 34

instructionstring

Optional

Not PII

The assignment instruction for the reservation.

dequeuePostWorkActivitySidSID<WA>

Optional

Not PII

The SID of the Activity resource to start after executing a Dequeue instruction.

Pattern: ^WA[0-9a-fA-F]{32}$Min length: 34Max length: 34

dequeueFromstring

Optional

Not PII

The caller ID of the call to the worker when executing a Dequeue instruction.

dequeueRecordstring

Optional

Not PII

Whether to record both legs of a call when executing a Dequeue instruction or which leg to record.

dequeueTimeoutinteger

Optional

Not PII

The timeout for call when executing a Dequeue instruction.

dequeueTostring

Optional

Not PII

The contact URI of the worker when executing a Dequeue instruction. Can be the URI of the Twilio Client, the SIP URI for Programmable SIP, or the E.164 formatted phone number, depending on the destination.

dequeueStatusCallbackUrlstring<uri>

Optional

Not PII

The callback URL for completed call event when executing a Dequeue instruction.

callFromstring

Optional

Not PII

The Caller ID of the outbound call when executing a Call instruction.

callRecordstring

Optional

Not PII

Whether to record both legs of a call when executing a Call instruction.

callTimeoutinteger

Optional

Not PII

The timeout for a call when executing a Call instruction.

callTostring

Optional

Not PII

The contact URI of the worker when executing a Call instruction. Can be the URI of the Twilio Client, the SIP URI for Programmable SIP, or the E.164 formatted phone number, depending on the destination.

callUrlstring<uri>

Optional

Not PII

TwiML URI executed on answering the worker's leg as a result of the Call instruction.

callStatusCallbackUrlstring<uri>

Optional

Not PII

The URL to call for the completed call event when executing a Call instruction.

callAcceptboolean

Optional

Not PII

Whether to accept a reservation when executing a Call instruction.

redirectCallSidSID<CA>

Optional

Not PII

The Call SID of the call parked in the queue when executing a Redirect instruction.

Pattern: ^CA[0-9a-fA-F]{32}$Min length: 34Max length: 34

redirectAcceptboolean

Optional

Not PII

Whether the reservation should be accepted when executing a Redirect instruction.

redirectUrlstring<uri>

Optional

Not PII

TwiML URI to redirect the call to when executing the Redirect instruction.

tostring

Optional

Not PII

The Contact URI of the worker when executing a Conference instruction. Can be the URI of the Twilio Client, the SIP URI for Programmable SIP, or the E.164 formatted phone number, depending on the destination.

fromstring

Optional

Not PII

The caller ID of the call to the worker when executing a Conference instruction.

statusCallbackstring<uri>

Optional

Not PII

The URL we should call using the status_callback_method to send status information to your application.

statusCallbackMethodenum<http-method>

Optional

Not PII

The HTTP method we should use to call status_callback. Can be: POST or GET and the default is POST.

Possible values:

GETPOST

statusCallbackEventarray[enum<string>]

Optional

Not PII

The call progress events that we will send to status_callback. Can be: initiated, ringing, answered, or completed.

Possible values:

initiatedringingansweredcompleted

timeoutinteger

Optional

Not PII

The timeout for a call when executing a Conference instruction.

recordboolean

Optional

Not PII

Whether to record the participant and their conferences, including the time between conferences. Can be true or false and the default is false.

mutedboolean

Optional

Not PII

Whether the agent is muted in the conference. Defaults to false.

beepstring

Optional

Not PII

Whether to play a notification beep when the participant joins or when to play a beep. Can be: true, false, onEnter, or onExit. The default value is true.

startConferenceOnEnterboolean

Optional

Not PII

Whether to start the conference when the participant joins, if it has not already started. Can be: true or false and the default is true. If false and the conference has not started, the participant is muted and hears background music until another participant starts the conference.

endConferenceOnExitboolean

Optional

Not PII

Whether to end the conference when the agent leaves.

waitUrlstring<uri>

Optional

Not PII

The URL we should call using the wait_method for the music to play while participants are waiting for the conference to start. The default value is the URL of our standard hold music. Learn more about hold music.

waitMethodenum<http-method>

Optional

Not PII

The HTTP method we should use to call wait_url. Can be GET or POST and the default is POST. When using a static audio file, this should be GET so that we can cache the file.

Possible values:

GETPOST

earlyMediaboolean

Optional

Not PII

Whether to allow an agent to hear the state of the outbound call, including ringing or disconnect messages. The default is true.

maxParticipantsinteger

Optional

Not PII

The maximum number of participants allowed in the conference. Can be a positive integer from 2 to 250. The default value is 250.

conferenceStatusCallbackstring<uri>

Optional

Not PII

The URL we should call using the conference_status_callback_method when the conference events in conference_status_callback_event occur. Only the value set by the first participant to join the conference is used. Subsequent conference_status_callback values are ignored.

conferenceStatusCallbackMethodenum<http-method>

Optional

Not PII

The HTTP method we should use to call conference_status_callback. Can be: GET or POST and defaults to POST.

Possible values:

GETPOST

conferenceStatusCallbackEventarray[enum<string>]

Optional

Not PII

The conference status events that we will send to conference_status_callback. Can be: start, end, join, leave, mute, hold, speaker.

Possible values:

startendjoinleavemuteholdspeaker

conferenceRecordstring

Optional

Not PII

Whether to record the conference the participant is joining or when to record the conference. Can be: true, false, record-from-start, and do-not-record. The default value is false.

conferenceTrimstring

Optional

Not PII

Whether to trim leading and trailing silence from your recorded conference audio files. Can be: trim-silence or do-not-trim and defaults to trim-silence.

recordingChannelsstring

Optional

Not PII

The recording channels for the final recording. Can be: mono or dual and the default is mono.

recordingStatusCallbackstring<uri>

Optional

Not PII

The URL that we should call using the recording_status_callback_method when the recording status changes.

recordingStatusCallbackMethodenum<http-method>

Optional

Not PII

The HTTP method we should use when we call recording_status_callback. Can be: GET or POST and defaults to POST.

Possible values:

GETPOST

conferenceRecordingStatusCallbackstring<uri>

Optional

Not PII

The URL we should call using the conference_recording_status_callback_method when the conference recording is available.

conferenceRecordingStatusCallbackMethodenum<http-method>

Optional

Not PII

The HTTP method we should use to call conference_recording_status_callback. Can be: GET or POST and defaults to POST.

Possible values:

GETPOST

regionstring

Optional

Not PII

The region where we should mix the recorded audio. Can be:us1, us2, ie1, de1, sg1, br1, au1, or jp1.

sipAuthUsernamestring

Optional

Not PII

The SIP username used for authentication.

sipAuthPasswordstring

Optional

Not PII

The SIP password for authentication.

dequeueStatusCallbackEventarray[string]

Optional

Not PII

The call progress events sent via webhooks as a result of a Dequeue instruction.

postWorkActivitySidSID<WA>

Optional

Not PII

The new worker activity SID after executing a Conference instruction.

Pattern: ^WA[0-9a-fA-F]{32}$Min length: 34Max length: 34

endConferenceOnCustomerExitboolean

Optional

Not PII

Whether to end the conference when the customer leaves.

beepOnCustomerEntranceboolean

Optional

Not PII

Whether to play a notification beep when the customer joins.

jitterBufferSizestring

Optional

Not PII

The jitter buffer size for conference. Can be: small, medium, large, off.

Accept a Reservation

1// Download the helper library from https://www.twilio.com/docs/node/install
2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4// Find your Account SID and Auth Token at twilio.com/console
5// and set the environment variables. See http://twil.io/secure
6const accountSid = process.env.TWILIO_ACCOUNT_SID;
7const authToken = process.env.TWILIO_AUTH_TOKEN;
8const client = twilio(accountSid, authToken);
9
10async function updateWorkerReservation() {
11  const reservation = await client.taskrouter.v1
12    .workspaces("WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
13    .workers("WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
14    .reservations("WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
15    .update({ reservationStatus: "accepted" });
16
17  console.log(reservation.accountSid);
18}
19
20updateWorkerReservation();

Response

1{
2  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
3  "date_created": "2014-05-14T10:50:02Z",
4  "date_updated": "2014-05-15T16:03:42Z",
5  "links": {
6    "task": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
7    "worker": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
8    "workspace": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
9  },
10  "reservation_status": "accepted",
11  "sid": "WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
12  "task_sid": "WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
13  "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Reservations/WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
14  "worker_name": "Doug",
15  "worker_sid": "WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
16  "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
17  "attention": 0
18}

Reject a Reservation

1// Download the helper library from https://www.twilio.com/docs/node/install
2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4// Find your Account SID and Auth Token at twilio.com/console
5// and set the environment variables. See http://twil.io/secure
6const accountSid = process.env.TWILIO_ACCOUNT_SID;
7const authToken = process.env.TWILIO_AUTH_TOKEN;
8const client = twilio(accountSid, authToken);
9
10async function updateWorkerReservation() {
11  const reservation = await client.taskrouter.v1
12    .workspaces("WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
13    .workers("WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
14    .reservations("WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
15    .update({ reservationStatus: "rejected" });
16
17  console.log(reservation.accountSid);
18}
19
20updateWorkerReservation();

Response

1{
2  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
3  "date_created": "2014-05-14T10:50:02Z",
4  "date_updated": "2014-05-15T16:03:42Z",
5  "links": {
6    "task": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
7    "worker": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
8    "workspace": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
9  },
10  "reservation_status": "rejected",
11  "sid": "WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
12  "task_sid": "WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
13  "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Reservations/WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
14  "worker_name": "Doug",
15  "worker_sid": "WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
16  "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
17  "attention": 0
18}

Dequeue a Reservation

1// Download the helper library from https://www.twilio.com/docs/node/install
2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4// Find your Account SID and Auth Token at twilio.com/console
5// and set the environment variables. See http://twil.io/secure
6const accountSid = process.env.TWILIO_ACCOUNT_SID;
7const authToken = process.env.TWILIO_AUTH_TOKEN;
8const client = twilio(accountSid, authToken);
9
10async function updateWorkerReservation() {
11  const reservation = await client.taskrouter.v1
12    .workspaces("WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
13    .workers("WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
14    .reservations("WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
15    .update({
16      dequeueFrom: "+18001231234",
17      instruction: "dequeue",
18    });
19
20  console.log(reservation.accountSid);
21}
22
23updateWorkerReservation();

Response

1{
2  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
3  "date_created": "2014-05-14T10:50:02Z",
4  "date_updated": "2014-05-15T16:03:42Z",
5  "links": {
6    "task": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
7    "worker": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
8    "workspace": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
9  },
10  "reservation_status": "accepted",
11  "sid": "WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
12  "task_sid": "WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
13  "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Reservations/WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
14  "worker_name": "Doug",
15  "worker_sid": "WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
16  "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
17  "attention": 0
18}

Call a Reservation

1// Download the helper library from https://www.twilio.com/docs/node/install
2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4// Find your Account SID and Auth Token at twilio.com/console
5// and set the environment variables. See http://twil.io/secure
6const accountSid = process.env.TWILIO_ACCOUNT_SID;
7const authToken = process.env.TWILIO_AUTH_TOKEN;
8const client = twilio(accountSid, authToken);
9
10async function updateWorkerReservation() {
11  const reservation = await client.taskrouter.v1
12    .workspaces("WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
13    .workers("WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
14    .reservations("WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
15    .update({
16      callAccept: true,
17      callFrom: "+15558675310",
18      callStatusCallbackUrl: "http://example.com/agent_answer_status_callback",
19      callUrl: "http://example.com/agent_answer",
20      instruction: "call",
21    });
22
23  console.log(reservation.accountSid);
24}
25
26updateWorkerReservation();

Response

1{
2  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
3  "date_created": "2014-05-14T10:50:02Z",
4  "date_updated": "2014-05-15T16:03:42Z",
5  "links": {
6    "task": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
7    "worker": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
8    "workspace": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
9  },
10  "reservation_status": "accepted",
11  "sid": "WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
12  "task_sid": "WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
13  "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Reservations/WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
14  "worker_name": "Doug",
15  "worker_sid": "WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
16  "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
17  "attention": 0
18}