GET
/
rooms
/
{room_id}
/
sessions
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 roomSession of client.rooms.sessions.list1(
'0ccc7b54-4df3-4bca-a65a-3da1ecc777f0',
)) {
console.log(roomSession.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.rooms.sessions.list_1(
room_id="0ccc7b54-4df3-4bca-a65a-3da1ecc777f0",
)
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.Rooms.Sessions.List1(
context.TODO(),
"0ccc7b54-4df3-4bca-a65a-3da1ecc777f0",
telnyx.RoomSessionList1Params{},
)
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.rooms.sessions.SessionList1Page;
import com.telnyx.sdk.models.rooms.sessions.SessionList1Params;
public final class Main {
private Main() {}
public static void main(String[] args) {
TelnyxClient client = TelnyxOkHttpClient.fromEnv();
SessionList1Page page = client.rooms().sessions().list1("0ccc7b54-4df3-4bca-a65a-3da1ecc777f0");
}
}require "telnyx"
telnyx = Telnyx::Client.new(api_key: "My API Key")
page = telnyx.rooms.sessions.list_1("0ccc7b54-4df3-4bca-a65a-3da1ecc777f0")
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->rooms->sessions->list1(
'0ccc7b54-4df3-4bca-a65a-3da1ecc777f0',
filter: [
'active' => true,
'dateCreatedAt' => [
'eq' => '2021-04-25', 'gte' => '2021-04-25', 'lte' => '2021-04-25'
],
'dateEndedAt' => [
'eq' => '2021-04-25', 'gte' => '2021-04-25', 'lte' => '2021-04-25'
],
'dateUpdatedAt' => [
'eq' => '2021-04-25', 'gte' => '2021-04-25', 'lte' => '2021-04-25'
],
],
includeParticipants: true,
pageNumber: 0,
pageSize: 0,
);
var_dump($page);
} catch (APIException $e) {
echo $e->getMessage();
}telnyx rooms:sessions list-1 \
--api-key 'My API Key' \
--room-id 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0curl --request GET \
--url https://api.telnyx.com/v2/rooms/{room_id}/sessions \
--header 'Authorization: Bearer <token>'{
"data": [
{
"id": "7b61621f-62e0-4aad-ab11-9fd19e272e73",
"room_id": "7b61621f-5fe4-4aad-ab11-9fd19e272e73",
"active": false,
"created_at": "2021-04-16T09:46:20.954863Z",
"updated_at": "2021-04-16T10:24:55.962200Z",
"ended_at": "2021-04-16T10:24:55.962200Z",
"participants": [],
"record_type": "room_session"
}
],
"meta": {
"total_pages": 3,
"total_results": 55,
"page_number": 2,
"page_size": 25
}
}{
"success": false,
"message": "Error"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The unique identifier of a room.
Example:
"0ccc7b54-4df3-4bca-a65a-3da1ecc777f0"
Query Parameters
To decide if room participants should be included in the response.
Example:
true
Consolidated filter parameter (deepObject style). Originally: filter[date_created_at][eq], filter[date_created_at][gte], filter[date_created_at][lte], filter[date_updated_at][eq], filter[date_updated_at][gte], filter[date_updated_at][lte], filter[date_ended_at][eq], filter[date_ended_at][gte], filter[date_ended_at][lte], filter[active]
Show child attributes
Show child attributes
Consolidated page parameter (deepObject style). Originally: 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 roomSession of client.rooms.sessions.list1(
'0ccc7b54-4df3-4bca-a65a-3da1ecc777f0',
)) {
console.log(roomSession.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.rooms.sessions.list_1(
room_id="0ccc7b54-4df3-4bca-a65a-3da1ecc777f0",
)
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.Rooms.Sessions.List1(
context.TODO(),
"0ccc7b54-4df3-4bca-a65a-3da1ecc777f0",
telnyx.RoomSessionList1Params{},
)
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.rooms.sessions.SessionList1Page;
import com.telnyx.sdk.models.rooms.sessions.SessionList1Params;
public final class Main {
private Main() {}
public static void main(String[] args) {
TelnyxClient client = TelnyxOkHttpClient.fromEnv();
SessionList1Page page = client.rooms().sessions().list1("0ccc7b54-4df3-4bca-a65a-3da1ecc777f0");
}
}require "telnyx"
telnyx = Telnyx::Client.new(api_key: "My API Key")
page = telnyx.rooms.sessions.list_1("0ccc7b54-4df3-4bca-a65a-3da1ecc777f0")
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->rooms->sessions->list1(
'0ccc7b54-4df3-4bca-a65a-3da1ecc777f0',
filter: [
'active' => true,
'dateCreatedAt' => [
'eq' => '2021-04-25', 'gte' => '2021-04-25', 'lte' => '2021-04-25'
],
'dateEndedAt' => [
'eq' => '2021-04-25', 'gte' => '2021-04-25', 'lte' => '2021-04-25'
],
'dateUpdatedAt' => [
'eq' => '2021-04-25', 'gte' => '2021-04-25', 'lte' => '2021-04-25'
],
],
includeParticipants: true,
pageNumber: 0,
pageSize: 0,
);
var_dump($page);
} catch (APIException $e) {
echo $e->getMessage();
}telnyx rooms:sessions list-1 \
--api-key 'My API Key' \
--room-id 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0curl --request GET \
--url https://api.telnyx.com/v2/rooms/{room_id}/sessions \
--header 'Authorization: Bearer <token>'{
"data": [
{
"id": "7b61621f-62e0-4aad-ab11-9fd19e272e73",
"room_id": "7b61621f-5fe4-4aad-ab11-9fd19e272e73",
"active": false,
"created_at": "2021-04-16T09:46:20.954863Z",
"updated_at": "2021-04-16T10:24:55.962200Z",
"ended_at": "2021-04-16T10:24:55.962200Z",
"participants": [],
"record_type": "room_session"
}
],
"meta": {
"total_pages": 3,
"total_results": 55,
"page_number": 2,
"page_size": 25
}
}{
"success": false,
"message": "Error"
}