云通訊平臺為開發者提供了獲取用戶在線狀態的接口,開發者調用該接口可以在服務器端獲取到用戶的在線狀態。
1、請求地址
POST /{SoftVersion}/Application/{appId}/IM/GetUserState
2、請求包頭
請參閱《鑒權說明》
3、請求包體
屬性 | 類型 | 約束 | 說明 |
---|---|---|---|
bodyType | String | 必選 | 包體類型 |
userAccounts | List | 必選 | 用戶賬號信息,最多100個 |
3.1、請求示例
POST/2013-12-26/Application/1234567890ertyui/IM/GetUserState?sig=155EAA68C5DFB6B762A42D88F406ABCD HTTP/1.1 Host: 192.168.0.1:8883 Accept:application/json; Content-Type:application/json;charset=utf-8; Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyMDExNTABCDE= {"bodyType":"json","userAccounts ":["123456789","987654321","12345421"]}
4、響應包體
屬性 | 類型 | 約束 | 說明 |
---|---|---|---|
statusCode | String | 必選 | 請求狀態碼,取值000000(成功)。 |
userStates | List | 可選 | 返回結果集 |
userAccount | String | List不為空時必選 | 用戶賬號 |
deviceType | String | List不為空時必選 | 1: Android Phone 2: iPhone 10: iPad 11: Android Pad 20: PC (Just Allowed phone 2 PC(Pad) login) 21: H5 22: MAC |
networkType | String | List不為空時必選 | 1: WIFI 2: 4G 3: 3G 5: 2G(EDGE) 6: other |
state | String | List不為空時必選 | 1:在線 2:離線 |
4.1、響應示例
HTTP/1.1 200 OK Content-Length: 28 {"statusCode":"000000","userStates":[{"userAccount":"123456789","deviceType":"2", "networkType":"1","state":"1"}]}
文檔更新時間:2018年1月4日