Update a room.

Synchronously update a Room.

PATCH /rooms/{room_id}

JavaScript

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

const room = await client.rooms.update('0ccc7b54-4df3-4bca-a65a-3da1ecc777f0');

console.log(room.data);

import os
from telnyx import Telnyx

client = Telnyx(
    api_key=os.environ.get("TELNYX_API_KEY"),  # This is the default and can be omitted
)
room = client.rooms.update(
    room_id="0ccc7b54-4df3-4bca-a65a-3da1ecc777f0",
)
print(room.data)

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"),
	)
	room, err := client.Rooms.Update(
		context.TODO(),
		"0ccc7b54-4df3-4bca-a65a-3da1ecc777f0",
		telnyx.RoomUpdateParams{},
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", room.Data)
}

package com.telnyx.sdk.example;

import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
import com.telnyx.sdk.models.rooms.RoomUpdateParams;
import com.telnyx.sdk.models.rooms.RoomUpdateResponse;

public final class Main {
    private Main() {}

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

        RoomUpdateResponse room = client.rooms().update("0ccc7b54-4df3-4bca-a65a-3da1ecc777f0");
    }
}

require "telnyx"

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

room = telnyx.rooms.update("0ccc7b54-4df3-4bca-a65a-3da1ecc777f0")

puts(room)

<?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 {
  $room = $client->rooms->update(
    '0ccc7b54-4df3-4bca-a65a-3da1ecc777f0',
    enableRecording: true,
    maxParticipants: 10,
    uniqueName: 'My room',
    webhookEventFailoverURL: 'https://failover.example.com',
    webhookEventURL: 'https://example.com',
    webhookTimeoutSecs: 25,
  );

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

telnyx rooms update \
  --api-key 'My API Key' \
  --room-id 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0

curl --request PATCH \
  --url https://api.telnyx.com/v2/rooms/{room_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "unique_name": "My room",
  "max_participants": 10,
  "enable_recording": true,
  "webhook_event_url": "https://example.com",
  "webhook_event_failover_url": "https://failover.example.com",
  "webhook_timeout_secs": 25
}
'

200

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

{
  "code": "<string>",
  "title": "<string>",
  "detail": "<string>",
  "source": {
    "pointer": "<string>",
    "parameter": "<string>"
  },
  "meta": {}
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

room_id · string<uuid> · required

The unique identifier of a room.

Example:

"0ccc7b54-4df3-4bca-a65a-3da1ecc777f0"

Body

application/json

Parameters that can be defined during room update.

unique_name · string

The unique (within the Telnyx account scope) name of the room.

Example:

"My room"

max_participants · integer · default: 10

The maximum amount of participants allowed in a room. If new participants try to join after that limit is reached, their request will be rejected.

Required range: 2 <= x <= 50

Example:

10

enable_recording · boolean · default: false

Enable or disable recording for that room.

Example:

true

webhook_event_url · string<uri>

The URL where webhooks related to this room will be sent. Must include a scheme, such as 'https'.

Example:

"https://example.com"

webhook_event_failover_url · string<uri> · default: ""

The failover URL where webhooks related to this room will be sent if sending to the primary URL fails. Must include a scheme, such as 'https'.

Example:

"https://failover.example.com"

webhook_timeout_secs · integer

Specifies how many seconds to wait before timing out a webhook.

Required range: 0 <= x <= 30

Example:

25

Response

200

application/json

Update room response.

data · object

Show child attributes

Example:

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