Skip to main content

Update a conference participant

POST 
/texml/Accounts/:account_sid/Conferences/:conference_sid/Participants/:call_sid

Updates a conference participant

Request ​

Path Parameters

    account_sid stringrequired

    The id of the account the resource belongs to.

    conference_sid stringrequired

    The ConferenceSid that uniquely identifies a conference.

    call_sid stringrequired

    The CallSid that identifies the call to update.

Body

required

Update Conference Participant request object

    Muted boolean

    Whether the participant should be muted.

    Hold boolean

    Whether the participant should be on hold.

    HoldUrl string

    The URL to be called using the HoldMethod 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

    Possible values: [GET, POST]

    The HTTP method to use when calling the HoldUrl.

    AnnounceUrl string

    The URL to call to announce something to the participant. The URL may return an MP3 fileo a WAV file, or a TwiML document that contains <Play>, <Say>, <Pause>, or <Redirect> verbs.

    AnnounceMethod string

    Possible values: [GET, POST]

    The HTTP method used to call the AnnounceUrl. Defaults to POST.

    WaitUrl string

    The URL to call for an audio file to play while the participant is waiting for the conference to start.

    BeepOnExit boolean

    Whether to play a notification beep to the conference when the participant exits.

    EndConferenceOnExit boolean

    Whether to end the conference when the participant leaves.

    Coaching boolean

    Whether the participant is coaching another call. When true, CallSidToCoach has to be given.

    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.

Responses ​

200: Participant resource.

Schema

    account_sid string

    The id of the account the resource belongs to.

    api_version string

    The version of the API that was used to make the request.

    call_sid string

    The identifier of this participant's call.

    call_sid_legacy string

    The identifier of this participant's call.

    coaching boolean

    Whether the participant is coaching another call.

    coaching_call_sid string

    The identifier of the coached participant's call.

    coaching_call_sid_legacy string

    The identifier of the coached participant's call.

    date_created string

    The timestamp of when the resource was created.

    date_updated string

    The timestamp of when the resource was last updated.

    end_conference_on_exit boolean

    Whether the conference ends when the participant leaves.

    hold boolean

    Whether the participant is on hold.

    muted boolean

    Whether the participant is muted.

    status string

    Possible values: [connecting, connected, completed]

    The status of the participant's call in the conference.

    uri string

    The relative URI for this participant.

404: Resource not found

Schema

    errors

    object[]

  • Array [

    • detail string

  • ]

Request samples

curl -L -X POST 'https://api.telnyx.com/v2/texml/Accounts/:account_sid/Conferences/:conference_sid/Participants/:call_sid' \
-H 'Content-Type: application/x-www-form-urlencoded' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Response samples

{
  "account_sid": "4e71926f-8f13-450e-b91c-23c2ef786aa6",
  "api_version": "v2/texml",
  "call_sid": "v3:9X2vxPDFY2RHSJ1EdMS0RHRksMTg7ldNxdjWbVr9zBjbGjGsSe-aiQ",
  "call_sid_legacy": "v3:9X2vxPDFY2RHSJ1EdMS0RHRksMTg7ldNxdjWbVr9zBjbGjGsSe-aiQ",
  "coaching": false,
  "coaching_call_sid": null,
  "coaching_call_sid_legacy": null,
  "conference_sid": "cd5a70f4-759b-4d5e-9c06-88c00f16f3c1",
  "date_created": "Fri, 27 Oct 2023 07:41:58 +0000",
  "date_updated": "Fri, 27 Oct 2023 07:41:58 +0000",
  "end_conference_on_exit": false,
  "hold": false,
  "muted": false,
  "status": "completed",
  "uri": "/v2/texml/Accounts/4e71926f-8f13-450e-b91c-23c2ef786aa6/Conferences/cd5a70f4-759b-4d5e-9c06-88c00f16f3c1/Participants/v3:9X2vxPDFY2RHSJ1EdMS0RHRksMTg7ldNxdjWbVr9zBjbGjGsSe-aiQ.json"
}