Update the properties of the participant

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

Account sid auth token

Conference participants

Path parameters

AccountSid string Required

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

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

The SID of the conference with the participant to update.

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

application/x-www-form-urlencoded

Body

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.
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.
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 <Play>, <Say>, <Pause>, or <Redirect> verbs.
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 GET or POST.
AnnounceUrl string(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 string(http-method)

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

Values are GET or POST.
WaitUrl string(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 TwiML instruction.
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 GET or POST.
BeepOnExit boolean

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

Whether to end the conference when the participant leaves. Can be: true or false and defaults to false.
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.
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}$.

Responses

200 application/json

OK
Hide headers attributes Show headers attributes
- Access-Control-Allow-Origin string
  
  Specify the origin(s) allowed to access the resource
- Access-Control-Allow-Methods string
  
  Specify the HTTP methods allowed when accessing the resource
- Access-Control-Allow-Headers string
  
  Specify the headers allowed when accessing the resource
- Access-Control-Allow-Credentials boolean
  
  Indicates whether the browser should include credentials
- Access-Control-Expose-Headers string
  
  Headers exposed to the client
Hide response attributes Show response attributes object
- account_sid string | null
  
  The SID of the Account that created the Participant 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 Participant resource is associated with.
  
  Minimum length is 34, maximum length is 34. Format should match the following pattern: ^CA[0-9a-fA-F]{32}$.
- label string | null
  
  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_coach string | null
  
  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 | null
  
  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_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 date and time in GMT that the resource was created specified in RFC 2822 format.
- date_updated string(date-time-rfc-2822) | null
  
  The date and time in GMT that the resource was last updated specified in RFC 2822 format.
- end_conference_on_exit boolean | null
  
  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.
- muted boolean | null
  
  Whether the participant is muted. Can be true or false.
- hold boolean | null
  
  Whether the participant is on hold. Can be true or false.
- start_conference_on_enter boolean | null
  
  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 string
  
  The status of the participant's call in a session. Can be: queued, connecting, ringing, connected, complete, or failed.
  
  Values are queued, connecting, ringing, connected, complete, or failed.
- queue_time string | null
  
  The wait time in milliseconds before participant's call is placed. Only available in the response to a create participant request.
- 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 \
 --request POST 'https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/Conferences/{ConferenceSid}/Participants/{CallSid}.json' \
 --user "username:password" \
 --header "Content-Type: application/x-www-form-urlencoded" \
 --data 'Muted=true'

Request examples

{"Muted"=>"true"}

{"Muted"=>"true"}

{"Hold"=>"true", "HoldUrl"=>"http://www.myapp.com/hold"}

{"AnnounceUrl"=>"http://www.myapp.com/announce"}

{"Coaching"=>true, "CallSidToCoach"=>"CAbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb"}

{"Coaching"=>true, "CallSidToCoach"=>"CAbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb"}

Response examples (200)

{
  "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json",
  "hold": false,
  "label": null,
  "muted": true,
  "status": "connected",
  "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "coaching": false,
  "queue_time": null,
  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "date_created": "Fri, 18 Feb 2011 21:07:19 +0000",
  "date_updated": "Fri, 18 Feb 2011 21:07:19 +0000",
  "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "call_sid_to_coach": null,
  "end_conference_on_exit": false,
  "start_conference_on_enter": true
}

{
  "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json",
  "hold": false,
  "label": "customer",
  "muted": true,
  "status": "connected",
  "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "coaching": false,
  "queue_time": null,
  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "date_created": "Fri, 18 Feb 2011 21:07:19 +0000",
  "date_updated": "Fri, 18 Feb 2011 21:07:19 +0000",
  "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "call_sid_to_coach": null,
  "end_conference_on_exit": false,
  "start_conference_on_enter": true
}

{
  "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json",
  "hold": true,
  "label": null,
  "muted": false,
  "status": "connected",
  "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "coaching": false,
  "queue_time": null,
  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "date_created": "Fri, 18 Feb 2011 21:07:19 +0000",
  "date_updated": "Fri, 18 Feb 2011 21:07:19 +0000",
  "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "call_sid_to_coach": null,
  "end_conference_on_exit": false,
  "start_conference_on_enter": true
}

{
  "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json",
  "hold": false,
  "label": null,
  "muted": false,
  "status": "connected",
  "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "coaching": false,
  "queue_time": null,
  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "date_created": "Fri, 18 Feb 2011 21:07:19 +0000",
  "date_updated": "Fri, 18 Feb 2011 21:07:19 +0000",
  "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "call_sid_to_coach": null,
  "end_conference_on_exit": false,
  "start_conference_on_enter": true
}

{
  "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json",
  "hold": false,
  "label": null,
  "muted": false,
  "status": "complete",
  "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "coaching": true,
  "queue_time": null,
  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "date_created": "Fri, 18 Feb 2011 21:07:19 +0000",
  "date_updated": "Fri, 18 Feb 2011 21:07:19 +0000",
  "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "call_sid_to_coach": "CAbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb",
  "end_conference_on_exit": false,
  "start_conference_on_enter": true
}

{
  "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json",
  "hold": false,
  "label": "customer",
  "muted": false,
  "status": "complete",
  "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "coaching": true,
  "queue_time": null,
  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "date_created": "Fri, 18 Feb 2011 21:07:19 +0000",
  "date_updated": "Fri, 18 Feb 2011 21:07:19 +0000",
  "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "call_sid_to_coach": "CAbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb",
  "end_conference_on_exit": false,
  "start_conference_on_enter": true
}