Worker Reservation Resource

The SID of the Account that created the WorkerReservation resource.

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

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

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

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

The SID of the reserved Task resource.

The friendly_name of the Worker that is reserved.

The SID of the reserved Worker resource.

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

The absolute URL of the WorkerReservation resource.

The URLs of related resources.

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

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

The SID of the WorkerReservation resource to fetch.

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

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

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

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

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

The SID of the WorkerReservation resource to update.

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

The new worker activity SID if rejecting a reservation.

The assignment instruction for the reservation.

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

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

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

The timeout for call when executing a Dequeue instruction.

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.

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

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

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

The timeout for a call when executing a Call instruction.

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.

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

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

Whether to accept a reservation when executing a Call instruction.

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

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

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

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.

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

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

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

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

The timeout for a call when executing a Conference instruction.

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

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

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.

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.

Whether to end the conference when the agent leaves.

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.

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.

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

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

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.

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

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

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.

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.

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

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

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

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

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

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

The SIP username used for authentication.

The SIP password for authentication.

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

The new worker activity SID after executing a Conference instruction.

Whether to end the conference when the customer leaves.

Whether to play a notification beep when the customer joins.

The If-Match HTTP request header