跳到主要内容

绑定音视频房间

聊天室与音视频房间绑定成功后,当聊天室达到预设的自动销毁条件时,服务端会先检测已绑定的音视频房间(RTCRoomId)是否仍存在:

  • 如果绑定的音视频房间仍存在,则则阻止聊天室自动销毁。。
  • 如果绑定的音视频房间已销毁,则直接销毁聊天室。

该接口仅创建从聊天室到音视频房间的单向绑定关系。因此在绑定音视频房间后,音视频房间的主动销毁或自动销毁,并不会直接触发聊天室房间的销毁。关于音视频房间的销毁机制,详见音视频房间销毁机制

适用场景

聊天室具有自动销毁机制。在使用 RTC 业务的 App 中,可能会配合使用 IM SDK 的聊天室业务实现直播聊天、弹幕、属性记录等功能。这种情况下,可以考虑将聊天室与音视频房间绑定,确保聊天室不会在语聊、直播结束前销毁,以免丢失关键数据。

在单独使用聊天室业务情况的下,无需调用该接口。

提示

关于聊天室自动销毁逻辑的说明

聊天室具有自动销毁机制,默认情况下所有聊天室会在不活跃(连续时间段内无成员进出且无新消息)达到 1 小时后踢出所有成员并自动销毁,可延长该时间,也可配置为定时自动销毁。详见聊天室销毁机制

请求方法

调用该接口必须传入聊天室 ID,因此必须在聊天室房间已创建成功之后调用。客户端调用加入聊天室接口时会自动完成创建与加入动作。

该接口不具备用户权限控制功能,建议由业务侧的房主或者主播角色用户加入聊天室房间成功后调用一次,其他用户无需调用。

POST: https://数据中心域名/chatroom/correlation/rtc.json

频率限制: 每秒钟限 100 次

签名规则: 所有服务端 API 请求均需要进行规则校验,详见 API 请求签名

正文参数

HTTP 请求正文中可包含如下 HTTP 表单参数:

参数类型必传说明
chatroomIdString聊天室 ID
rtcroomIdString音视频房间 ID

请求示例

POST /chatroom/correlation/rtc.json HTTP/1.1
Host: api.rong-api.com
App-Key: uwd1c0sxdlx2
Nonce: 14314
Timestamp: 1408710653491
Signature: 45beb7cc7307889a8e711219a47b7cf6a5b000e8
Content-Type: application/x-www-form-urlencoded

rtcroomId=jlk456j5&chatroomId=jlk456j6

返回结果

HTTP 响应正文包含具有以下结构的 JSON 对象:

返回值返回类型说明
codeNumber返回码,200 为正常。

返回结果示例

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{"code":200}