Back to Details

telnyx-video-java

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese
<!-- Auto-generated from Telnyx OpenAPI specs. Do not edit. -->
<!-- 从Telnyx OpenAPI规范自动生成，请勿编辑。 -->

Telnyx Video - Java

Telnyx 视频服务 - Java

Installation

安装

text
<!-- Maven -->
<dependency>
    <groupId>com.telnyx.sdk</groupId>
    <artifactId>telnyx</artifactId>
    <version>6.36.0</version>
</dependency>

// Gradle
implementation("com.telnyx.sdk:telnyx:6.36.0")
text
<!-- Maven -->
<dependency>
    <groupId>com.telnyx.sdk</groupId>
    <artifactId>telnyx</artifactId>
    <version>6.36.0</version>
</dependency>

// Gradle
implementation("com.telnyx.sdk:telnyx:6.36.0")

Setup

初始化配置

java
import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;

TelnyxClient client = TelnyxOkHttpClient.fromEnv();
All examples below assume 
client
is already initialized as shown above.
java
import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;

TelnyxClient client = TelnyxOkHttpClient.fromEnv();
以下所有示例均假设
client
已按照上述方式完成初始化。

Error Handling

错误处理

All API calls can fail with network errors, rate limits (429), validation errors (422), or authentication errors (401). Always handle errors in production code:
java
import com.telnyx.sdk.errors.TelnyxServiceException;

try {
    var result = client.messages().send(params);
} catch (TelnyxServiceException e) {
    System.err.println("API error " + e.statusCode() + ": " + e.getMessage());
    if (e.statusCode() == 422) {
        System.err.println("Validation error — check required fields and formats");
    } else if (e.statusCode() == 429) {
        // Rate limited — wait and retry with exponential backoff
        Thread.sleep(1000);
    }
}
Common error codes: 
401
invalid API key, 
403
insufficient permissions, 
404
resource not found, 
422
validation error (check field formats), 
429
rate limited (retry with exponential backoff).
所有API调用都可能因网络错误、速率限制（429）、校验错误（422）或认证错误（401）而失败。在生产代码中请务必做好错误处理：
java
import com.telnyx.sdk.errors.TelnyxServiceException;

try {
    var result = client.messages().send(params);
} catch (TelnyxServiceException e) {
    System.err.println("API error " + e.statusCode() + ": " + e.getMessage());
    if (e.statusCode() == 422) {
        System.err.println("Validation error — check required fields and formats");
    } else if (e.statusCode() == 429) {
        // Rate limited — wait and retry with exponential backoff
        Thread.sleep(1000);
    }
}
常见错误码：
401
API密钥无效，
403
权限不足，
404
资源不存在，
422
校验错误（请检查字段格式），
429
触发速率限制（请使用指数退避策略重试）。

View a list of room compositions.

查询房间合成文件列表

GET /room_compositions
java
import com.telnyx.sdk.models.roomcompositions.RoomCompositionListPage;
import com.telnyx.sdk.models.roomcompositions.RoomCompositionListParams;

RoomCompositionListPage page = client.roomCompositions().list();
Returns: 
completed_at
(date-time), 
created_at
(date-time), 
download_url
(string), 
duration_secs
(integer), 
ended_at
(date-time), 
format
(enum: mp4), 
id
(uuid), 
record_type
(string), 
resolution
(string), 
room_id
(uuid), 
session_id
(uuid), 
size_mb
(float), 
started_at
(date-time), 
status
(enum: completed, enqueued, processing), 
updated_at
(date-time), 
user_id
(uuid), 
video_layout
(object), 
webhook_event_failover_url
(uri), 
webhook_event_url
(uri), 
webhook_timeout_secs
(integer)
GET /room_compositions
java
import com.telnyx.sdk.models.roomcompositions.RoomCompositionListPage;
import com.telnyx.sdk.models.roomcompositions.RoomCompositionListParams;

RoomCompositionListPage page = client.roomCompositions().list();
返回参数：
completed_at
（日期时间）、
created_at
（日期时间）、
download_url
（字符串）、
duration_secs
（整数）、
ended_at
（日期时间）、
format
（枚举值：mp4）、
id
（uuid）、
record_type
（字符串）、
resolution
（字符串）、
room_id
（uuid）、
session_id
（uuid）、
size_mb
（浮点数）、
started_at
（日期时间）、
status
（枚举值：completed 已完成, enqueued 队列中, processing 处理中）、
updated_at
（日期时间）、
user_id
（uuid）、
video_layout
（对象）、
webhook_event_failover_url
（URI）、
webhook_event_url
（URI）、
webhook_timeout_secs
（整数）

Create a room composition.

创建房间合成文件

Asynchronously create a room composition.
POST /room_compositions
Optional: 
format
(string), 
resolution
(string), 
session_id
(uuid), 
video_layout
(object), 
webhook_event_failover_url
(uri), 
webhook_event_url
(uri), 
webhook_timeout_secs
(integer)
java
import com.telnyx.sdk.models.roomcompositions.RoomCompositionCreateParams;
import com.telnyx.sdk.models.roomcompositions.RoomCompositionCreateResponse;

