v47

latestOpenAPI 3.1.0raw.githubusercontent.com2026-06-181,0851,7264.5 MB

Conference Commands

List 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.

get/conferences

Query parameters

region'Australia' | 'Europe' | 'Middle East' | 'US'

Region where the conference data is located

outbound.outbound_voice_profile_idstring

Identifies the associated outbound voice profile.

leg_idstring uuid

The unique identifier of an individual call leg.

application_session_idstring uuid

The unique identifier of the call session. A session may include multiple call leg events.

connection_idstring

The unique identifier of the conection.

product'call_control' | 'fax' | 'texml'

Filter by product.

failedboolean

Delivery failed or not.

fromstring

Filter by From number.

tostring

Filter by To number.

namestring

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

type'command' | 'webhook'

Event type

status'init' | 'in_progress' | 'completed'

If present, conferences will be filtered by status.

Consolidated filter parameter (deepObject style). Originally: filter[application_name][contains], filter[outbound.outbound_voice_profile_id], filter[leg_id], filter[application_session_id], filter[connection_id], filter[product], filter[failed], filter[from], filter[to], filter[name], filter[type], filter[occurred_at][eq/gt/gte/lt/lte], filter[status]

{
  "outbound.outbound_voice_profile_id": "1293384261075731499",
  "product": "texml",
  "from": "+12025550142",
  "to": "+12025550142",
  "type": "webhook",
  "occurred_at": {
    "eq": "2019-03-29T11:10:00Z",
    "gt": "2019-03-29T11:10:00Z",
    "gte": "2019-03-29T11:10:00Z",
    "lt": "2019-03-29T11:10:00Z",
    "lte": "2019-03-29T11:10:00Z"
  }
}

page[number]integer

page[size]integer

Response

Successful response with a list of conferences.

Example response

{
  "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
  }
}