服務端接口說明主要包含:鑒權說明、群組管理、成員管理、服務器端推送、獲取歷史記錄等。
1、Base URL
文檔中所有被引用的地址都有如下Base URL:
注意:
為了確保數據隱私,云通訊平臺的REST API是通過HTTPS方式請求。
2、統一請求包頭
業務URL格式
Base URL與業務URL相拼接為完整請求URL,其中{}內為可變參數。
參數func和funcdes根據接口填寫;
參數appId為應用ID,可從官網創建獲得;
參數SigParameter根據不同鑒權方式,做MD5加密后得到,參考后文的鑒權方式說明。
應用鑒權:
/Application/{appId}/{func}/{funcdes}?sig={SigParameter}
例如:
以應用鑒權的服務器端推送接口為例完整的URL為:https://imapp.yuntongxun.com:8883/2013-12-26/Application/{appId}/IM/PushMsg?sig={SigParameter}
HTTP標準包頭字段(必填)
Accept:application/json; Content-Type:application/json;charset=utf-8; Content-Length:256; Authorization:XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
屬性說明
屬性 | 類型 | 約束 | 說明 |
---|---|---|---|
appId | String | 必選 | 應用ID。由32個英文字母和阿拉伯數字組成的唯一標識符 |
SigParameter | String | 必選 | 驗證參數,請求URL必須帶有此參數,生成規則詳見下方說明 |
Accept | String | 必選 | 客戶端響應接收數據格式:application/xml、application/json |
Content-Type | String | 必選 | 類型:application/json;charset=utf-8 |
Authorization | String | 必選 | 驗證信息,生成規則詳見下方說明 |
func | String | 可選 | 業務功能,根據業務的需要添加 |
funcdes | String | 可選 | 業務操作,業務功能的各類具體操作分支 |
應用鑒權方式
1. SigParameter是REST API 驗證參數
? URL后必須帶有sig參數,例如:sig=AAABBBCCCDDDEEEFFFGGG。
? 使用MD5加密(應用Id + 應用授權令牌 +時間戳)。其中應用Id和應用授權令牌分別對應管理控制臺上應用詳情中的 APP ID和APP TOKEN。
? 時間戳是當前系統時間,格式"yyyyMMddHHmmss"。時間戳有效時間為24小時,如:20140416142030
2. Authorization是包頭驗證信息
? 使用Base64編碼(應用Id+ 冒號 + 時間戳)
? 冒號為英文冒號
? 時間戳是當前系統時間,格式"yyyyMMddHHmmss",需與SigParameter中時間戳相同。
3. func描述業務功能,funcdes描述業務功能的具體操作
例如:/IM/createChatRoom