跳到主要内容

创建聊天室

创建单个聊天室，支持配置销毁类型、是否全体禁言、全体禁言白名单，和聊天室自定义属性。如需设置销毁类型，请确保您已了解聊天室销毁机制。

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

请求方法​

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

频率限制： 每秒钟限 100 次

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

正文参数​

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

参数类型必传说明
chatroomIdString是聊天室 ID。
destroyTypeint否指定聊天室的销毁类型。0：默认值，表示不活跃时销毁。默认情况下，所有聊天室的自动销毁方式均为不活跃时销毁，一旦不活跃长达到 60 分钟即被销毁，可通过 destroyTime 延长该时间。1：固定时间销毁，设置为该类型后，聊天室默认在创建 60 分钟后自动销毁，可通过 destroyTime 设置更长的存活时间。您也可以在聊天室创建成功后再设置，详见设置聊天室销毁类型。
destroyTimeint否设置聊天室销毁时间。在 destroyType=0 时，表示聊天室应在不活跃达到该时长时自动销毁。在 destroyType=1 时，表示聊天室应在创建以后存活时间达到该时长后自动销毁。单位为分钟，最小值 60 分钟，最大 10080 分钟（7 天）。如果未设置，默认 60 分钟。
isBanboolean否是否禁言聊天室全体成员，默认 false。您也可以在聊天室创建成功后再设置，详见设置聊天室全体禁言。
whiteUserIdsarray否禁言白名单用户列表，支持批量设置，最多不超过 20 个。您也可以在聊天室创建成功后再设置，详见加入聊天室全体禁言白名单。
entryOwnerIdString否聊天室自定义属性的所属用户 ID。仅在开通聊天室自定义属性服务后可使用该字段，且必须与 entryInfo 字段一起使用。如果未开启服务，或者设置该字段时未同时传入 entryInfo，API 会返回创建失败。仅支持 1 个用户 ID。您也可以在聊天室创建成功后再设置，详见聊天室属性概述。
entryInfoString否聊天室自定义属性 KV 对，JSON 结构。仅在开通聊天室自定义属性服务后可使用该字段，必须与 entryOwnerId 字段一起使用。支持批量设置 KV 对，一次最多 20 个。Key 为属性名，支持大小写英文字母、数字、部分特殊符号 + = - _ 的组合方式，大小写敏感。最大长度 128 字符。Value 为属性值，最大长度 4096 个字符。您也可以在聊天室创建成功后再设置，详见聊天室属性概述。

请求示例​

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/1.1 200 OK
Content-Type: application/json; charset=utf-8
X-Request-ID: XXXXXXXXXXXXXXXXXXXXXXXXXXXX

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