RoomCompositionCreateResponse roomComposition = client.roomCompositions().create();
Returns: 
completed_at
(date-time), 
created_at
(date-time), 
download_url
(string), 
duration_secs
(integer), 
ended_at
(date-time), 
format
(enum: mp4), 
id
(uuid), 
record_type
(string), 
resolution
(string), 
room_id
(uuid), 
session_id
(uuid), 
size_mb
(float), 
started_at
(date-time), 
status
(enum: completed, enqueued, processing), 
updated_at
(date-time), 
user_id
(uuid), 
video_layout
(object), 
webhook_event_failover_url
(uri), 
webhook_event_url
(uri), 
webhook_timeout_secs
(integer)
异步创建房间合成文件。
POST /room_compositions
可选参数：
format
（字符串）、
resolution
（字符串）、
session_id
（uuid）、
video_layout
（对象）、
webhook_event_failover_url
（URI）、
webhook_event_url
（URI）、
webhook_timeout_secs
（整数）
java
import com.telnyx.sdk.models.roomcompositions.RoomCompositionCreateParams;
import com.telnyx.sdk.models.roomcompositions.RoomCompositionCreateResponse;

RoomCompositionCreateResponse roomComposition = client.roomCompositions().create();
返回参数：
completed_at
（日期时间）、
created_at
（日期时间）、
download_url
（字符串）、
duration_secs
（整数）、
ended_at
（日期时间）、
format
（枚举值：mp4）、
id
（uuid）、
record_type
（字符串）、
resolution
（字符串）、
room_id
（uuid）、
session_id
（uuid）、
size_mb
（浮点数）、
started_at
（日期时间）、
status
（枚举值：completed 已完成, enqueued 队列中, processing 处理中）、
updated_at
（日期时间）、
user_id
（uuid）、
video_layout
（对象）、
webhook_event_failover_url
（URI）、
webhook_event_url
（URI）、
webhook_timeout_secs
（整数）

View a room composition.

查询单个房间合成文件信息

GET /room_compositions/{room_composition_id}
java
import com.telnyx.sdk.models.roomcompositions.RoomCompositionRetrieveParams;
import com.telnyx.sdk.models.roomcompositions.RoomCompositionRetrieveResponse;

RoomCompositionRetrieveResponse roomComposition = client.roomCompositions().retrieve("5219b3af-87c6-4c08-9b58-5a533d893e21");
Returns: 
completed_at
(date-time), 
created_at
(date-time), 
download_url
(string), 
duration_secs
(integer), 
ended_at
(date-time), 
format
(enum: mp4), 
id
(uuid), 
record_type
(string), 
resolution
(string), 
room_id
(uuid), 
session_id
(uuid), 
size_mb
(float), 
started_at
(date-time), 
status
(enum: completed, enqueued, processing), 
updated_at
(date-time), 
user_id
(uuid), 
video_layout
(object), 
webhook_event_failover_url
(uri), 
webhook_event_url
(uri), 
webhook_timeout_secs
(integer)
GET /room_compositions/{room_composition_id}
java
import com.telnyx.sdk.models.roomcompositions.RoomCompositionRetrieveParams;
import com.telnyx.sdk.models.roomcompositions.RoomCompositionRetrieveResponse;

RoomCompositionRetrieveResponse roomComposition = client.roomCompositions().retrieve("5219b3af-87c6-4c08-9b58-5a533d893e21");
返回参数：
completed_at
（日期时间）、
created_at
（日期时间）、
download_url
（字符串）、
duration_secs
（整数）、
ended_at
（日期时间）、
format
（枚举值：mp4）、
id
（uuid）、
record_type
（字符串）、
resolution
（字符串）、
room_id
（uuid）、
session_id
（uuid）、
size_mb
（浮点数）、
started_at
（日期时间）、
status
（枚举值：completed 已完成, enqueued 队列中, processing 处理中）、
updated_at
（日期时间）、
user_id
（uuid）、
video_layout
（对象）、
webhook_event_failover_url
（URI）、
webhook_event_url
（URI）、
webhook_timeout_secs
（整数）

Delete a room composition.

删除房间合成文件

Synchronously delete a room composition.
DELETE /room_compositions/{room_composition_id}
java
import com.telnyx.sdk.models.roomcompositions.RoomCompositionDeleteParams;

client.roomCompositions().delete("5219b3af-87c6-4c08-9b58-5a533d893e21");
同步删除房间合成文件。
DELETE /room_compositions/{room_composition_id}
java
import com.telnyx.sdk.models.roomcompositions.RoomCompositionDeleteParams;

client.roomCompositions().delete("5219b3af-87c6-4c08-9b58-5a533d893e21");

View a list of room participants.

查询房间参与者列表

GET /room_participants
java
import com.telnyx.sdk.models.roomparticipants.RoomParticipantListPage;
import com.telnyx.sdk.models.roomparticipants.RoomParticipantListParams;

RoomParticipantListPage page = client.roomParticipants().list();
Returns: 
context
(string), 
id
(uuid), 
joined_at
(date-time), 
left_at
(date-time), 
record_type
(string), 
session_id
(uuid), 
updated_at
(date-time)
GET /room_participants
java
import com.telnyx.sdk.models.roomparticipants.RoomParticipantListPage;
import com.telnyx.sdk.models.roomparticipants.RoomParticipantListParams;

