TWtwilio
Api20100401Participant

Fetch an instance of a participant

Changed on

Fetch an instance of a participant

get/2010-04-01/Accounts/{AccountSid}/Conferences/{ConferenceSid}/Participants/{CallSid}.json

Request

  • Base URL
    https://api.twilio.com
  • URL
    https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/Conferences/{ConferenceSid}/Participants/{CallSid}.json
  • Auth
    HTTP basic

Path parameters

AccountSidstring required

The SID of the Account that created the Participant resource to fetch.

ConferenceSidstring required

The SID of the conference with the participant to fetch.

CallSidstring required

The Call SID or label of the participant to fetch. Non URL safe characters in a label must be percent encoded, for example, a space character is represented as %20.

Response

OK

account_sidstring nullable

The SID of the Account that created the Participant resource.

call_sidstring nullable

The SID of the Call the Participant resource is associated with.

labelstring nullable

The user-specified label of this participant, if one was given when the participant was created. This may be used to fetch, update or delete the participant.

call_sid_to_coachstring nullable

The SID of the participant who is being coached. The participant being coached is the only participant who can hear the participant who is coaching.

coachingboolean nullable

Whether the participant is coaching another call. Can be: true or false. If not present, defaults to false unless call_sid_to_coach is defined. If true, call_sid_to_coach must be defined.

conference_sidstring nullable

The SID of the conference the participant is in.

date_createdstring date-time-rfc-2822 nullable

The date and time in GMT that the resource was created specified in RFC 2822 format.

date_updatedstring date-time-rfc-2822 nullable

The date and time in GMT that the resource was last updated specified in RFC 2822 format.

end_conference_on_exitboolean nullable

Whether the conference ends when the participant leaves. Can be: true or false and the default is false. If true, the conference ends and all other participants drop out when the participant leaves.

mutedboolean nullable

Whether the participant is muted. Can be true or false.

holdboolean nullable

Whether the participant is on hold. Can be true or false.

start_conference_on_enterboolean nullable

Whether the conference starts when the participant joins the conference, if it has not already started. Can be: true or false and 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.

status'queued' | 'connecting' | 'ringing' | 'connected' | 'complete' | 'failed'

The status of the participant's call in a session. Can be: queued, connecting, ringing, connected, complete, or failed.

queue_timestring nullable

The wait time in milliseconds before participant's call is placed. Only available in the response to a create participant request.

uristring nullable

The URI of the resource, relative to https://api.twilio.com.

Changes