聊天室管理
云通訊平臺為開發者提供了聊天室管理相關接口，客戶可以調用該接口實現聊天室功能。聊天室管理接口包括創建聊天室和切換聊天室狀態接口。聊天室功能要和客戶端SDK接口結合使用，比如加入聊天室、向聊天室發送消息、獲取聊天室信息等操作，需要調用SDK接口實現。具體請參考相應終端開發文檔。
1、創建聊天室
1.1、請求地址
POST /{SoftVersion}/Application/{appId}/IM/createChatRoom
1.2、請求包頭
請參閱《鑒權說明》
1.3、請求包體
| 屬性 | 類型 | 約束 | 說明 |
|---|---|---|---|
| creator | String | 必選 | 房間創建者（用戶登錄賬號） |
| name | String | 必選 | 房間名稱（最大長度64個字符，只支持中文、字母、數字、下劃線） |
| declared | String | 可選 | 公告（最大長度320個字符） |
| ext | String | 可選 | 擴展字段（最大長度8192個字符） |
| pushUrl | String | 可選 | 推流地址，與直播相關 |
| pullUrl | String | 可選 | 拉流地址，與直播相關 |
1.3.1、請求示例
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=
{"chatRoomName":"測試房間","creator":"123456789abcd","declared":"Hello",
"ext":"hi","pushUrl":"http//:url","pullUrl":"http//:url"}
1.4、響應包體
| 屬性 | 類型 | 約束 | 說明 |
|---|---|---|---|
| statusCode | String | 必選 | 請求狀態碼，取值000000（成功） |
| roomId | String | 必選 | 房間ID(32位),生成規則yyyyMMdd+15位隨機數+HHmmssSSS |
1.4.1、響應示例
HTTP/1.1 200 OK
Content-Length: 641
{"statusCode":"000000","roomId":"20170710125498756321589105823121"}
2、切換聊天室狀態
2.1、請求地址
POST /{SoftVersion}/Application/{appId}/IM/ToggleState
2.2、請求包頭
請參閱《鑒權說明》
2.3、請求包體
| 屬性 | 類型 | 約束 | 說明 |
|---|---|---|---|
| roomId | String | 必選 | 房間ID |
| operator | String | 必選 | 用戶賬號（房間創建者） |
| state | String | 必選 | 狀態 1.打開 2.關閉 |
2.3.1、請求示例
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"}
2.4、響應包體
| 屬性 | 類型 | 約束 | 說明 |
|---|---|---|---|
| statusCode | String | 必選 | 請求狀態碼，取值000000（成功） |
2.4.1、響應示例
HTTP/1.1 200 OK
Content-Length: 641
{"statusCode":"000000"}
文檔更新時間：2017年7月11日