ReservationStatus'pending' | 'accepted' | 'rejected' | 'timeout' | 'canceled' | 'rescinded' | 'wrapping' | 'completed'
The current status of the reservation. Can be: pending, accepted, rejected, or timeout.
WorkerActivitySidstring
The new worker activity SID if rejecting a reservation.
Instructionstring
The assignment instruction for reservation.
DequeuePostWorkActivitySidstring
The SID of the Activity resource to start after executing a Dequeue instruction.
DequeueFromstring
The Caller ID of the call to the worker when executing a Dequeue instruction.
DequeueRecordstring
Whether to record both legs of a call when executing a Dequeue instruction or which leg to record.
DequeueTimeoutinteger
Timeout for call when executing a Dequeue instruction.
DequeueTostring
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
The Callback URL for completed call event when executing a Dequeue instruction.
CallFromstring
The Caller ID of the outbound call when executing a Call instruction.
CallRecordstring
Whether to record both legs of a call when executing a Call instruction or which leg to record.
CallTimeoutinteger
Timeout for call when executing a Call instruction.
CallTostring
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
TwiML URI executed on answering the worker's leg as a result of the Call instruction.
CallStatusCallbackUrlstring uri
The URL to call for the completed call event when executing a Call instruction.
CallAcceptboolean
Whether to accept a reservation when executing a Call instruction.
RedirectCallSidstring
The Call SID of the call parked in the queue when executing a Redirect instruction.
RedirectAcceptboolean
Whether the reservation should be accepted when executing a Redirect instruction.
RedirectUrlstring uri
TwiML URI to redirect the call to when executing the Redirect instruction.
Tostring
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
The Caller ID of the call to the worker when executing a Conference instruction.
StatusCallbackstring uri
The URL we should call using the status_callback_method to send status information to your application.
StatusCallbackMethod'GET' | 'POST' http-method
The HTTP method we should use to call status_callback. Can be: POST or GET and the default is POST.
StatusCallbackEventTaskReservationEnumCallStatus[]
The call progress events that we will send to status_callback. Can be: initiated, ringing, answered, or completed.
Timeoutinteger
Timeout for call when executing a Conference instruction.
Recordboolean
Whether to record the participant and their conferences, including the time between conferences. The default is false.
Mutedboolean
Whether the agent is muted in the conference. The default is false.
Beepstring
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
Whether to start the conference when the participant joins, if it has not already started. 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
Whether to end the conference when the agent leaves.
WaitUrlstring uri
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.
WaitMethod'GET' | 'POST' http-method
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.
EarlyMediaboolean
Whether to allow an agent to hear the state of the outbound call, including ringing or disconnect messages. The default is true.
MaxParticipantsinteger
The maximum number of participants in the conference. Can be a positive integer from 2 to 250. The default value is 250.
ConferenceStatusCallbackstring uri
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.
ConferenceStatusCallbackMethod'GET' | 'POST' http-method
The HTTP method we should use to call conference_status_callback. Can be: GET or POST and defaults to POST.
ConferenceStatusCallbackEventTaskReservationEnumConferenceEvent[]
The conference status events that we will send to conference_status_callback. Can be: start, end, join, leave, mute, hold, speaker.
ConferenceRecordstring
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
How to trim the leading and trailing silence from your recorded conference audio files. Can be: trim-silence or do-not-trim and defaults to trim-silence.
RecordingChannelsstring
The recording channels for the final recording. Can be: mono or dual and the default is mono.
RecordingStatusCallbackstring uri
The URL that we should call using the recording_status_callback_method when the recording status changes.
RecordingStatusCallbackMethod'GET' | 'POST' http-method
The HTTP method we should use when we call recording_status_callback. Can be: GET or POST and defaults to POST.
ConferenceRecordingStatusCallbackstring uri
The URL we should call using the conference_recording_status_callback_method when the conference recording is available.
ConferenceRecordingStatusCallbackMethod'GET' | 'POST' http-method
The HTTP method we should use to call conference_recording_status_callback. Can be: GET or POST and defaults to POST.
Regionstring
The region where we should mix the recorded audio. Can be:us1, us2, ie1, de1, sg1, br1, au1, or jp1.
SipAuthUsernamestring
The SIP username used for authentication.
SipAuthPasswordstring
The SIP password for authentication.
DequeueStatusCallbackEventstring[]
The Call progress events sent via webhooks as a result of a Dequeue instruction.
PostWorkActivitySidstring
The new worker activity SID after executing a Conference instruction.
SupervisorMode'monitor' | 'whisper' | 'barge'
Supervisorstring
The Supervisor SID/URI when executing the Supervise instruction.
EndConferenceOnCustomerExitboolean
Whether to end the conference when the customer leaves.
BeepOnCustomerEntranceboolean
Whether to play a notification beep when the customer joins.
JitterBufferSizestring
The jitter buffer size for conference. Can be: small, medium, large, off.