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
JavaScript
import Telnyx from 'telnyx';
const client = new Telnyx({
apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});
// Automatically fetches more pages as needed.
for await (const conference of client.conferences.list()) {
console.log(conference.id);
}import os
from telnyx import Telnyx
client = Telnyx(
api_key=os.environ.get("TELNYX_API_KEY"), # This is the default and can be omitted
)
page = client.conferences.list()
page = page.data[0]
print(page.id)
package main
import (
"context"
"fmt"
"github.com/team-telnyx/telnyx-go"
"github.com/team-telnyx/telnyx-go/option"
)
func main() {
client := telnyx.NewClient(
option.WithAPIKey("My API Key"),
)
page, err := client.Conferences.List(context.TODO(), telnyx.ConferenceListParams{})
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", page)
}
package com.telnyx.sdk.example;
import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
import com.telnyx.sdk.models.conferences.ConferenceListPage;
import com.telnyx.sdk.models.conferences.ConferenceListParams;
public final class Main {
private Main() {}
public static void main(String[] args) {
TelnyxClient client = TelnyxOkHttpClient.fromEnv();
ConferenceListPage page = client.conferences().list();
}
}require "telnyx"
telnyx = Telnyx::Client.new(api_key: "My API Key")
page = telnyx.conferences.list
puts(page)<?php
require_once dirname(__DIR__) . '/vendor/autoload.php';
use Telnyx\Client;
use Telnyx\Core\Exceptions\APIException;
$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');
try {
$page = $client->conferences->list(
filter: [
'applicationName' => ['contains' => 'contains'],
'applicationSessionID' => '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
'connectionID' => 'connection_id',
'failed' => false,
'from' => '+12025550142',
'legID' => '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
'name' => 'name',
'occurredAt' => [
'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',
],
'outboundOutboundVoiceProfileID' => '1293384261075731499',
'product' => 'texml',
'status' => 'init',
'to' => '+12025550142',
'type' => 'webhook',
],
pageNumber: 0,
pageSize: 0,
region: 'Australia',
);
var_dump($page);
} catch (APIException $e) {
echo $e->getMessage();
}telnyx conferences list \
--api-key 'My API Key'curl --request GET \
--url https://api.telnyx.com/v2/conferences \
--header 'Authorization: Bearer <token>'{
"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
}
}
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Region where the conference data is located
Available options:
Australia, Europe, Middle East, US 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]
Show child attributes
Show child attributes
Consolidated page parameter (deepObject style). Originally: page[after], page[before], page[limit], page[size], page[number]
Show child attributes
Show child attributes
Was this page helpful?
⌘I
JavaScript
import Telnyx from 'telnyx';
const client = new Telnyx({
apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});
// Automatically fetches more pages as needed.
for await (const conference of client.conferences.list()) {
console.log(conference.id);
}import os
from telnyx import Telnyx
client = Telnyx(
api_key=os.environ.get("TELNYX_API_KEY"), # This is the default and can be omitted
)
page = client.conferences.list()
page = page.data[0]
print(page.id)
package main
import (
"context"
"fmt"
"github.com/team-telnyx/telnyx-go"
"github.com/team-telnyx/telnyx-go/option"
)
func main() {
client := telnyx.NewClient(
option.WithAPIKey("My API Key"),
)
page, err := client.Conferences.List(context.TODO(), telnyx.ConferenceListParams{})
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", page)
}
package com.telnyx.sdk.example;
import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
import com.telnyx.sdk.models.conferences.ConferenceListPage;
import com.telnyx.sdk.models.conferences.ConferenceListParams;
public final class Main {
private Main() {}
public static void main(String[] args) {
TelnyxClient client = TelnyxOkHttpClient.fromEnv();
ConferenceListPage page = client.conferences().list();
}
}require "telnyx"
telnyx = Telnyx::Client.new(api_key: "My API Key")
page = telnyx.conferences.list
puts(page)<?php
require_once dirname(__DIR__) . '/vendor/autoload.php';
use Telnyx\Client;
use Telnyx\Core\Exceptions\APIException;
$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');
try {
$page = $client->conferences->list(
filter: [
'applicationName' => ['contains' => 'contains'],
'applicationSessionID' => '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
'connectionID' => 'connection_id',
'failed' => false,
'from' => '+12025550142',
'legID' => '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
'name' => 'name',
'occurredAt' => [
'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',
],
'outboundOutboundVoiceProfileID' => '1293384261075731499',
'product' => 'texml',
'status' => 'init',
'to' => '+12025550142',
'type' => 'webhook',
],
pageNumber: 0,
pageSize: 0,
region: 'Australia',
);
var_dump($page);
} catch (APIException $e) {
echo $e->getMessage();
}telnyx conferences list \
--api-key 'My API Key'curl --request GET \
--url https://api.telnyx.com/v2/conferences \
--header 'Authorization: Bearer <token>'{
"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
}
}