TaskrouterWorker Reservation

Update Worker Reservation

POST
/v1/Workspaces/{WorkspaceSid}/Workers/{WorkerSid}/Reservations/{Sid}

Authorization

accountSid_authToken
AuthorizationBasic <token>

In: header

Path Parameters

WorkspaceSid*string

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

Match^WS[0-9a-fA-F]{32}$
Length34 <= length <= 34
WorkerSid*string

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

Match^WK[0-9a-fA-F]{32}$
Length34 <= length <= 34
Sid*string

The SID of the WorkerReservation resource to update.

Match^WR[0-9a-fA-F]{32}$
Length34 <= length <= 34

Header Parameters

If-Match?string

The If-Match HTTP request header

Request Body

application/x-www-form-urlencoded

ReservationStatus?WorkerReservationStatus

The current status of the reservation. Can be: pending, accepted, rejected, timeout, canceled, or rescinded.

Value in

  • "pending"
  • "accepted"
  • "rejected"
  • "timeout"
  • "canceled"
  • "rescinded"
  • "wrapping"
  • "completed"
WorkerActivitySid?string

The new worker activity SID if rejecting a reservation.

Match^WA[0-9a-fA-F]{32}$
Length34 <= length <= 34
Instruction?string

The assignment instruction for the reservation.

DequeuePostWorkActivitySid?string

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

Match^WA[0-9a-fA-F]{32}$
Length34 <= length <= 34
DequeueFrom?string

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

DequeueRecord?string

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

DequeueTimeout?integer

The timeout for call when executing a Dequeue instruction.

DequeueTo?string

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.

DequeueStatusCallbackUrl?string

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

Formaturi
CallFrom?string

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

CallRecord?string

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

CallTimeout?integer

The timeout for a call when executing a Call instruction.

CallTo?string

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.

CallUrl?string

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

Formaturi
CallStatusCallbackUrl?string

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

Formaturi
CallAccept?boolean

Whether to accept a reservation when executing a Call instruction.

RedirectCallSid?string

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

Match^CA[0-9a-fA-F]{32}$
Length34 <= length <= 34
RedirectAccept?boolean

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

RedirectUrl?string

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

Formaturi
To?string

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.

From?string

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

StatusCallback?string

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

Formaturi
StatusCallbackMethod?string

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

Formathttp-method

Value in

  • "GET"
  • "POST"
StatusCallbackEvent?array<>

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

Timeout?integer

The timeout for a call when executing a Conference instruction.

Record?boolean

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

Muted?boolean

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

Beep?string

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.

StartConferenceOnEnter?boolean

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.

EndConferenceOnExit?boolean

Whether to end the conference when the agent leaves.

WaitUrl?string

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.

Formaturi
WaitMethod?string

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.

Formathttp-method

Value in

  • "GET"
  • "POST"
EarlyMedia?boolean

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

MaxParticipants?integer

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

ConferenceStatusCallback?string

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.

Formaturi
ConferenceStatusCallbackMethod?string

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

Formathttp-method

Value in

  • "GET"
  • "POST"
ConferenceStatusCallbackEvent?array<>

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

ConferenceRecord?string

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.

ConferenceTrim?string

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.

RecordingChannels?string

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

RecordingStatusCallback?string

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

Formaturi
RecordingStatusCallbackMethod?string

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

Formathttp-method

Value in

  • "GET"
  • "POST"
ConferenceRecordingStatusCallback?string

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

Formaturi
ConferenceRecordingStatusCallbackMethod?string

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

Formathttp-method

Value in

  • "GET"
  • "POST"
Region?string

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

SipAuthUsername?string

The SIP username used for authentication.

SipAuthPassword?string

The SIP password for authentication.

DequeueStatusCallbackEvent?array<string>

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

PostWorkActivitySid?string

The new worker activity SID after executing a Conference instruction.

Match^WA[0-9a-fA-F]{32}$
Length34 <= length <= 34
EndConferenceOnCustomerExit?boolean

Whether to end the conference when the customer leaves.

BeepOnCustomerEntrance?boolean

Whether to play a notification beep when the customer joins.

JitterBufferSize?string

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

Response Body

application/json

curl -X POST "https://example.com/v1/Workspaces/stringstringstringstringstringstri/Workers/stringstringstringstringstringstri/Reservations/stringstringstringstringstringstri" \  -H "Content-Type: application/x-www-form-urlencoded" \  -d 'ReservationStatus=accepted'
{  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",  "date_created": "2014-05-14T10:50:02Z",  "date_updated": "2014-05-15T16:03:42Z",  "links": {    "task": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",    "worker": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",    "workspace": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"  },  "reservation_status": "accepted",  "sid": "WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",  "task_sid": "WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",  "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Reservations/WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",  "worker_name": "Doug",  "worker_sid": "WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",  "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"}