List conferences

GET 
/conferences

Lists conferences. 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. Conferences are listed in descending order by expires_at.

Request

Query Parameters

filter[name] string

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

filter[status] string

Possible values: [init, in_progress, completed]

If present, conferences will be filtered by status.

page[number] integer

Possible values: >= 1

Default value: 1

The page number to load

page[size] integer

Possible values: >= 1 and <= 250

Default value: 20

The size of the page

Responses

200: Successful response with a list of conferences.

application/json

Schema

Schema

data

object[]

Array [

record_type stringrequired

Possible values: [conference]

id stringrequired

Uniquely identifies 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

updated_at string

ISO 8601 formatted date of when the conference was last updated

region string

Region where the conference is hosted

status string

Possible values: [init, in_progress, completed]

Status of the conference

end_reason string

Possible values: [all_left, ended_via_api, host_left, time_exceeded]

Reason why the conference ended

ended_by

object

IDs related to who ended the conference. It is expected for them to all be there or all be null

call_control_id string

Call Control ID which ended the conference

call_session_id string

Call Session ID which ended the conference

connection_id string

Identifies the connection associated with the conference

]

meta

object

total_pages integer

total_results integer

page_number integer

page_size integer

Example (from schema)

{
  "data": [
    {
      "record_type": "conference",
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "All hands meeting",
      "created_at": "2019-01-23T18:10:02.574Z",
      "expires_at": "2019-01-23T18:10:02.574Z",
      "updated_at": "2019-01-23T18:10:02.574Z",
      "region": "sv1",
      "status": "completed",
      "end_reason": "all_left",
      "ended_by": {
        "call_control_id": "v2:T02llQxIyaRkhfRKxgAP8nY511EhFLizdvdUKJiSw8d6A9BborherQczRrZvZakpWxBlpw48KyZQ==",
        "call_session_id": "428c31b6-abf3-3bc1-b7f4-5013ef9657c1"
      },
      "connection_id": "3fa85f64-9191-4567-b3fc-2c963f66afa6"
    }
  ],
  "meta": {
    "total_pages": 3,
    "total_results": 55,
    "page_number": 2,
    "page_size": 25
  }
}

401: Unauthorized

422: Unprocessable entity

Loading...