聊天室管理
云通讯平台为开发者提供了聊天室管理相关接口,客户可以调用该接口实现聊天室功能。聊天室管理接口包括创建聊天室和切换聊天室状态接口。聊天室功能要和客户端SDK接口结合使用,比如加入聊天室、向聊天室发送消息、获取聊天室信息等操作,需要调用SDK接口实现。具体请参考相应终端开发文档。
创建聊天室
1. 请求地址
- POST /{SoftVersion}/Application/{appId}/IM/createChatRoom
2. 请求包头
请参阅《鉴权说明》
3. 请求包体
属性 | 类型 | 约束 | 说明 |
creator | String | 必选 | 房间创建者(用户登录账号) |
name | String | 必选 | 房间名称(最大长度64个字符,只支持中文、字母、数字、下划线) |
declared | String | 可选 | 公告(最大长度320个字符) |
ext | String | 可选 | 扩展字段(最大长度8192个字符) |
pushUrl | String | 可选 | 推流地址,与直播相关 |
pullUrl | String | 可选 | 拉流地址,与直播相关 |
4. 请求示例
- POST/2013-12-26/Application/8a48b75153eae5150154057765c92dc6/IM/createChatRoom?sig=155EAA68C5DFB6B762A42D88F406ABCD
- HTTP/1.1
- Host: 192.168.0.1:8883
- Accept:application/json;
- Content-Type:application/json;charset=utf-8;
- Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyMDE=
- {"name":"测试房间","creator":"123456789abcd","declared":"Hello", "ext":"hi","pushUrl":"http//:url",
- "pullUrl":"http//:url"}
5. 响应包体
属性 | 类型 | 约束 | 说明 |
statusCode | String | 必选 | 请求状态码,取值000000(成功) |
roomId | String | 必选 | 房间ID(12位) |
6. 响应示例
- HTTP/1.1 200 OK
- Content-Length: 641
- {"statusCode":"000000","roomId":"20170710125498756321589105823121"}
切换聊天室状态
1. 请求地址
- POST /{SoftVersion}/Application/{appId}/IM/ToggleState
2. 请求包头
请参阅《鉴权说明》
3. 请求包体
属性 | 类型 | 约束 | 说明 |
roomId | String | 必选 | 房间ID |
operator | String | 必选 | 用户账号(房间创建者) |
state | String | 必选 | 状态 1.打开 2.关闭 3.销毁 |
4. 请求示例
- POST/2013-12-26/Application/8a48b75153eae5150154057765c92dc6/IM/ToggleState?sig=155EAA68C5DFB6B762A42D88F406ABCD
- HTTP/1.1
- Host: 192.168.0.1:8883
- Accept:application/json;
- Content-Type:application/json;charset=utf-8;
- Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyMDE=
- {"roomId ":"20170710125498756321589105823121","operator":"12345wert","state":"1"}
5. 响应包体
属性 | 类型 | 约束 | 说明 |
statusCode | String | 必选 | 请求状态码,取值000000(成功) |
6. 响应示例
- HTTP/1.1 200 OK
- Content-Length: 641
- {"statusCode":"000000"}