保利威文档中心

幫助中心

新增子帳號

更新時間:2023-04-04 09:31:23

介面說明

1、新增子账号
2、(timestamp, appId)参与sign签名,并和sign一起通过url传递,请求体参数不参与签名,通过post请求体传递【请设置请求头contentType:application/json】
3、接口支持https协议

介面URL

http://api.polyv.net/live/v4/user/children/create

線上API呼叫

請求方式

POST

介面限制

1、介面同時支援HTTP、HTTPS,建議使用HTTPS確保介面安全,介面呼叫有頻率限制,詳細請查看

2、帳號需要開通子帳號功能

請求參數說明

參數名 必選 類型 說明
appId true String 帳號appId【詳見取得金鑰
timestamp true Long 目前13位毫秒級時間戳記,3分鐘內有效
sign true String 簽名,為32位大寫的MD5值,產生簽名的appSecret金鑰作為通訊資料安全的關鍵資訊,嚴禁儲存在用戶端直接使用,所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料【詳見簽名產生規則

請求體參數說明

參數名 必選 類型 說明
childEmail true String 子帳號登入郵箱
childName true String 子帳號使用者名稱,最大長度50個字元
password true String 子帳號密碼,長度8~16位必須包含數字與字母
roleId true Integer 角色ID【可透過查詢角色列表取得】
organizationId false Integer 組織ID,不傳分配預設組織:總部【可透過查詢組織架構列表取得】
telephone false String 手機號碼
description false String 備註資訊,最大長度100個字元

範例

https://api.polyv.net/live/v4/user/children/create?appId=frlr1zazn3&timestamp=1670488960000&sign=A737C1816DF14B364D98670679CC8A11

請求體json參數:

{
    "childEmail": "lisi@qq.com",
    "password": "6hqnXCjJ46rujnMC",
    "childName": "李四",
    "description":"负责测试组人员的技能和业务培训,提升团队的测试能力",
    "roleId": 1310,
    "telephone": 12300000000,
    "organizationId":2679
}

回應參數說明

參數名 類型 說明
code Integer 回應狀態碼,200為成功返回,非200為失敗
status String 回應結果,由業務決定,成功返回success,失敗返回error
success Boolean 回應結果,由業務決定,成功返回true,失敗返回false
data Object 子帳號資訊【詳見data欄位說明
error Object 狀態碼非200時的錯誤資訊【詳見Error欄位說明
requestId String 請求ID,每次請求產生的唯一 UUID,僅可用於排查、除錯,不應該和業務掛鉤

Error參數說明

參數名 類型 說明
code Integer 錯誤代碼,用於確定具體的錯誤原因
desc String 錯誤描述,與 error.code 對應

data參數說明

參數名 類型 說明
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 createUserChildrenTest() 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/create";
    String childEmail = "lisi@qq.com";
    String childName = "李四";
    String password = "6hqnXCjJ46rujnMC";
    String roleId = "1310";
    String organizationId = "2679";
    String telephone = "12300000000";
    String description = "负责测试组人员的技能和业务培训,提升团队的测试能力";
    
    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    
    Map<String, Object> jsonMap = new HashMap<>();
    jsonMap.put("childEmail", childEmail);
    jsonMap.put("childName", childName);
    jsonMap.put("password", password);
    jsonMap.put("roleId", roleId);
    jsonMap.put("organizationId", organizationId);
    jsonMap.put("telephone", telephone);
    jsonMap.put("description", description);
    
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    
    url = HttpUtil.appendUrl(url, requestMap);
    String response = HttpUtil.postJsonBody(url, JSON.toJSONString(jsonMap), null);
    
    log.info("测试新增子账号成功:{}", response);
    //do somethings
    
}

回應範例

系統全域錯誤說明詳見全域錯誤說明

成功範例

{
    "code": 200,
    "status": "success",
    "requestId": "78de516b69364aeabe7d080e7228cc5c.83.16704899516650761",
    "data": {
        "childUserId": "895522b7862a",
        "childName": "李四",
        "childEmail": "lisi@qq.com",
        "description": "负责测试组人员的技能和业务培训,提升团队的测试能力",
        "telephone": "17600001234",
        "status": "NORMAL",
        "organizationId": 12300000000,
        "organizationName": "测试部门",
        "roleId": 1310,
        "roleName": "直播测试员",
        "createdTime": 1670489951730
    },
    "success": true
}

異常範例

{
    "code": 400,
    "status": "error",
    "requestId": "d310b70bc329403f87f77f9203d50f89.128.16360831552223589",
    "error": {
        "code": 20001,
        "desc": "application not found."
    },
    "success": false
}
联系客服,在线咨询