跳到主要内容

创建聊天室

本文档介绍如何通过 Server API 创建单个聊天室，支持配置聊天室的销毁类型、全体成员禁言、全体禁言白名单以及聊天室自定义属性。如需设置销毁类型，请确保您已了解聊天室销毁机制。

该 API 替代了已废弃的创建聊天室（废弃）接口。

请求方法​

POST： https://数据中心域名/chatroom/create_new.json

频率限制： 每秒 100 次

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

正文参数​

HTTP 请求正文数据格式为 application/x-www-form-urlencoded，支持以下 HTTP 表单参数：

参数类型必传说明
chatroomIdString是聊天室 ID。
destroyTypeInt否指定聊天室的销毁类型，默认为 0。
• 0: 不活跃时销毁。聊天室创建后，默认不活跃时长达到 60 分钟后自动销毁。您可以通过 destroyTime 参数延长不活跃时长。
• 1: 固定时间销毁。聊天室创建后，默认存活 60 分钟后自动销毁。您可以通过 destroyTime 参数延长存活时长。
您也可以在聊天室创建成功后修改销毁类型，详见设置聊天室销毁类型。
destroyTimeInt否设置聊天室的销毁时间，单位为分钟。
• 当 destroyType 为 0 时，此参数表示聊天室的不活跃时长，超过该时长后自动销毁。
• 当 destroyType 为 1 时，此参数表示聊天室的固定存活时长，超过该时长后自动销毁。
取值范围为 60 至 10080（7 天），默认值为 60。
isBanBoolean否是否开启聊天室全体成员禁言，默认为 false。您也可以在聊天室创建成功后再设置，详见设置聊天室全体禁言。
whiteUserIdsArray否全体禁言白名单的用户 ID 列表。在此列表中的用户不受全体禁言影响。支持批量添加，最多不超过 20 个。您也可以在聊天室创建成功后再设置，详见加入聊天室全体禁言白名单。
entryOwnerIdString否聊天室自定义属性的所属用户 ID。仅在开通聊天室自定义属性服务后可使用，且必须与 entryInfo 字段一起使用。如果未开启服务，或者设置该字段时未同时传入 entryInfo，API 会返回创建失败。仅支持 1 个用户 ID。您也可以在聊天室创建成功后再设置，详见聊天室属性概述。
entryInfoString否聊天室自定义属性的键值（KV）对，以 JSON 格式表示。仅在开通聊天室自定义属性服务后可使用，且必须与 entryOwnerId 字段一起使用。支持批量设置，一次最多 20 个。
• Key：属性名，支持大小写英文字母、数字及特殊符号 +、=、-、_ 的组合，区分大小写，最大长度 128 字符。
• Value：属性值，最大长度 4096 字符。
您也可以在聊天室创建成功后再设置，详见聊天室属性概述。

请求示例​

HTTP
POST /chatroom/create_new.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
X-Request-ID: XXXXXXXXXXXXXXXXXXXXXXXXXXXX (最大长度 36)

chatroomId=gid1&destroyType=1&destroyTime=120

返回结果​

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

返回值返回类型说明
codeInt返回码。200 表示处理成功。

返回结果示例​

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

{"code":200}
最后于 更新