List conferences

gethttps://api.telnyx.com/v2/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.

curl -X GET \ --header "Content-Type: application/json" \ --header "Accept: application/json" \ --header "Authorization: Bearer YOUR_API_KEY" \ --globoff "https://api.telnyx.com/v2/conferences?filter[name]=string&filter[status]=string"

Parameters

In Query
filter[name]
string
optional
If present, conferences will be filtered to those with a matching `name` attribute. Matching is case-sensitive
filter[status]
string
optional
If present, conferences will be filtered by status.
Options: [ "init", "in_progress", "completed" ]
page[number]
integer
(1)
optional
The page number to load
Default:
1
page[size]
integer
(1 - 250)
optional
The size of the page
Default:
20

Responses

200
Successful response with a list of conferences.
401
Unauthorized
422
Unprocessable entity

Success Response

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

...

posthttps://api.telnyx.com/v2/conferences

...

...

Parameters

Responses

Success Response

...

gethttps://api.telnyx.com/v2/conferences/{id}

...

...

Parameters

Responses

Success Response

...

posthttps://api.telnyx.com/v2/conferences/{id}/actions/join

...

...

Parameters

Responses

Success Response

...

posthttps://api.telnyx.com/v2/conferences/{id}/actions/mute

...

...

Parameters

Responses

Success Response

...

posthttps://api.telnyx.com/v2/conferences/{id}/actions/unmute

...

...

Parameters

Responses

Success Response

...

posthttps://api.telnyx.com/v2/conferences/{id}/actions/hold

...

...

Parameters

Responses

Success Response

...

posthttps://api.telnyx.com/v2/conferences/{id}/actions/unhold

...

...

Parameters

Responses

Success Response

...

posthttps://api.telnyx.com/v2/conferences/{id}/actions/speak

...

...

Parameters

Responses

Success Response

...

posthttps://api.telnyx.com/v2/conferences/{id}/actions/play

...

...

Parameters

Responses

Success Response

...

posthttps://api.telnyx.com/v2/conferences/{id}/actions/stop

...

...

Parameters

Responses

Success Response

...

posthttps://api.telnyx.com/v2/conferences/{id}/actions/record_start

...

...

Parameters

Responses

Success Response

...

posthttps://api.telnyx.com/v2/conferences/{id}/actions/record_stop

...

...

Parameters

Responses

Success Response

...

gethttps://api.telnyx.com/v2/conferences/{conference_id}/participants

...

...

Parameters

Responses

Success Response

...

posthttps://api.telnyx.com/v2/conferences/{id}/actions/update

...

...

Parameters

Responses

Success Response

...

posthttps://api.telnyx.com/v2/conferences/{id}/actions/leave

...

...

Parameters

Responses

Success Response

Was this page helpful?