View a list of rooms.

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 room of client.rooms.list()) {
  console.log(room.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.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.Rooms.List(context.TODO(), telnyx.RoomListParams{})
	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.RoomListPage;
import com.telnyx.sdk.models.rooms.RoomListParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        TelnyxClient client = TelnyxOkHttpClient.fromEnv();

        RoomListPage page = client.rooms().list();
    }
}

require "telnyx"

telnyx = Telnyx::Client.new(api_key: "My API Key")

page = telnyx.rooms.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->rooms->list(
    filter: [
      'dateCreatedAt' => [
        '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'
      ],
      'uniqueName' => 'my_video_room',
    ],
    includeSessions: true,
    pageNumber: 0,
    pageSize: 0,
  );

  var_dump($page);
} catch (APIException $e) {
  echo $e->getMessage();
}

telnyx rooms list \
  --api-key 'My API Key'

curl --request GET \
  --url https://api.telnyx.com/v2/rooms \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": "7b61621f-62e0-4aad-ab11-9fd19e272e73",
      "max_participants": 50,
      "unique_name": "My Room",
      "created_at": "2021-04-16T09:46:20.954863Z",
      "updated_at": "2021-04-16T10:24:55.962200Z",
      "active_session_id": "7b61621f-62e0-4aad-ab11-9fd19e272e74",
      "enable_recording": true,
      "webhook_event_failover_url": "https://failover.example.com",
      "webhook_timeout_secs": 25,
      "webhook_event_url": "https://www.example.com",
      "sessions": [
        {
          "id": "7b61621f-62e0-4aad-ab11-9fd19e272e74",
          "room_id": "7b61621f-62e0-4aad-ab11-9fd19e272e73",
          "active": true,
          "created_at": "2021-04-16T09:46:20.954863Z",
          "updated_at": "2021-04-16T10:24:55.962200Z",
          "participants": [],
          "record_type": "room_session"
        }
      ],
      "record_type": "room"
    }
  ],
  "meta": {
    "total_pages": 3,
    "total_results": 55,
    "page_number": 2,
    "page_size": 25
  }
}

{
  "success": false,
  "message": "Error"
}