RoomParticipantListPage page = client.roomParticipants().list();
返回参数：
context
（字符串）、
id
（uuid）、
joined_at
（日期时间）、
left_at
（日期时间）、
record_type
（字符串）、
session_id
（uuid）、
updated_at
（日期时间）

View a room participant.

查询单个房间参与者信息

GET /room_participants/{room_participant_id}
java
import com.telnyx.sdk.models.roomparticipants.RoomParticipantRetrieveParams;
import com.telnyx.sdk.models.roomparticipants.RoomParticipantRetrieveResponse;

RoomParticipantRetrieveResponse roomParticipant = client.roomParticipants().retrieve("0ccc7b54-4df3-4bca-a65a-3da1ecc777f0");
Returns: 
context
(string), 
id
(uuid), 
joined_at
(date-time), 
left_at
(date-time), 
record_type
(string), 
session_id
(uuid), 
updated_at
(date-time)
GET /room_participants/{room_participant_id}
java
import com.telnyx.sdk.models.roomparticipants.RoomParticipantRetrieveParams;
import com.telnyx.sdk.models.roomparticipants.RoomParticipantRetrieveResponse;

RoomParticipantRetrieveResponse roomParticipant = client.roomParticipants().retrieve("0ccc7b54-4df3-4bca-a65a-3da1ecc777f0");
返回参数：
context
（字符串）、
id
（uuid）、
joined_at
（日期时间）、
left_at
（日期时间）、
record_type
（字符串）、
session_id
（uuid）、
updated_at
（日期时间）

View a list of room recordings.

查询房间录制文件列表

GET /room_recordings
java
import com.telnyx.sdk.models.roomrecordings.RoomRecordingListPage;
import com.telnyx.sdk.models.roomrecordings.RoomRecordingListParams;

RoomRecordingListPage page = client.roomRecordings().list();
Returns: 
codec
(string), 
completed_at
(date-time), 
created_at
(date-time), 
download_url
(string), 
duration_secs
(integer), 
ended_at
(date-time), 
id
(uuid), 
participant_id
(uuid), 
record_type
(string), 
room_id
(uuid), 
session_id
(uuid), 
size_mb
(float), 
started_at
(date-time), 
status
(enum: completed, processing), 
type
(enum: audio, video), 
updated_at
(date-time)
GET /room_recordings
java
import com.telnyx.sdk.models.roomrecordings.RoomRecordingListPage;
import com.telnyx.sdk.models.roomrecordings.RoomRecordingListParams;

RoomRecordingListPage page = client.roomRecordings().list();
返回参数：
codec
（字符串）、
completed_at
（日期时间）、
created_at
（日期时间）、
download_url
（字符串）、
duration_secs
（整数）、
ended_at
（日期时间）、
id
（uuid）、
participant_id
（uuid）、
record_type
（字符串）、
room_id
（uuid）、
session_id
（uuid）、
size_mb
（浮点数）、
started_at
（日期时间）、
status
（枚举值：completed 已完成, processing 处理中）、
type
（枚举值：audio 音频, video 视频）、
updated_at
（日期时间）

Delete several room recordings in a bulk.

批量删除房间录制文件

DELETE /room_recordings
java
import com.telnyx.sdk.models.roomrecordings.RoomRecordingDeleteBulkParams;
import com.telnyx.sdk.models.roomrecordings.RoomRecordingDeleteBulkResponse;

RoomRecordingDeleteBulkResponse response = client.roomRecordings().deleteBulk();
Returns: 
room_recordings
(integer)
DELETE /room_recordings
java
import com.telnyx.sdk.models.roomrecordings.RoomRecordingDeleteBulkParams;
import com.telnyx.sdk.models.roomrecordings.RoomRecordingDeleteBulkResponse;

RoomRecordingDeleteBulkResponse response = client.roomRecordings().deleteBulk();
返回参数：
room_recordings
（整数）

View a room recording.

查询单个房间录制文件信息

GET /room_recordings/{room_recording_id}
java
import com.telnyx.sdk.models.roomrecordings.RoomRecordingRetrieveParams;
import com.telnyx.sdk.models.roomrecordings.RoomRecordingRetrieveResponse;

RoomRecordingRetrieveResponse roomRecording = client.roomRecordings().retrieve("0ccc7b54-4df3-4bca-a65a-3da1ecc777f0");
Returns: 
codec
(string), 
completed_at
(date-time), 
created_at
(date-time), 
download_url
(string), 
duration_secs
(integer), 
ended_at
(date-time), 
id
(uuid), 
participant_id
(uuid), 
record_type
(string), 
room_id
(uuid), 
session_id
(uuid), 
size_mb
(float), 
started_at
(date-time), 
status
(enum: completed, processing), 
type
(enum: audio, video), 
updated_at
(date-time)
GET /room_recordings/{room_recording_id}
java
import com.telnyx.sdk.models.roomrecordings.RoomRecordingRetrieveParams;
import com.telnyx.sdk.models.roomrecordings.RoomRecordingRetrieveResponse;

