+
+
+
+
+ to |
+
+
+
+
+
+string
+
+
+
+
+ |
+
+
+
+
+ <optional>
+
+
+
+ |
+
+
+
+
+
+ null
+
+ |
+
+
+ The contact uri of the Worker; can be a phone
+number or a client ID. Required, if no contact_uri on the Worker's attributes. |
+
+
+
+
+
+
+ from |
+
+
+
+
+
+string
+
+
+
+
+ |
+
+
+
+
+ <optional>
+
+
+
+ |
+
+
+
+
+
+ null
+
+ |
+
+
+ The caller id for the call to the Worker.
+Must be a verified Twilio number. |
+
+
+
+
+
+
+ timeout |
+
+
+
+
+
+int
+
+
+
+
+ |
+
+
+
+
+ <optional>
+
+
+
+ |
+
+
+
+
+
+ 60
+
+ |
+
+
+ The integer number of seconds that
+Twilio should allow the call to ring before assuming there is no answer. |
+
+
+
+
+
+
+ statusCallback |
+
+
+
+
+
+string
+
+
+
+
+ |
+
+
+
+
+ <optional>
+
+
+
+ |
+
+
+
+
+
+ null
+
+ |
+
+
+ The URL endpoint to receive call status events of the Worker leg. |
+
+
+
+
+
+
+ statusCallbackMethod |
+
+
+
+
+
+string
+
+
+
+
+ |
+
+
+
+
+ <optional>
+
+
+
+ |
+
+
+
+
+
+ 'POST'
+
+ |
+
+
+ The HTTP method for the Status Callback URL. |
+
+
+
+
+
+
+ statusCallbackEvent |
+
+
+
+
+
+string
+
+
+
+
+ |
+
+
+
+
+ <optional>
+
+
+
+ |
+
+
+
+
+
+ 'completed'
+
+ |
+
+
+ A comma separated list of events to subscribe to.
+The possible list of events are: ['initiated', 'ringing', 'answered', 'completed']. |
+
+
+
+
+
+
+ record |
+
+
+
+
+
+string
+
+
+
+
+ |
+
+
+
+
+ <optional>
+
+
+
+ |
+
+
+
+
+
+ 'do-not-record'
+
+ |
+
+
+ Whether to record the Worker leg of the Conference. |
+
+
+
+
+
+
+ muted |
+
+
+
+
+
+boolean
+
+
+
+
+ |
+
+
+
+
+ <optional>
+
+
+
+ |
+
+
+
+
+
+ false
+
+ |
+
+
+ Whether the Worker leg of the Conference is muted. |
+
+
+
+
+
+
+ beep |
+
+
+
+
+
+string
+|
+
+boolean
+
+
+
+
+ |
+
+
+
+
+ <optional>
+
+
+
+ |
+
+
+
+
+
+ true
+
+ |
+
+
+ Whether the Worker leg should be when entering the Conference.
+The options for beep are: [true, false, 'onEnter', 'onExit']. |
+
+
+
+
+
+
+ startConferenceOnEnter |
+
+
+
+
+
+boolean
+
+
+
+
+ |
+
+
+
+
+ <optional>
+
+
+
+ |
+
+
+
+
+
+ true
+
+ |
+
+
+ Whether the Conference should start when the Worker leg enters. |
+
+
+
+
+
+
+ endConferenceOnExit |
+
+
+
+
+
+boolean
+
+
+
+
+ |
+
+
+
+
+ <optional>
+
+
+
+ |
+
+
+
+
+
+ false
+
+ |
+
+
+ Whether the Conference should end when the Worker leg exits. |
+
+
+
+
+
+
+ endConferenceOnCustomerExit |
+
+
+
+
+
+boolean
+
+
+
+
+ |
+
+
+
+
+ <optional>
+
+
+
+ |
+
+
+
+
+
+ false
+
+ |
+
+
+ Whether the Conference should end when the customer leg exits. |
+
+
+
+
+
+
+ beepOnCustomerEntrance |
+
+
+
+
+
+boolean
+
+
+
+
+ |
+
+
+
+
+ <optional>
+
+
+
+ |
+
+
+
+
+
+ true
+
+ |
+
+
+ Whether the Conference should beep when the customer leg enters. |
+
+
+
+
+
+
+ waitUrl |
+
+
+
+
+
+string
+
+
+
+
+ |
+
+
+
+
+ <optional>
+
+
+
+ |
+
+
+
+
+
+ default Twilio hold music
+
+ |
+
+
+ The URL endpoint to play when waiting for the Conference to begin. |
+
+
+
+
+
+
+ waitMethod |
+
+
+
+
+
+string
+
+
+
+
+ |
+
+
+
+
+ <optional>
+
+
+
+ |
+
+
+
+
+
+ 'POST'
+
+ |
+
+
+ The HTTP method for the Wait URL. |
+
+
+
+
+
+
+ earlyMedia |
+
+
+
+
+
+boolean
+
+
+
+
+ |
+
+
+
+
+ <optional>
+
+
+
+ |
+
+
+
+
+
+ true
+
+ |
+
+
+ Whether Twilio should feed early media to be played directly into a Conference. |
+
+
+
+
+
+
+ maxParticipants |
+
+
+
+
+
+int
+
+
+
+
+ |
+
+
+
+
+ <optional>
+
+
+
+ |
+
+
+
+
+
+ 10
+
+ |
+
+
+ The number of max participants allowed in a Conference. |
+
+
+
+
+
+
+ conferenceStatusCallback |
+
+
+
+
+
+string
+
+
+
+
+ |
+
+
+
+
+ <optional>
+
+
+
+ |
+
+
+
+
+
+ null
+
+ |
+
+
+ The URL endpoint to receive Conference status events. |
+
+
+
+
+
+
+ conferenceStatusCallbackMethod |
+
+
+
+
+
+string
+
+
+
+
+ |
+
+
+
+
+ <optional>
+
+
+
+ |
+
+
+
+
+
+ 'POST'
+
+ |
+
+
+ The HTTP method for the Conference Status Callback URL. |
+
+
+
+
+
+
+ conferenceStatusCallbackEvent |
+
+
+
+
+
+string
+
+
+
+
+ |
+
+
+
+
+ <optional>
+
+
+
+ |
+
+
+
+
+
+ 'start,end'
+
+ |
+
+
+ A comma separated list of Conference events to subscribe to.
+The possible list of events are: ['start', 'end', 'join', 'leave', 'mute', 'hold', 'speaker']. |
+
+
+
+
+
+
+ conferenceRecord |
+
+
+
+
+
+string
+|
+
+boolean
+
+
+
+
+ |
+
+
+
+
+ <optional>
+
+
+
+ |
+
+
+
+
+
+ false
+
+ |
+
+
+ Whether the entire Conference should be recorded.
+The possible options for conferenceRecord are: [true, false, 'record-from-start', 'do-not-record']. |
+
+
+
+
+
+
+ conferenceTrim |
+
+
+
+
+
+string
+
+
+
+
+ |
+
+
+
+
+ <optional>
+
+
+
+ |
+
+
+
+
+
+ 'trim-silence'
+
+ |
+
+
+ Whether to trim the Conference recording.
+The options for conferenceTrim are: ['trim-silence', 'do-not-trim']. |
+
+
+
+
+
+
+ recordingChannels |
+
+
+
+
+
+string
+
+
+
+
+ |
+
+
+
+
+ <optional>
+
+
+
+ |
+
+
+
+
+
+ 'mono'
+
+ |
+
+
+ Which channel of the Conference to record. The options are: ['mono', 'dual']. |
+
+
+
+
+
+
+ recordingStatusCallback |
+
+
+
+
+
+string
+
+
+
+
+ |
+
+
+
+
+ <optional>
+
+
+
+ |
+
+
+
+
+
+ null
+
+ |
+
+
+ The URL endpoint to receive recording status events. |
+
+
+
+
+
+
+ recordingStatusCallbackMethod |
+
+
+
+
+
+string
+
+
+
+
+ |
+
+
+
+
+ <optional>
+
+
+
+ |
+
+
+
+
+
+ 'POST'
+
+ |
+
+
+ The HTTP method for the Recording Status Callback URL. |
+
+
+
+
+
+
+ conferenceRecordingStatusCallback |
+
+
+
+
+
+string
+
+
+
+
+ |
+
+
+
+
+ <optional>
+
+
+
+ |
+
+
+
+
+
+ null
+
+ |
+
+
+ The URl endpoint to receive Conference events. |
+
+
+
+
+
+
+ conferenceRecordingStatusCallbackMethod |
+
+
+
+
+
+string
+
+
+
+
+ |
+
+
+
+
+ <optional>
+
+
+
+ |
+
+
+
+
+
+ 'POST'
+
+ |
+
+
+ The HTTP method of the Conference Recording Status Callback. |
+
+
+
+
+
+
+ region |
+
+
+
+
+
+string
+
+
+
+
+ |
+
+
+
+
+ <optional>
+
+
+
+ |
+
+
+
+
+
+ null
+
+ |
+
+
+ The specific region. The options for region are: ['us1', 'ie1', 'sg1', 'br1', 'au1', 'jp1']. |
+
+
+
+
+
+
+ sipAuthUsername |
+
+
+
+
+
+string
+
+
+
+
+ |
+
+
+
+
+ <optional>
+
+
+
+ |
+
+
+
+
+
+ null
+
+ |
+
+
+ The SIP auth username to use. |
+
+
+
+
+
+
+ sipAuthPassword |
+
+
+
+
+
+string
+
+
+
+
+ |
+
+
+
+
+ <optional>
+
+
+
+ |
+
+
+
+
+
+ null
+
+ |
+
+
+ The SIP auth password to use. |
+
+
+
+
+
