- API在线调试指南
- IM账号管理
- 用户名片管理
- 好友管理
- 静音管理
- 黑名单管理
- 消息管理
- 会话功能
- 群组功能
- 聊天室功能
- 聊天室管理
- 聊天室成员
- 聊天室队列
- 广播消息管理
- 系统通知管理
- 发布订阅
- 翻译
创建聊天室
开发中
POST
/im/v2/chatrooms
请求参数
Header 参数
AppKey
string
必需
默认值:
{{AppKey}}
X-custom-traceid
string
可选
默认值:
{% mock 'uuid' %}
Nonce
string
必需
默认值:
{{Nonce}}
CurTime
string
必需
默认值:
{{CurTime}}
CheckSum
string
必需
默认值:
{{CheckSum}}
Body 参数application/json
creator
string
必需
room_name
string
必需
announcement
string
可选
live_url
string
可选
extension
string
可选
antispam_business_id
string
可选
delay_close_policy
string
可选
delay_seconds
string
可选
queue_level
enum<integer>
可选
枚举值:
01
in_out_notification
boolean
可选
示例
{
"antispam_business_id": "{\"textbid\":\"39ab456a6469ab6404a54de316672ffd\"}",
"announcement": "announcement",
"creator": "yx29",
"extension": "extension",
"room_name": "room_name",
"live_url": "broadcast_url",
"queue_level": 0,
"delay_close_policy": 0,
"delay_seconds": 0,
"in_out_notification": true
}示例代码
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://open.yunxinapi.com/im/v2/chatrooms' \
--header 'AppKey;' \
--header 'X-custom-traceid: {% mock '\''uuid'\'' %}' \
--header 'Nonce;' \
--header 'CurTime;' \
--header 'CheckSum;' \
--header 'Content-Type: application/json' \
--data-raw '{
"antispam_business_id": "{\"textbid\":\"39ab456a6469ab6404a54de316672ffd\"}",
"announcement": "announcement",
"creator": "yx29",
"extension": "extension",
"room_name": "room_name",
"live_url": "broadcast_url",
"queue_level": 0,
"delay_close_policy": 0,
"delay_seconds": 0,
"in_out_notification": true
}'返回响应
🟢200成功
application/json
Body
code
integer
必需
msg
string
必需
data
object
必需
valid
boolean
必需
extension
string
必需
creator
string
必需
announcement
string
必需
room_name
string
必需
chat_banned
boolean
必需
live_url
string
必需
room_id
integer
必需
queue_level
integer
必需
示例
{
"code": 200,
"msg": "success",
"data": {
"valid": true,
"extension": "extension",
"creator": "yx29",
"announcement": "announcement",
"room_name": "room_name",
"chat_banned": false,
"live_url": "broadcast_url",
"room_id": 1605537148,
"queue_level": 0
}
}修改于 2024-02-29 02:49:41