RoomRecordingRetrieveResponse roomRecording = client.roomRecordings().retrieve("0ccc7b54-4df3-4bca-a65a-3da1ecc777f0");
返回参数：
codec
（字符串）、
completed_at
（日期时间）、
created_at
（日期时间）、
download_url
（字符串）、
duration_secs
（整数）、
ended_at
（日期时间）、
id
（uuid）、
participant_id
（uuid）、
record_type
（字符串）、
room_id
（uuid）、
session_id
（uuid）、
size_mb
（浮点数）、
started_at
（日期时间）、
status
（枚举值：completed 已完成, processing 处理中）、
type
（枚举值：audio 音频, video 视频）、
updated_at
（日期时间）

Delete a room recording.

删除房间录制文件

Synchronously delete a Room Recording.
DELETE /room_recordings/{room_recording_id}
java
import com.telnyx.sdk.models.roomrecordings.RoomRecordingDeleteParams;

client.roomRecordings().delete("0ccc7b54-4df3-4bca-a65a-3da1ecc777f0");
同步删除房间录制文件。
DELETE /room_recordings/{room_recording_id}
java
import com.telnyx.sdk.models.roomrecordings.RoomRecordingDeleteParams;

client.roomRecordings().delete("0ccc7b54-4df3-4bca-a65a-3da1ecc777f0");

View a list of room sessions.

查询房间会话列表

GET /room_sessions
java
import com.telnyx.sdk.models.rooms.sessions.SessionList0Page;
import com.telnyx.sdk.models.rooms.sessions.SessionList0Params;

SessionList0Page page = client.rooms().sessions().list0();
Returns: 
active
(boolean), 
created_at
(date-time), 
ended_at
(date-time), 
id
(uuid), 
participants
(array[object]), 
record_type
(string), 
room_id
(uuid), 
updated_at
(date-time)
GET /room_sessions
java
import com.telnyx.sdk.models.rooms.sessions.SessionList0Page;
import com.telnyx.sdk.models.rooms.sessions.SessionList0Params;

SessionList0Page page = client.rooms().sessions().list0();
返回参数：
active
（布尔值）、
created_at
（日期时间）、
ended_at
（日期时间）、
id
（uuid）、
participants
（对象数组）、
record_type
（字符串）、
room_id
（uuid）、
updated_at
（日期时间）

View a room session.

查询单个房间会话信息

GET /room_sessions/{room_session_id}
java
import com.telnyx.sdk.models.rooms.sessions.SessionRetrieveParams;
import com.telnyx.sdk.models.rooms.sessions.SessionRetrieveResponse;

SessionRetrieveResponse session = client.rooms().sessions().retrieve("0ccc7b54-4df3-4bca-a65a-3da1ecc777f0");
Returns: 
active
(boolean), 
created_at
(date-time), 
ended_at
(date-time), 
id
(uuid), 
participants
(array[object]), 
record_type
(string), 
room_id
(uuid), 
updated_at
(date-time)
GET /room_sessions/{room_session_id}
java
import com.telnyx.sdk.models.rooms.sessions.SessionRetrieveParams;
import com.telnyx.sdk.models.rooms.sessions.SessionRetrieveResponse;

SessionRetrieveResponse session = client.rooms().sessions().retrieve("0ccc7b54-4df3-4bca-a65a-3da1ecc777f0");
返回参数：
active
（布尔值）、
created_at
（日期时间）、
ended_at
（日期时间）、
id
（uuid）、
participants
（对象数组）、
record_type
（字符串）、
room_id
（uuid）、
updated_at
（日期时间）

End a room session.

结束房间会话

Note: this will also kick all participants currently present in the room
POST /room_sessions/{room_session_id}/actions/end
java
import com.telnyx.sdk.models.rooms.sessions.actions.ActionEndParams;
import com.telnyx.sdk.models.rooms.sessions.actions.ActionEndResponse;

ActionEndResponse response = client.rooms().sessions().actions().end("0ccc7b54-4df3-4bca-a65a-3da1ecc777f0");
Returns: 
result
(string)
注意：该操作会将当前房间内的所有参与者踢出
POST /room_sessions/{room_session_id}/actions/end
java
import com.telnyx.sdk.models.rooms.sessions.actions.ActionEndParams;
import com.telnyx.sdk.models.rooms.sessions.actions.ActionEndResponse;

ActionEndResponse response = client.rooms().sessions().actions().end("0ccc7b54-4df3-4bca-a65a-3da1ecc777f0");
返回参数：
result
（字符串）

Kick participants from a room session.

踢出房间会话参与者

POST /room_sessions/{room_session_id}/actions/kick
Optional: 
exclude
(array[string]), 
participants
(object)
java
import com.telnyx.sdk.models.rooms.sessions.actions.ActionKickParams;
import com.telnyx.sdk.models.rooms.sessions.actions.ActionKickResponse;
import com.telnyx.sdk.models.rooms.sessions.actions.ActionsParticipantsRequest;

