Skip to main content

List conference resources

GET 
/texml/Accounts/:account_sid/Conferences

Lists conference resources.

Request​

Path Parameters

    account_sid stringrequired

    The id of the account the resource belongs to.

Query Parameters

    Page integer

    The number of the page to be displayed, zero-indexed, should be used in conjuction with PageToken.

    Example: 1
    PageSize integer

    The number of records to be displayed on a page

    Example: 10
    PageToken string

    Used to request the next page of results.

    FriendlyName string

    Filters conferences by their friendly name.

    Example: weekly_review_call
    Status string

    Possible values: [init, in-progress, completed]

    Filters conferences by status.

    Example: in-progress
    DateCreated string

    Filters conferences by the creation date. Expected format is YYYY-MM-DD. Also accepts inequality operators, e.g. DateCreated>=2023-05-22.

    Example: >=2023-05-22
    DateUpdated string

    Filters conferences by the time they were last updated. Expected format is YYYY-MM-DD. Also accepts inequality operators, e.g. DateUpdated>=2023-05-22.

    Example: >=2023-05-22

Responses​

200: Multiple conference resources.

Schema

    conferences

    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_ending_conference string

    Caller ID, if present.

    date_created string

    The timestamp of when the resource was created.

    date_updated string

    The timestamp of when the resource was last updated.

    friendly_name string

    A string that you assigned to describe this conference room.

    reason_conference_ended string

    Possible values: [participant-with-end-conference-on-exit-left, last-participant-left, conference-ended-via-api, time-exceeded]

    The reason why a conference ended. When a conference is in progress, will be null.

    region string

    A string representing the region where the conference is hosted.

    sid string

    The unique identifier of the conference.

    status string

    Possible values: [init, in-progress, completed]

    The status of this conference.

    subresource_uris object

    A list of related resources identified by their relative URIs.

    uri string

    The relative URI for this conference.

  • ]

    • 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.json?Page=0&PageSize=1

    next_page_uri string

    /v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Conferences.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.

404: Resource not found

Schema

    errors

    object[]

  • Array [

    • detail string

  • ]

Request samples

curl -L 'https://api.telnyx.com/v2/texml/Accounts/:account_sid/Conferences' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Response samples

{
  "conferences": [],
  "end": 0,
  "first_page_uri": "/v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Conferences.json?Page=0&PageSize=1",
  "next_page_uri": "/v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Conferences.json?Page=1&PageSize=1&PageToken=MTY4AjgyNDkwNzIxMQ",
  "page": 0,
  "page_size": 1,
  "start": 0,
  "uri": "/v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Conferences.json?Page=0&PageSize=1"
}