Body

• 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.

• BeepOnCustomerEntrance boolean

  Whether to play a notification beep when the customer joins.

• CallAccept boolean

  Whether to accept a reservation when executing a Call instruction.

• 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 or which leg to record.

• CallStatusCallbackUrl string(uri)

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

• CallTimeout integer

  Timeout for 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(uri)

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

• 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.

• ConferenceRecordingStatusCallback string(uri)

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

• ConferenceRecordingStatusCallbackMethod string(http-method)

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

  Values are HEAD, GET, POST, PATCH, PUT, or DELETE.

• ConferenceStatusCallback string(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.

• ConferenceStatusCallbackEvent array[string]

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

  Values are start, end, join, leave, mute, hold, or speaker.

• ConferenceStatusCallbackMethod string(http-method)

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

  Values are HEAD, GET, POST, PATCH, PUT, or DELETE.

• ConferenceTrim string

  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.

• DequeueFrom string

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

• DequeuePostWorkActivitySid string

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

  Minimum length is 34, maximum length is 34. Format should match the following pattern: ^WA[0-9a-fA-F]{32}$.

• DequeueRecord string

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

• DequeueStatusCallbackEvent array[string]

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

• DequeueStatusCallbackUrl string(uri)

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

• DequeueTimeout integer

  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.

• EarlyMedia boolean

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

• EndConferenceOnCustomerExit boolean

  Whether to end the conference when the customer leaves.

• EndConferenceOnExit boolean

  Whether to end the conference when the agent leaves.

• From string

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

• Instruction string

  The assignment instruction for reservation.

• MaxParticipants integer

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

• Muted boolean

  Whether the agent is muted in the conference. The default is false.

• PostWorkActivitySid string

  The new worker activity SID after executing a Conference instruction.

  Minimum length is 34, maximum length is 34. Format should match the following pattern: ^WA[0-9a-fA-F]{32}$.

• Record boolean

  Whether to record the participant and their conferences, including the time between conferences. The default is false.

• RecordingChannels string

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

• RecordingStatusCallback string(uri)

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

• RecordingStatusCallbackMethod string(http-method)

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

  Values are HEAD, GET, POST, PATCH, PUT, or DELETE.

• RedirectAccept boolean

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

• RedirectCallSid string

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

  Minimum length is 34, maximum length is 34. Format should match the following pattern: ^CA[0-9a-fA-F]{32}$.

• RedirectUrl string(uri)

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

• Region string

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

• ReservationStatus string

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

  Values are pending, accepted, rejected, timeout, canceled, rescinded, wrapping, or completed.

• SipAuthPassword string

  The SIP password for authentication.

• SipAuthUsername string

  The SIP username used for authentication.

• StartConferenceOnEnter boolean

  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.

• StatusCallback string(uri)

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

• StatusCallbackEvent array[string]

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

  Values are initiated, ringing, answered, or completed.

• StatusCallbackMethod string(http-method)

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

  Values are HEAD, GET, POST, PATCH, PUT, or DELETE.

• Supervisor string

  The Supervisor SID/URI when executing the Supervise instruction.

• SupervisorMode string

  The Supervisor mode when executing the Supervise instruction.

  Values are monitor, whisper, or barge.

• Timeout integer

  Timeout for call when executing a Conference instruction.

• 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.

• WaitMethod string(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.

  Values are HEAD, GET, POST, PATCH, PUT, or DELETE.

• WaitUrl string(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.

• WorkerActivitySid string

  The new worker activity SID if rejecting a reservation.

  Minimum length is 34, maximum length is 34. Format should match the following pattern: ^WA[0-9a-fA-F]{32}$.