ActionKickParams params = ActionKickParams.builder()
    .roomSessionId("0ccc7b54-4df3-4bca-a65a-3da1ecc777f0")
    .actionsParticipantsRequest(ActionsParticipantsRequest.builder().build())
    .build();
ActionKickResponse response = client.rooms().sessions().actions().kick(params);
Returns: 
result
(string)
POST /room_sessions/{room_session_id}/actions/kick
可选参数：
exclude
（字符串数组）、
participants
（对象）
java
import com.telnyx.sdk.models.rooms.sessions.actions.ActionKickParams;
import com.telnyx.sdk.models.rooms.sessions.actions.ActionKickResponse;
import com.telnyx.sdk.models.rooms.sessions.actions.ActionsParticipantsRequest;

ActionKickParams params = ActionKickParams.builder()
    .roomSessionId("0ccc7b54-4df3-4bca-a65a-3da1ecc777f0")
    .actionsParticipantsRequest(ActionsParticipantsRequest.builder().build())
    .build();
ActionKickResponse response = client.rooms().sessions().actions().kick(params);
返回参数：
result
（字符串）

Mute participants in room session.

静音房间会话参与者

POST /room_sessions/{room_session_id}/actions/mute
Optional: 
exclude
(array[string]), 
participants
(object)
java
import com.telnyx.sdk.models.rooms.sessions.actions.ActionMuteParams;
import com.telnyx.sdk.models.rooms.sessions.actions.ActionMuteResponse;
import com.telnyx.sdk.models.rooms.sessions.actions.ActionsParticipantsRequest;

ActionMuteParams params = ActionMuteParams.builder()
    .roomSessionId("0ccc7b54-4df3-4bca-a65a-3da1ecc777f0")
    .actionsParticipantsRequest(ActionsParticipantsRequest.builder().build())
    .build();
ActionMuteResponse response = client.rooms().sessions().actions().mute(params);
Returns: 
result
(string)
POST /room_sessions/{room_session_id}/actions/mute
可选参数：
exclude
（字符串数组）、
participants
（对象）
java
import com.telnyx.sdk.models.rooms.sessions.actions.ActionMuteParams;
import com.telnyx.sdk.models.rooms.sessions.actions.ActionMuteResponse;
import com.telnyx.sdk.models.rooms.sessions.actions.ActionsParticipantsRequest;

ActionMuteParams params = ActionMuteParams.builder()
    .roomSessionId("0ccc7b54-4df3-4bca-a65a-3da1ecc777f0")
    .actionsParticipantsRequest(ActionsParticipantsRequest.builder().build())
    .build();
ActionMuteResponse response = client.rooms().sessions().actions().mute(params);
返回参数：
result
（字符串）

Unmute participants in room session.

取消房间会话参与者静音

POST /room_sessions/{room_session_id}/actions/unmute
Optional: 
exclude
(array[string]), 
participants
(object)
java
import com.telnyx.sdk.models.rooms.sessions.actions.ActionUnmuteParams;
import com.telnyx.sdk.models.rooms.sessions.actions.ActionUnmuteResponse;
import com.telnyx.sdk.models.rooms.sessions.actions.ActionsParticipantsRequest;

ActionUnmuteParams params = ActionUnmuteParams.builder()
    .roomSessionId("0ccc7b54-4df3-4bca-a65a-3da1ecc777f0")
    .actionsParticipantsRequest(ActionsParticipantsRequest.builder().build())
    .build();
ActionUnmuteResponse response = client.rooms().sessions().actions().unmute(params);
Returns: 
result
(string)
POST /room_sessions/{room_session_id}/actions/unmute
可选参数：
exclude
（字符串数组）、
participants
（对象）
java
import com.telnyx.sdk.models.rooms.sessions.actions.ActionUnmuteParams;
import com.telnyx.sdk.models.rooms.sessions.actions.ActionUnmuteResponse;
import com.telnyx.sdk.models.rooms.sessions.actions.ActionsParticipantsRequest;

ActionUnmuteParams params = ActionUnmuteParams.builder()
    .roomSessionId("0ccc7b54-4df3-4bca-a65a-3da1ecc777f0")
    .actionsParticipantsRequest(ActionsParticipantsRequest.builder().build())
    .build();
ActionUnmuteResponse response = client.rooms().sessions().actions().unmute(params);
返回参数：
result
（字符串）

View a list of room participants.

查询房间会话参与者列表

GET /room_sessions/{room_session_id}/participants
java
import com.telnyx.sdk.models.rooms.sessions.SessionRetrieveParticipantsPage;
import com.telnyx.sdk.models.rooms.sessions.SessionRetrieveParticipantsParams;

SessionRetrieveParticipantsPage page = client.rooms().sessions().retrieveParticipants("0ccc7b54-4df3-4bca-a65a-3da1ecc777f0");
Returns: 
context
(string), 
id
(uuid), 
joined_at
(date-time), 
left_at
(date-time), 
record_type
(string), 
session_id
(uuid), 
updated_at
(date-time)
GET /room_sessions/{room_session_id}/participants
java
import com.telnyx.sdk.models.rooms.sessions.SessionRetrieveParticipantsPage;
import com.telnyx.sdk.models.rooms.sessions.SessionRetrieveParticipantsParams;

