Skip to main content

Get conference participant resource

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

Gets conference participant resource

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.

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 'https://api.telnyx.com/v2/texml/Accounts/:account_sid/Conferences/:conference_sid/Participants/:call_sid' \
-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"
}