List conference participants

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

Lists conference participants

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.

Responses

200: Multiple participant resources.

application/json

• Schema
• Example (from schema)

Schema

data

object

participants

object[]

Array [

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.

]

end integer

The number of the last element on the page, zero-indexed.

first_page_uri string

/v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Conferences/6dc6cc1a-1ba1-4351-86b8-4c22c95cd98f/Participants.json?page=0&pagesize=20

next_page_uri string

/v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Conferences/6dc6cc1a-1ba1-4351-86b8-4c22c95cd98f/Participants.json?Page=1&PageSize=1&PageToken=MTY4AjgyNDkwNzIxMQ

page integer

Current page number, zero-indexed.

page_size integer

The number of items on the page

start integer

The number of the first element on the page, zero-indexed.

uri string

The URI of the current page.

{
  "data": {
    "participants": [],
    "end": 0,
    "first_page_uri": "/v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Conferences/6dc6cc1a-1ba1-4351-86b8-4c22c95cd98f/Participants.json?page=0&pagesize=20",
    "next_page_uri": null,
    "page": 0,
    "page_size": 20,
    "start": 0,
    "uri": "/v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Conferences/6dc6cc1a-1ba1-4351-86b8-4c22c95cd98f/Participants.json?page=0&pagesize=20"
  }
}

404: Resource not found

application/json

• Schema
• Example (from schema)

Schema

data

object

errors

object[]

Array [

detail string

]

{
  "data": {
    "errors": [
      {
        "detail": "Resource not found"
      }
    ]
  }
}

Loading...