Api20100401Participant

Update the properties of the participant

Changed on

Update the properties of the participant

post/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 resources to update.

ConferenceSidstring required

The SID of the conference with the participant to update.

CallSidstring required

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

Request body application/x-www-form-urlencoded

Mutedboolean

Whether the participant should be muted. Can be true or false. true will mute the participant, and false will un-mute them. Anything value other than true or false is interpreted as false.

Holdboolean

Whether the participant should be on hold. Can be: true or false. true puts the participant on hold, and false lets them rejoin the conference.

HoldUrlstring uri

The URL we call using the hold_method for music that plays when the participant is on hold. The URL may return an MP3 file, a WAV file, or a TwiML document that contains <Play>, <Say>, <Pause>, or <Redirect> verbs.

HoldMethod'GET' | 'POST' http-method

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

AnnounceUrlstring uri

The URL we call using the announce_method for an announcement to the participant. The URL may return an MP3 file, a WAV file, or a TwiML document that contains <Play>, <Say>, <Pause>, or <Redirect> verbs.

AnnounceMethod'GET' | 'POST' http-method

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

WaitUrlstring uri

The URL that Twilio calls using the wait_method before the conference has started. The URL may return an MP3 file, a WAV file, or a TwiML document. The default value is the URL of our standard hold music. If you do not want anything to play while waiting for the conference to start, specify an empty string by setting wait_url to ''. For more details on the allowable verbs within the waitUrl, see the waitUrl attribute in the <Conference> TwiML instruction.

WaitMethod'GET' | 'POST' 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.

BeepOnExitboolean

Whether to play a notification beep to the conference when the participant exits. Can be: true or false.

EndConferenceOnExitboolean

Whether to end the conference when the participant leaves. Can be: true or false and defaults to false.

Coachingboolean

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.

CallSidToCoachstring

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.

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

    • breaking

      removed the enum value DELETE of the request property

    • breaking

      removed the enum value DELETE of the request property

    • breaking

      removed the enum value DELETE of the request property

    • breaking

      removed the enum value HEAD of the request property

    • breaking

      removed the enum value HEAD of the request property

    • breaking

      removed the enum value HEAD of the request property

    • breaking

      removed the enum value PATCH of the request property

    • breaking

      removed the enum value PATCH of the request property

    • breaking

      removed the enum value PATCH of the request property

    • breaking

      removed the enum value PUT of the request property

    • breaking

      removed the enum value PUT of the request property

    • breaking

      removed the enum value PUT of the request property

    • info

      added the optional property to the response with the status