Skip to main content

List all conferences

GET 
/conferences

Lists conferences belonging to the user. Conferences are created on demand, and will expire after all participants have left the conference or after 4 hours regardless of the number of active participants.

Request ​

Query Parameters

    name string

    If present, conferences will be filtered to those with a matching name attribute. Matching is case-sensitive

    page[page] integer

    Default value: 1

    Page number of results to load

    page[page_size] integer

    Possible values: <= 1000

    Default value: 20

    Number of results per page

Responses ​

200: Conference response

Schema

    data

    undefined[]

  • Array [

    • id stringrequired

    Unique identifier of the conference

    name stringrequired

    Name of the conference

    created_at stringrequired

    ISO 8601 formatted date of when the conference was created

    expires_at stringrequired

    ISO 8601 formatted date of when the conference will expire

  • ]

    • meta

    object

    total_pages double

    Total number of pages based on pagination settings

    total_results double

    Total number of results

    page_number double

    Current Page based on pagination settings (included when defaults are used.)

    page_size double

    Number of results to return per page based on pagination settings (included when defaults are used.)

401: Unauthorized

422: Unprocessable entity. Can be caused by improper use of filters or nodes.

Request samples

curl -L 'https://api.telnyx.com/conferences' \
-H 'Accept: application/json'

Response samples

{
  "data": [
    {
      "id": "string",
      "name": "string",
      "created_at": "string",
      "expires_at": "string"
    }
  ],
  "meta": {
    "total_pages": 13,
    "total_results": 13,
    "page_number": 3,
    "page_size": 1
  }
}