REST API: Rooms

概要

The Programmable Video Rooms resource represents a communications session among multiple endpoints using one of Twilio's Programmable Video SDKs. Connected users (Participants) can share video and audio Tracks to the Room, and receive video and audio Tracks from other Participants in the Room.

The Rooms resource lets you dynamically create and complete Rooms and configure a Room's topology and behavior. Use this API to set Room properties such as its name, type, TURN configuration, webhook status callback URL, and the maximum number of Participants.

All Programmable Video REST API resources use the following base URL.

https://video.twilio.com

目次

• Room Instance Resource
  • リソースのプロパティ
  • Get a Room Instance (HTTP GET)
  • Modify a Room Instance (HTTP POST)
• Rooms List Resource
  • Create Room (HTTP POST)
  • POSTパラメーター
  • Get list of Rooms (HTTP GET)
  • Filter parameters
• サンプル
  • ルームを作成する
  • Retrieve an in-progress Room by UniqueName
  • Retrieve a Room by Sid
  • Complete a Room
  • Filter Room list by UniqueName
  • Filter Room list by Status
  • Use multiple filters

Room Instance Resource

リソースURI

/v1/Rooms/{RoomNameOrSid}

リソースのプロパティ

HTTP GET

Returns a single Room resource represented by {RoomNameOrSid} .

Retrieve an in-progress Room instance by UniqueName

You can retrieve an in-progress Room instance object using the Room's UniqueName. This makes it easier to interact with Twilio's REST API without having to keep track of Twilio's Room SID identifiers.

たとえば、次のようになります。

GET /Rooms/DailyStandup

Will return the Room instance object for the Room DailyStandup if the room is currently in-progress. If no Room exists by the name DailyStandup, or a Room by that name is only in completed status, the above request will return an HTTP 404 response.

Retrieve an in-progress or completed Room instance by RoomSid

A Room's Sid property is Twilio's own canonical unique identifier for a Room. You can always use the Room Sid to retrieve the Room, whether the room is in-progress or completed.

たとえば、次のようになります。

GET /Rooms/RMxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Will return the Room instance object for the Room with Sid RMxxxxxxxxxxxxxxxxxxxxxxxxxxxxx, regardless of its status. If no Room exists with that Sid, the above request will return an HTTP 404 response.

HTTP POST

Modifies a Room resource.

Supported POST parameters

Complete a Room

Update a Room's status to completed with the following request to end the Room. All connected Participants will be immediately disconnected from the Room.

Rooms List Resource

リソースURI

/v1/Rooms

HTTP POST

Create a new Room with an HTTP POST to the Rooms list resource.

Supported POST parameters

Note: Rooms created via the REST API exist for five minutes to allow the first Participant to connect. If no Participants join within five minutes, the Room times out and a new Room must be created.

例1: 「DailyStandup」という名前のRoomを作成します

例2: SalesMeetingという名前で、Network Traversal Service TURNをオフにし、ステータスコールバックURLを設定したRoomを作成します。

例3: Group Roomを作成し、レコーディングをオンにし、ステータスコールバックURLを設定します。

Example 4: Create a Small Group Room

Once a Room is created, generate an Access Token containing the Room name and use one of Twilio's Video SDKs to connect to the Room.

For example, using the JavaScript SDK:

Twilio.Video.connect('$AccessTokenContainingRoomName').then(function(room) {
  console.log('Successfully joined a Room: ', room);
}, function(error) {
    console.error('Unable to connect to Room: ' +  error.message);
});

HTTP GET

Returns a list of Room resources created in the given account. The list includes paging information.

リストフィルター

The following GET query string parameters allow you to limit the list returned. Note, parameters are case-sensitive.

Filter Rooms by UniqueName

DailyStandupという名前を含むRoomsの一覧を返します。

Filter Rooms by Status

Using multiple list filters