Update the properties of the participant

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

Conference participants

Update the properties of the participant

Path parameters

  • AccountSid string Required

    The SID of the Account that created the Participant resources to update.

  • ConferenceSid string Required

    The SID of the conference with the participant to update.

  • CallSid string 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.

Body

  • AnnounceMethod string(http-method)

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

    Values are HEAD, GET, POST, PATCH, PUT, or DELETE.

  • AnnounceUrl string(uri)

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

  • BeepOnExit boolean

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

  • CallSidToCoach string

    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.

    Minimum length is 34, maximum length is 34. Format should match the following pattern: ^CA[0-9a-fA-F]{32}$.

  • Coaching boolean

    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.

  • EndConferenceOnExit boolean

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

  • Hold boolean

    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.

  • HoldMethod string(http-method)

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

    Values are HEAD, GET, POST, PATCH, PUT, or DELETE.

  • HoldUrl string(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 the <Play>, <Say> or <Redirect> commands.

  • Muted boolean

    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.

  • WaitMethod string(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.

    Values are HEAD, GET, POST, PATCH, PUT, or DELETE.

  • WaitUrl string(uri)

    The URL we should call using the wait_method for the music to play while participants are waiting for the conference to start. The default value is the URL of our standard hold music. Learn more about hold music.

Responses

  • 200

    OK

    Hide response attributes Show response attributes object
    • account_sid string | null

      The SID of the Account that created the resource

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AC[0-9a-fA-F]{32}$.

    • call_sid string | null

      The SID of the Call the resource is associated with

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^CA[0-9a-fA-F]{32}$.

    • call_sid_to_coach string | null

      The SID of the participant who is being coached

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^CA[0-9a-fA-F]{32}$.

    • coaching boolean | null

      Indicates if the participant changed to coach

    • conference_sid string | null

      The SID of the conference the participant is in

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^CF[0-9a-fA-F]{32}$.

    • date_created string(date-time-rfc-2822) | null

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

    • date_updated string(date-time-rfc-2822) | null

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

    • end_conference_on_exit boolean | null

      Whether the conference ends when the participant leaves

    • hold boolean | null

      Whether the participant is on hold

    • label string | null

      The label of this participant

    • muted boolean | null

      Whether the participant is muted

    • start_conference_on_enter boolean | null

      Whether the conference starts when the participant joins the conference

    • status string | null

      The status of the participant's call in a session

      Values are queued, connecting, ringing, connected, complete, or failed.

    • uri string | null

      The URI of the resource, relative to https://api.twilio.com
POST /2010-04-01/Accounts/{AccountSid}/Conferences/{ConferenceSid}/Participants/{CallSid}.json 
curl \
 -X POST https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/Conferences/{ConferenceSid}/Participants/{CallSid}.json \
 --user "username:password" \
 -H "Content-Type: application/x-www-form-urlencoded" \
 -d 'AnnounceMethod=HEAD&AnnounceUrl=https%3A%2F%2Fexample.com&BeepOnExit=true&CallSidToCoach=string&Coaching=true&EndConferenceOnExit=true&Hold=true&HoldMethod=HEAD&HoldUrl=https%3A%2F%2Fexample.com&Muted=true&WaitMethod=HEAD&WaitUrl=https%3A%2F%2Fexample.com'
Request example 
{
  "AnnounceMethod": "HEAD",
  "AnnounceUrl": "https://example.com",
  "BeepOnExit": true,
  "CallSidToCoach": "string",
  "Coaching": true,
  "EndConferenceOnExit": true,
  "Hold": true,
  "HoldMethod": "HEAD",
  "HoldUrl": "https://example.com",
  "Muted": true,
  "WaitMethod": "HEAD",
  "WaitUrl": "https://example.com"
}
Request examples 
{
  "AnnounceMethod": "HEAD",
  "AnnounceUrl": "https://example.com",
  "BeepOnExit": true,
  "CallSidToCoach": "string",
  "Coaching": true,
  "EndConferenceOnExit": true,
  "Hold": true,
  "HoldMethod": "HEAD",
  "HoldUrl": "https://example.com",
  "Muted": true,
  "WaitMethod": "HEAD",
  "WaitUrl": "https://example.com"
}
Response examples (200) 
{
  "account_sid": "string",
  "call_sid": "string",
  "call_sid_to_coach": "string",
  "coaching": true,
  "conference_sid": "string",
  "date_created": "string",
  "date_updated": "string",
  "end_conference_on_exit": true,
  "hold": true,
  "label": "string",
  "muted": true,
  "start_conference_on_enter": true,
  "status": "queued",
  "uri": "string"
}
Response examples (200) 
{
  "account_sid": "string",
  "call_sid": "string",
  "call_sid_to_coach": "string",
  "coaching": true,
  "conference_sid": "string",
  "date_created": "string",
  "date_updated": "string",
  "end_conference_on_exit": true,
  "hold": true,
  "label": "string",
  "muted": true,
  "start_conference_on_enter": true,
  "status": "queued",
  "uri": "string"
}