SessionRetrieveParticipantsPage page = client.rooms().sessions().retrieveParticipants("0ccc7b54-4df3-4bca-a65a-3da1ecc777f0");
返回参数：
context
（字符串）、
id
（uuid）、
joined_at
（日期时间）、
left_at
（日期时间）、
record_type
（字符串）、
session_id
（uuid）、
updated_at
（日期时间）

View a list of rooms.

查询房间列表

GET /rooms
java
import com.telnyx.sdk.models.rooms.RoomListPage;
import com.telnyx.sdk.models.rooms.RoomListParams;

RoomListPage page = client.rooms().list();
Returns: 
active_session_id
(uuid), 
created_at
(date-time), 
enable_recording
(boolean), 
id
(uuid), 
max_participants
(integer), 
record_type
(string), 
sessions
(array[object]), 
unique_name
(string), 
updated_at
(date-time), 
webhook_event_failover_url
(uri), 
webhook_event_url
(uri), 
webhook_timeout_secs
(integer)
GET /rooms
java
import com.telnyx.sdk.models.rooms.RoomListPage;
import com.telnyx.sdk.models.rooms.RoomListParams;

RoomListPage page = client.rooms().list();
返回参数：
active_session_id
（uuid）、
created_at
（日期时间）、
enable_recording
（布尔值）、
id
（uuid）、
max_participants
（整数）、
record_type
（字符串）、
sessions
（对象数组）、
unique_name
（字符串）、
updated_at
（日期时间）、
webhook_event_failover_url
（URI）、
webhook_event_url
（URI）、
webhook_timeout_secs
（整数）

Create a room.

创建房间

Synchronously create a Room.
POST /rooms
Optional: 
enable_recording
(boolean), 
max_participants
(integer), 
unique_name
(string), 
webhook_event_failover_url
(uri), 
webhook_event_url
(uri), 
webhook_timeout_secs
(integer)
java
import com.telnyx.sdk.models.rooms.RoomCreateParams;
import com.telnyx.sdk.models.rooms.RoomCreateResponse;

RoomCreateParams params = RoomCreateParams.builder()

    .uniqueName("my-meeting-room")

    .maxParticipants(10)

    .build();

RoomCreateResponse room = client.rooms().create(params);
Returns: 
active_session_id
(uuid), 
created_at
(date-time), 
enable_recording
(boolean), 
id
(uuid), 
max_participants
(integer), 
record_type
(string), 
sessions
(array[object]), 
unique_name
(string), 
updated_at
(date-time), 
webhook_event_failover_url
(uri), 
webhook_event_url
(uri), 
webhook_timeout_secs
(integer)
同步创建房间。
POST /rooms
可选参数：
enable_recording
（布尔值）、
max_participants
（整数）、
unique_name
（字符串）、
webhook_event_failover_url
（URI）、
webhook_event_url
（URI）、
webhook_timeout_secs
（整数）
java
import com.telnyx.sdk.models.rooms.RoomCreateParams;
import com.telnyx.sdk.models.rooms.RoomCreateResponse;

RoomCreateParams params = RoomCreateParams.builder()

    .uniqueName("my-meeting-room")

    .maxParticipants(10)

    .build();

RoomCreateResponse room = client.rooms().create(params);
返回参数：
active_session_id
（uuid）、
created_at
（日期时间）、
enable_recording
（布尔值）、
id
（uuid）、
max_participants
（整数）、
record_type
（字符串）、
sessions
（对象数组）、
unique_name
（字符串）、
updated_at
（日期时间）、
webhook_event_failover_url
（URI）、
webhook_event_url
（URI）、
webhook_timeout_secs
（整数）

View a room.

查询单个房间信息

GET /rooms/{room_id}
java
import com.telnyx.sdk.models.rooms.RoomRetrieveParams;
import com.telnyx.sdk.models.rooms.RoomRetrieveResponse;

RoomRetrieveResponse room = client.rooms().retrieve("0ccc7b54-4df3-4bca-a65a-3da1ecc777f0");
Returns: 
active_session_id
(uuid), 
created_at
(date-time), 
enable_recording
(boolean), 
id
(uuid), 
max_participants
(integer), 
record_type
(string), 
sessions
(array[object]), 
unique_name
(string), 
updated_at
(date-time), 
webhook_event_failover_url
(uri), 
webhook_event_url
(uri), 
webhook_timeout_secs
(integer)
GET /rooms/{room_id}
java
import com.telnyx.sdk.models.rooms.RoomRetrieveParams;
import com.telnyx.sdk.models.rooms.RoomRetrieveResponse;

RoomRetrieveResponse room = client.rooms().retrieve("0ccc7b54-4df3-4bca-a65a-3da1ecc777f0");
返回参数：
active_session_id
（uuid）、
created_at
（日期时间）、
enable_recording
（布尔值）、
id
（uuid）、
max_participants
（整数）、
record_type
（字符串）、
sessions
（对象数组）、
unique_name
（字符串）、
updated_at
（日期时间）、
webhook_event_failover_url
（URI）、
webhook_event_url
（URI）、
webhook_timeout_secs
（整数）

