查詢使用者子帳號列表
更新時間:2022-12-09 10:19:57
介面描述
1、查询用户子账号列表
2、接口支持https协议
介面URL
http://api.polyv.net/live/v4/user/children/list
請求方式
GET
介面限制
1、介面同時支援HTTP、HTTPS,建議使用HTTPS確保介面安全,介面呼叫有頻率限制,詳細請查看
2、帳號需要開通子帳號功能
請求參數說明
| 參數名 | 必選 | 類型 | 說明 |
|---|---|---|---|
| appId | true | String | 帳號appId【詳見取得金鑰】 |
| timestamp | true | Long | 目前13位毫秒級時間戳記,3分鐘內有效 |
| sign | true | String | 簽名,為32位大寫的MD5值,產生簽名的appSecret金鑰作為通訊資料安全的關鍵資訊,嚴禁儲存在用戶端直接使用,所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料【詳見簽名產生規則】 |
| pageNumber | false | Integer | 頁碼,預設為1 |
| pageSize | false | Integer | 每頁資料大小,預設每頁顯示10筆資料,最大值不得超過1000 |
| childEmail | false | String | 子帳號信箱,多個信箱ID以,分隔,一次最多傳入100個 |
範例
http://api.polyv.net/live/v4/user/children/list?pageNumber=1&appId=frlr1zazn3&sign=39B651B783ED46083BBBD85A6E312645&pageSize=20×tamp=1670548047976
回應參數說明
| 參數名 | 類型 | 說明 |
|---|---|---|
| code | Integer | 狀態碼,與 http 狀態碼相同,用於確定基本的回應狀態 |
| status | String | 回應結果,由業務決定,成功回傳success,失敗回傳error |
| success | Boolean | 是否成功回應 |
| requestId | String | 請求ID,每次請求產生的唯一的 UUID,僅可用於排查、除錯,不應與業務掛鉤 |
| error | Object | 狀態碼非200時的錯誤資訊【詳見Error欄位說明】 |
| data | Object | 分頁回應資料【詳見data欄位說明】 |
Error參數說明
| 參數名 | 類型 | 說明 |
|---|---|---|
| code | Integer | 錯誤代碼,用於確定具體的錯誤原因 |
| desc | String | 錯誤描述,與 error.code 對應 |
Data參數說明
| 參數名 | 類型 | 說明 |
|---|---|---|
| pageNumber | Integer | 目前頁碼 |
| pageSize | Integer | 每頁資料量 |
| totalPages | Long | 頁面總數 |
| totalItems | Long | 總資料量 |
| contents | Array | 目前頁內容【詳見contents欄位說明】 |
Contents參數說明
| 參數名 | 類型 | 說明 |
|---|---|---|
| childUserId | String | 子帳號使用者Id |
| childName | String | 子帳號使用者名稱 |
| childEmail | String | 子帳號信箱 |
| description | String | 描述 |
| telephone | String | 手機號碼 |
| status | String | 狀態 NORMAL:正常 FROZEN:凍結 DELETE:刪除 |
| organizationId | Integer | 所屬使用者組織架構ID |
| organizationName | String | 所屬使用者組織架構名稱 |
| roleId | Integer | 所屬角色ID |
| roleName | String | 所屬角色名稱 |
| createdTime | Long | 建立時間,13位毫秒級時間戳 |
Java請求範例
快速接入基礎程式碼請下載相關依賴原始碼, 點擊下載原始碼 ,下載後加入到自己的原始碼工程中即可。測試案例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下載檔案中。
強烈建議您使用直播Java SDK完成API的功能對接,直播Java SDK 對API呼叫邏輯、異常處理、資料簽名、HTTP請求執行緒池進行了統一封裝和最佳化。
private final Logger log = LoggerFactory.getLogger(getClass());
/**
* 查询用户子账号列表
* @throws IOException
* @throws NoSuchAlgorithmException
*/
@Test
public void getUserChildrenListTest() throws IOException, NoSuchAlgorithmException {
//公共参数,填写自己的实际参数
String appId = super.appId;
String appSecret = super.appSecret;
String timestamp = String.valueOf(System.currentTimeMillis());
//业务参数
String url = "http://api.polyv.net/live/v4/user/children/list";
String pageNumber = "1";
String pageSize = "20";
//http 调用逻辑
Map<String, String> requestMap = new HashMap<>();
requestMap.put("appId", appId);
requestMap.put("timestamp", timestamp);
requestMap.put("pageNumber", pageNumber);
requestMap.put("pageSize", pageSize);
requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
String response = HttpUtil.get(url, requestMap);
log.info("测试查询用户子账号列表成功:{}", response);
//do somethings
}
回應範例
系統全域錯誤說明詳見全域錯誤說明
成功範例
{
"code": 200,
"status": "success",
"requestId": "ea917b23a1114d82b16dd9ad4ae89b31.65.16704878229605481",
"data": {
"pageNumber": 1,
"pageSize": 10,
"totalPages": 1,
"totalItems": 1,
"contents": [
{
"childUserId": "837228485a48",
"childName": "张三",
"childEmail": "zhangsan@qq.com",
"description": "开拓测试产品市场,并努力建立测试领域内的相关标准和规范",
"telephone": "12300000000",
"status": "NORMAL",
"organizationId": 2743,
"organizationName": "测试部门",
"roleId": 397,
"roleName": "直播测试员",
"createdTime": 1670421414000
}
]
},
"success": true
}
異常範例
{
"code": 400,
"status": "error",
"error": {
"code": 10003,
"desc": "时间戳过期"
},
"success": false
}
