Class: ParticipantInstance

Twilio.Api.V2010.AccountContext.ConferenceContext.ParticipantInstance(version, payload, accountSid, conferenceSid, callSid)

new ParticipantInstance(version, payload, accountSid, conferenceSid, callSid)

Initialize the ParticipantContext
Parameters:
Name Type Description
version V2010 Version of the resource
payload ParticipantPayload The instance payload
accountSid sid The SID of the Account that created the resource
conferenceSid sid The SID of the conference the participant is in
callSid sid_like The Call SID or URL encoded label of the participant to fetch
Properties:
Name Type Description
accountSid string The SID of the Account that created the resource
callSid string The SID of the Call the resource is associated with
label string The label of this participant
callSidToCoach string The SID of the participant who is being `coached`
coaching boolean Indicates if the participant changed to coach
conferenceSid string The SID of the conference the participant is in
dateCreated Date The RFC 2822 date and time in GMT that the resource was created
dateUpdated Date The RFC 2822 date and time in GMT that the resource was last updated
endConferenceOnExit boolean Whether the conference ends when the participant leaves
muted boolean Whether the participant is muted
hold boolean Whether the participant is on hold
startConferenceOnEnter boolean Whether the conference starts when the participant joins the conference
status participant.status The status of the participant's call in a session
uri string The URI of the resource, relative to `https://api.twilio.com`
Source:

Methods

fetch(callbackopt) → {Promise}

fetch a ParticipantInstance
Parameters:
Name Type Attributes Description
callback function <optional>
 Callback to handle processed record
Source:
Returns:
Resolves to processed ParticipantInstance
Type
Promise

remove(callbackopt) → {Promise}

remove a ParticipantInstance
Parameters:
Name Type Attributes Description
callback function <optional>
 Callback to handle processed record
Source:
Returns:
Resolves to processed ParticipantInstance
Type
Promise

toJSON()

Provide a user-friendly representation
Source:
Returns:
Object

update(optsopt, callbackopt) → {Promise}

update a ParticipantInstance
Parameters:
Name Type Attributes Description
opts object <optional>
 Options for request
Properties
Name Type Attributes Description
muted boolean <optional>
 Whether the participant should be muted
hold boolean <optional>
 Whether the participant should be on hold
holdUrl string <optional>
 The URL we call using the `hold_method` for music that plays when the participant is on hold
holdMethod string <optional>
 The HTTP method we should use to call hold_url
announceUrl string <optional>
 The URL we call using the `announce_method` for an announcement to the participant
announceMethod string <optional>
 The HTTP method we should use to call announce_url
waitUrl string <optional>
 URL that hosts pre-conference hold music
waitMethod string <optional>
 The HTTP method we should use to call `wait_url`
beepOnExit boolean <optional>
 Whether to play a notification beep to the conference when the participant exit
endConferenceOnExit boolean <optional>
 Whether to end the conference when the participant leaves
coaching boolean <optional>
 Indicates if the participant changed to coach
callSidToCoach string <optional>
 The SID of the participant who is being `coached`
callback function <optional>
 Callback to handle processed record
Source:
Returns:
Resolves to processed ParticipantInstance
Type
Promise