Update a room.

更新房间信息

Synchronously update a Room.
PATCH /rooms/{room_id}
Optional: 
enable_recording
(boolean), 
max_participants
(integer), 
unique_name
(string), 
webhook_event_failover_url
(uri), 
webhook_event_url
(uri), 
webhook_timeout_secs
(integer)
java
import com.telnyx.sdk.models.rooms.RoomUpdateParams;
import com.telnyx.sdk.models.rooms.RoomUpdateResponse;

RoomUpdateResponse room = client.rooms().update("0ccc7b54-4df3-4bca-a65a-3da1ecc777f0");
Returns: 
active_session_id
(uuid), 
created_at
(date-time), 
enable_recording
(boolean), 
id
(uuid), 
max_participants
(integer), 
record_type
(string), 
sessions
(array[object]), 
unique_name
(string), 
updated_at
(date-time), 
webhook_event_failover_url
(uri), 
webhook_event_url
(uri), 
webhook_timeout_secs
(integer)
同步更新房间信息。
PATCH /rooms/{room_id}
可选参数：
enable_recording
（布尔值）、
max_participants
（整数）、
unique_name
（字符串）、
webhook_event_failover_url
（URI）、
webhook_event_url
（URI）、
webhook_timeout_secs
（整数）
java
import com.telnyx.sdk.models.rooms.RoomUpdateParams;
import com.telnyx.sdk.models.rooms.RoomUpdateResponse;

RoomUpdateResponse room = client.rooms().update("0ccc7b54-4df3-4bca-a65a-3da1ecc777f0");
返回参数：
active_session_id
（uuid）、
created_at
（日期时间）、
enable_recording
（布尔值）、
id
（uuid）、
max_participants
（整数）、
record_type
（字符串）、
sessions
（对象数组）、
unique_name
（字符串）、
updated_at
（日期时间）、
webhook_event_failover_url
（URI）、
webhook_event_url
（URI）、
webhook_timeout_secs
（整数）

Delete a room.

删除房间

Synchronously delete a Room. Participants from that room will be kicked out, they won't be able to join that room anymore, and you won't be charged anymore for that room.
DELETE /rooms/{room_id}
java
import com.telnyx.sdk.models.rooms.RoomDeleteParams;

client.rooms().delete("0ccc7b54-4df3-4bca-a65a-3da1ecc777f0");
同步删除房间。该房间内的所有参与者会被踢出，无法再加入该房间，同时不会再产生该房间的相关费用。
DELETE /rooms/{room_id}
java
import com.telnyx.sdk.models.rooms.RoomDeleteParams;

client.rooms().delete("0ccc7b54-4df3-4bca-a65a-3da1ecc777f0");

Create Client Token to join a room.

生成加入房间的客户端令牌

Synchronously create an Client Token to join a Room. Client Token is necessary to join a Telnyx Room. Client Token will expire after 
token_ttl_secs
, a Refresh Token is also provided to refresh a Client Token, the Refresh Token expires after 
refresh_token_ttl_secs
.
POST /rooms/{room_id}/actions/generate_join_client_token
Optional: 
refresh_token_ttl_secs
(integer), 
token_ttl_secs
(integer)
java
import com.telnyx.sdk.models.rooms.actions.ActionGenerateJoinClientTokenParams;
import com.telnyx.sdk.models.rooms.actions.ActionGenerateJoinClientTokenResponse;

ActionGenerateJoinClientTokenResponse response = client.rooms().actions().generateJoinClientToken("0ccc7b54-4df3-4bca-a65a-3da1ecc777f0");
Returns: 
refresh_token
(string), 
refresh_token_expires_at
(date-time), 
token
(string), 
token_expires_at
(date-time)
同步生成加入房间所需的客户端令牌。客户端令牌是加入Telnyx房间的必要凭证，会在
token_ttl_secs
后过期，同时会返回一个刷新令牌用于更新客户端令牌，刷新令牌会在
refresh_token_ttl_secs
后过期。
POST /rooms/{room_id}/actions/generate_join_client_token
可选参数：
refresh_token_ttl_secs
（整数）、
token_ttl_secs
（整数）
java
import com.telnyx.sdk.models.rooms.actions.ActionGenerateJoinClientTokenParams;
import com.telnyx.sdk.models.rooms.actions.ActionGenerateJoinClientTokenResponse;

ActionGenerateJoinClientTokenResponse response = client.rooms().actions().generateJoinClientToken("0ccc7b54-4df3-4bca-a65a-3da1ecc777f0");
返回参数：
refresh_token
（字符串）、
refresh_token_expires_at
（日期时间）、
token
（字符串）、
token_expires_at
（日期时间）

Refresh Client Token to join a room.

刷新加入房间的客户端令牌

Synchronously refresh an Client Token to join a Room. Client Token is necessary to join a Telnyx Room. Client Token will expire after 
token_ttl_secs
.
POST /rooms/{room_id}/actions/refresh_client_token
— Required: 
refresh_token
Optional: 
token_ttl_secs
(integer)
java
import com.telnyx.sdk.models.rooms.actions.ActionRefreshClientTokenParams;
import com.telnyx.sdk.models.rooms.actions.ActionRefreshClientTokenResponse;

