public class ParticipantCreator extends Creator<Participant>
Constructor and Description |
---|
ParticipantCreator(String pathConferenceSid,
Endpoint from,
Endpoint to)
Construct a new ParticipantCreator.
|
ParticipantCreator(String pathAccountSid,
String pathConferenceSid,
Endpoint from,
Endpoint to)
Construct a new ParticipantCreator.
|
Modifier and Type | Method and Description |
---|---|
Participant |
create(TwilioRestClient client)
Make the request to the Twilio API to perform the create.
|
ParticipantCreator |
setBeep(String beep)
Whether to play a notification beep to the conference when the participant
joins.
|
ParticipantCreator |
setByoc(String byoc)
The SID of a BYOC (Bring Your Own Carrier) trunk to route this call with.
|
ParticipantCreator |
setCallerId(String callerId)
The phone number, Client identifier, or username portion of SIP address that
made this call.
|
ParticipantCreator |
setCallReason(String callReason)
The Reason for the outgoing call.
|
ParticipantCreator |
setCallSidToCoach(String callSidToCoach)
The SID of the participant who is being `coached`.
|
ParticipantCreator |
setCoaching(Boolean coaching)
Whether the participant is coaching another call.
|
ParticipantCreator |
setConferenceRecord(String conferenceRecord)
Whether to record the conference the participant is joining.
|
ParticipantCreator |
setConferenceRecordingStatusCallback(String conferenceRecordingStatusCallback)
The URL we should call using the
`conference_recording_status_callback_method` when the conference recording
is available..
|
ParticipantCreator |
setConferenceRecordingStatusCallback(URI conferenceRecordingStatusCallback)
The URL we should call using the
`conference_recording_status_callback_method` when the conference recording
is available..
|
ParticipantCreator |
setConferenceRecordingStatusCallbackEvent(List<String> conferenceRecordingStatusCallbackEvent)
The conference recording state changes that generate a call to
`conference_recording_status_callback`.
|
ParticipantCreator |
setConferenceRecordingStatusCallbackEvent(String conferenceRecordingStatusCallbackEvent)
The conference recording state changes that generate a call to
`conference_recording_status_callback`.
|
ParticipantCreator |
setConferenceRecordingStatusCallbackMethod(HttpMethod conferenceRecordingStatusCallbackMethod)
The HTTP method we should use to call `conference_recording_status_callback`.
|
ParticipantCreator |
setConferenceStatusCallback(String conferenceStatusCallback)
The URL we should call using the `conference_status_callback_method` when the
conference events in `conference_status_callback_event` occur.
|
ParticipantCreator |
setConferenceStatusCallback(URI conferenceStatusCallback)
The URL we should call using the `conference_status_callback_method` when the
conference events in `conference_status_callback_event` occur.
|
ParticipantCreator |
setConferenceStatusCallbackEvent(List<String> conferenceStatusCallbackEvent)
The conference state changes that should generate a call to
`conference_status_callback`.
|
ParticipantCreator |
setConferenceStatusCallbackEvent(String conferenceStatusCallbackEvent)
The conference state changes that should generate a call to
`conference_status_callback`.
|
ParticipantCreator |
setConferenceStatusCallbackMethod(HttpMethod conferenceStatusCallbackMethod)
The HTTP method we should use to call `conference_status_callback`.
|
ParticipantCreator |
setConferenceTrim(String conferenceTrim)
Whether to trim leading and trailing silence from your recorded conference
audio files.
|
ParticipantCreator |
setEarlyMedia(Boolean earlyMedia)
Whether to allow an agent to hear the state of the outbound call, including
ringing or disconnect messages.
|
ParticipantCreator |
setEndConferenceOnExit(Boolean endConferenceOnExit)
Whether to end the conference when the participant leaves.
|
ParticipantCreator |
setJitterBufferSize(String jitterBufferSize)
Jitter buffer size for the connecting participant.
|
ParticipantCreator |
setLabel(String label)
A label for this participant.
|
ParticipantCreator |
setMaxParticipants(Integer maxParticipants)
The maximum number of participants in the conference.
|
ParticipantCreator |
setMuted(Boolean muted)
Whether the agent is muted in the conference.
|
ParticipantCreator |
setRecord(Boolean record)
Whether to record the participant and their conferences, including the time
between conferences.
|
ParticipantCreator |
setRecordingChannels(String recordingChannels)
The recording channels for the final recording.
|
ParticipantCreator |
setRecordingStatusCallback(String recordingStatusCallback)
The URL that we should call using the `recording_status_callback_method` when
the recording status changes..
|
ParticipantCreator |
setRecordingStatusCallback(URI recordingStatusCallback)
The URL that we should call using the `recording_status_callback_method` when
the recording status changes..
|
ParticipantCreator |
setRecordingStatusCallbackEvent(List<String> recordingStatusCallbackEvent)
The recording state changes that should generate a call to
`recording_status_callback`.
|
ParticipantCreator |
setRecordingStatusCallbackEvent(String recordingStatusCallbackEvent)
The recording state changes that should generate a call to
`recording_status_callback`.
|
ParticipantCreator |
setRecordingStatusCallbackMethod(HttpMethod recordingStatusCallbackMethod)
The HTTP method we should use when we call `recording_status_callback`.
|
ParticipantCreator |
setRecordingTrack(String recordingTrack)
The audio track to record for the call.
|
ParticipantCreator |
setRegion(String region)
The region
where we should mix the recorded audio.
|
ParticipantCreator |
setSipAuthPassword(String sipAuthPassword)
The SIP password for authentication..
|
ParticipantCreator |
setSipAuthUsername(String sipAuthUsername)
The SIP username used for authentication..
|
ParticipantCreator |
setStartConferenceOnEnter(Boolean startConferenceOnEnter)
Whether to start the conference when the participant joins, if it has not
already started.
|
ParticipantCreator |
setStatusCallback(String statusCallback)
The URL we should call using the `status_callback_method` to send status
information to your application..
|
ParticipantCreator |
setStatusCallback(URI statusCallback)
The URL we should call using the `status_callback_method` to send status
information to your application..
|
ParticipantCreator |
setStatusCallbackEvent(List<String> statusCallbackEvent)
The conference state changes that should generate a call to
`status_callback`.
|
ParticipantCreator |
setStatusCallbackEvent(String statusCallbackEvent)
The conference state changes that should generate a call to
`status_callback`.
|
ParticipantCreator |
setStatusCallbackMethod(HttpMethod statusCallbackMethod)
The HTTP method we should use to call `status_callback`.
|
ParticipantCreator |
setTimeLimit(Integer timeLimit)
The maximum duration of the call in seconds.
|
ParticipantCreator |
setTimeout(Integer timeout)
The number of seconds that we should allow the phone to ring before assuming
there is no answer.
|
ParticipantCreator |
setWaitMethod(HttpMethod waitMethod)
The HTTP method we should use to call `wait_url`.
|
ParticipantCreator |
setWaitUrl(String waitUrl)
The URL we should call using the `wait_method` for the music to play while
participants are waiting for the conference to start.
|
ParticipantCreator |
setWaitUrl(URI waitUrl)
The URL we should call using the `wait_method` for the music to play while
participants are waiting for the conference to start.
|
create, createAsync, createAsync
public ParticipantCreator(String pathConferenceSid, Endpoint from, Endpoint to)
pathConferenceSid
- The SID of the participant's conferencefrom
- The phone number, Client identifier, or username portion of SIP
address that made this call.to
- The phone number, SIP address or Client identifier that received
this call.public ParticipantCreator(String pathAccountSid, String pathConferenceSid, Endpoint from, Endpoint to)
pathAccountSid
- The SID of the Account that will create the resourcepathConferenceSid
- The SID of the participant's conferencefrom
- The phone number, Client identifier, or username portion of SIP
address that made this call.to
- The phone number, SIP address or Client identifier that received
this call.public ParticipantCreator setStatusCallback(URI statusCallback)
statusCallback
- The URL we should call to send status information to
your applicationpublic ParticipantCreator setStatusCallback(String statusCallback)
statusCallback
- The URL we should call to send status information to
your applicationpublic ParticipantCreator setStatusCallbackMethod(HttpMethod statusCallbackMethod)
statusCallbackMethod
- The HTTP method we should use to call
`status_callback`public ParticipantCreator setStatusCallbackEvent(List<String> statusCallbackEvent)
statusCallbackEvent
- Set state change events that will trigger a
callbackpublic ParticipantCreator setStatusCallbackEvent(String statusCallbackEvent)
statusCallbackEvent
- Set state change events that will trigger a
callbackpublic ParticipantCreator setLabel(String label)
label
- The label of this participantpublic ParticipantCreator setTimeout(Integer timeout)
timeout
- he number of seconds that we should wait for an answerpublic ParticipantCreator setRecord(Boolean record)
record
- Whether to record the participant and their conferencespublic ParticipantCreator setMuted(Boolean muted)
muted
- Whether to mute the agentpublic ParticipantCreator setBeep(String beep)
beep
- Whether to play a notification beep to the conference when the
participant joinspublic ParticipantCreator setStartConferenceOnEnter(Boolean startConferenceOnEnter)
startConferenceOnEnter
- Whether the conference starts when the
participant joins the conferencepublic ParticipantCreator setEndConferenceOnExit(Boolean endConferenceOnExit)
endConferenceOnExit
- Whether to end the conference when the
participant leavespublic ParticipantCreator setWaitUrl(URI waitUrl)
waitUrl
- URL that hosts pre-conference hold musicpublic ParticipantCreator setWaitUrl(String waitUrl)
waitUrl
- URL that hosts pre-conference hold musicpublic ParticipantCreator setWaitMethod(HttpMethod waitMethod)
waitMethod
- The HTTP method we should use to call `wait_url`public ParticipantCreator setEarlyMedia(Boolean earlyMedia)
earlyMedia
- Whether agents can hear the state of the outbound callpublic ParticipantCreator setMaxParticipants(Integer maxParticipants)
maxParticipants
- The maximum number of agent conference participantspublic ParticipantCreator setConferenceRecord(String conferenceRecord)
conferenceRecord
- Whether to record the conference the participant is
joiningpublic ParticipantCreator setConferenceTrim(String conferenceTrim)
conferenceTrim
- Whether to trim leading and trailing silence from your
recorded conference audio filespublic ParticipantCreator setConferenceStatusCallback(URI conferenceStatusCallback)
conferenceStatusCallback
- The callback URL for conference eventspublic ParticipantCreator setConferenceStatusCallback(String conferenceStatusCallback)
conferenceStatusCallback
- The callback URL for conference eventspublic ParticipantCreator setConferenceStatusCallbackMethod(HttpMethod conferenceStatusCallbackMethod)
conferenceStatusCallbackMethod
- HTTP method for requesting
`conference_status_callback` URLpublic ParticipantCreator setConferenceStatusCallbackEvent(List<String> conferenceStatusCallbackEvent)
conferenceStatusCallbackEvent
- The conference state changes that
should generate a call to
`conference_status_callback`public ParticipantCreator setConferenceStatusCallbackEvent(String conferenceStatusCallbackEvent)
conferenceStatusCallbackEvent
- The conference state changes that
should generate a call to
`conference_status_callback`public ParticipantCreator setRecordingChannels(String recordingChannels)
recordingChannels
- Specify `mono` or `dual` recording channelspublic ParticipantCreator setRecordingStatusCallback(URI recordingStatusCallback)
recordingStatusCallback
- The URL that we should call using the
`recording_status_callback_method` when the
recording status changespublic ParticipantCreator setRecordingStatusCallback(String recordingStatusCallback)
recordingStatusCallback
- The URL that we should call using the
`recording_status_callback_method` when the
recording status changespublic ParticipantCreator setRecordingStatusCallbackMethod(HttpMethod recordingStatusCallbackMethod)
recordingStatusCallbackMethod
- The HTTP method we should use when we
call `recording_status_callback`public ParticipantCreator setSipAuthUsername(String sipAuthUsername)
sipAuthUsername
- The SIP username used for authenticationpublic ParticipantCreator setSipAuthPassword(String sipAuthPassword)
sipAuthPassword
- The SIP password for authenticationpublic ParticipantCreator setRegion(String region)
region
- The region where we should mix the conference audiopublic ParticipantCreator setConferenceRecordingStatusCallback(URI conferenceRecordingStatusCallback)
conferenceRecordingStatusCallback
- The URL we should call using the
`conference_recording_status_callback_method`
when the conference recording is
availablepublic ParticipantCreator setConferenceRecordingStatusCallback(String conferenceRecordingStatusCallback)
conferenceRecordingStatusCallback
- The URL we should call using the
`conference_recording_status_callback_method`
when the conference recording is
availablepublic ParticipantCreator setConferenceRecordingStatusCallbackMethod(HttpMethod conferenceRecordingStatusCallbackMethod)
conferenceRecordingStatusCallbackMethod
- The HTTP method we should use
to call
`conference_recording_status_callback`public ParticipantCreator setRecordingStatusCallbackEvent(List<String> recordingStatusCallbackEvent)
recordingStatusCallbackEvent
- The recording state changes that should
generate a call to
`recording_status_callback`public ParticipantCreator setRecordingStatusCallbackEvent(String recordingStatusCallbackEvent)
recordingStatusCallbackEvent
- The recording state changes that should
generate a call to
`recording_status_callback`public ParticipantCreator setConferenceRecordingStatusCallbackEvent(List<String> conferenceRecordingStatusCallbackEvent)
conferenceRecordingStatusCallbackEvent
- The conference recording state
changes that should generate a
call to
`conference_recording_status_callback`public ParticipantCreator setConferenceRecordingStatusCallbackEvent(String conferenceRecordingStatusCallbackEvent)
conferenceRecordingStatusCallbackEvent
- The conference recording state
changes that should generate a
call to
`conference_recording_status_callback`public ParticipantCreator setCoaching(Boolean coaching)
coaching
- Indicates if the participant changed to coachpublic ParticipantCreator setCallSidToCoach(String callSidToCoach)
callSidToCoach
- The SID of the participant who is being `coached`public ParticipantCreator setJitterBufferSize(String jitterBufferSize)
jitterBufferSize
- Jitter Buffer size for the connecting participantpublic ParticipantCreator setByoc(String byoc)
byoc
- BYOC trunk SID (Beta)public ParticipantCreator setCallerId(String callerId)
callerId
- The phone number, Client identifier, or username portion of
SIP address that made this call.public ParticipantCreator setCallReason(String callReason)
callReason
- Reason for the call (Branded Calls Beta)public ParticipantCreator setRecordingTrack(String recordingTrack)
recordingTrack
- The track(s) to recordpublic ParticipantCreator setTimeLimit(Integer timeLimit)
timeLimit
- The maximum duration of the call in seconds.public Participant create(TwilioRestClient client)
create
in class Creator<Participant>
client
- TwilioRestClient with which to make the requestCopyright © 2019 Twilio, Inc. All Rights Reserved.