ActionRefreshClientTokenParams params = ActionRefreshClientTokenParams.builder()
    .roomId("0ccc7b54-4df3-4bca-a65a-3da1ecc777f0")
    .refreshToken("eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJ0ZWxueXhfdGVsZXBob255IiwiZXhwIjoxNTkwMDEwMTQzLCJpYXQiOjE1ODc1OTA5NDMsImlzcyI6InRlbG55eF90ZWxlcGhvbnkiLCJqdGkiOiJiOGM3NDgzNy1kODllLTRhNjUtOWNmMi0zNGM3YTZmYTYwYzgiLCJuYmYiOjE1ODc1OTA5NDIsInN1YiI6IjVjN2FjN2QwLWRiNjUtNGYxMS05OGUxLWVlYzBkMWQ1YzZhZSIsInRlbF90b2tlbiI6InJqX1pra1pVT1pNeFpPZk9tTHBFVUIzc2lVN3U2UmpaRmVNOXMtZ2JfeENSNTZXRktGQUppTXlGMlQ2Q0JSbWxoX1N5MGlfbGZ5VDlBSThzRWlmOE1USUlzenl6U2xfYURuRzQ4YU81MHlhSEd1UlNZYlViU1ltOVdJaVEwZz09IiwidHlwIjoiYWNjZXNzIn0.gNEwzTow5MLLPLQENytca7pUN79PmPj6FyqZWW06ZeEmesxYpwKh0xRtA0TzLh6CDYIRHrI8seofOO0YFGDhpQ")
    .build();
ActionRefreshClientTokenResponse response = client.rooms().actions().refreshClientToken(params);
Returns: 
token
(string), 
token_expires_at
(date-time)
同步刷新加入房间所需的客户端令牌。客户端令牌是加入Telnyx房间的必要凭证，会在
token_ttl_secs
后过期。
POST /rooms/{room_id}/actions/refresh_client_token
— 必填参数：
refresh_token
可选参数：
token_ttl_secs
（整数）
java
import com.telnyx.sdk.models.rooms.actions.ActionRefreshClientTokenParams;
import com.telnyx.sdk.models.rooms.actions.ActionRefreshClientTokenResponse;

ActionRefreshClientTokenParams params = ActionRefreshClientTokenParams.builder()
    .roomId("0ccc7b54-4df3-4bca-a65a-3da1ecc777f0")
    .refreshToken("eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJ0ZWxueXhfdGVsZXBob255IiwiZXhwIjoxNTkwMDEwMTQzLCJpYXQiOjE1ODc1OTA5NDMsImlzcyI6InRlbG55eF90ZWxlcGhvbnkiLCJqdGkiOiJiOGM3NDgzNy1kODllLTRhNjUtOWNmMi0zNGM3YTZmYTYwYzgiLCJuYmYiOjE1ODc1OTA5NDIsInN1YiI6IjVjN2FjN2QwLWRiNjUtNGYxMS05OGUxLWVlYzBkMWQ1YzZhZSIsInRlbF90b2tlbiI6InJqX1pra1pVT1pNeFpPZk9tTHBFVUIzc2lVN3U2UmpaRmVNOXMtZ2JfeENSNTZXRktGQUppTXlGMlQ2Q0JSbWxoX1N5MGlfbGZ5VDlBSThzRWlmOE1USUlzenl6U2xfYURuRzQ4YU81MHlhSEd1UlNZYlViU1ltOVdJaVEwZz09IiwidHlwIjoiYWNjZXNzIn0.gNEwzTow5MLLPLQENytca7pUN79PmPj6FyqZWW06ZeEmesxYpwKh0xRtA0TzLh6CDYIRHrI8seofOO0YFGDhpQ")
    .build();
ActionRefreshClientTokenResponse response = client.rooms().actions().refreshClientToken(params);
返回参数：
token
（字符串）、
token_expires_at
（日期时间）

View a list of room sessions.

查询指定房间的会话列表

GET /rooms/{room_id}/sessions
java
import com.telnyx.sdk.models.rooms.sessions.SessionList1Page;
import com.telnyx.sdk.models.rooms.sessions.SessionList1Params;

SessionList1Page page = client.rooms().sessions().list1("0ccc7b54-4df3-4bca-a65a-3da1ecc777f0");
Returns: 
active
(boolean), 
created_at
(date-time), 
ended_at
(date-time), 
id
(uuid), 
participants
(array[object]), 
record_type
(string), 
room_id
(uuid), 
updated_at
(date-time)
GET /rooms/{room_id}/sessions
java
import com.telnyx.sdk.models.rooms.sessions.SessionList1Page;
import com.telnyx.sdk.models.rooms.sessions.SessionList1Params;

SessionList1Page page = client.rooms().sessions().list1("0ccc7b54-4df3-4bca-a65a-3da1ecc777f0");
返回参数：
active
（布尔值）、
created_at
（日期时间）、
ended_at
（日期时间）、
id
（uuid）、
participants
（对象数组）、
record_type
（字符串）、
room_id
（uuid）、
updated_at
（日期时间）