批量建立機器人虛擬暱稱

更新時間：2023-03-17 11:53:21

介面描述

1、批量创建机器人虚拟昵称
2、（timestamp, appId）参与sign签名，并和sign一起通过url传递，请求体参数不参与签名，通过post请求体传递【请设置请求头contentType:application/json】
3、接口支持https协议

介面URL

http://api.polyv.net/live/v4/global/robot/save-batch

線上API呼叫

請求方式

POST

介面限制

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

2、一次性建立的機器人資訊數量不能超過200個

3、暱稱支援重複設定

請求參數描述

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

請求體參數描述

參數名	必選	類型	說明
name	true	String	虛擬暱稱，必填，不支援emoji表情，不超過20個字元
avatar	false	String	機器人頭像，不傳或傳空，則設定預設頭像

範例

http://api.polyv.net/live/v4/global/robot/save-batch?appId=frlr1zazn3&sign=FAA7C22E73FA521B4CA48BB543252059&timestamp=1679023736161

請求體參數：

[
    {
        "name": "虚拟昵称1",
        "avatar": "https://liveimages.videocc.net/uploaded/images/2023/03/gj5fk2a06r.png"
    },
    {
        "name": "虚拟昵称2"
    }
]

回應參數描述

參數名	類型	說明
code	Integer	狀態碼，與 http 狀態碼相同，用於確定基本的回應狀態
data	Object	成功回應的資料
error	Object	狀態碼非200時的錯誤資訊【詳見Error參數描述】
requestId	String	請求ID，每次請求產生的唯一的 UUID，僅可用於排查、除錯，不應該和業務掛鉤
status	String	回應結果，由業務決定，成功回傳success，失敗回傳error
success	Boolean	是否成功回應

Error參數描述

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

Java請求範例

快速接入基礎代碼請下載相關依賴原始碼，點擊下載原始碼，下載後加入到自己的原始碼工程中即可。測試用例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下載檔案中。

強烈建議您使用直播Java SDK完成API的功能對接，直播Java SDK 對API呼叫邏輯、異常處理、資料簽名、HTTP請求執行緒池進行了統一封裝和最佳化。

private static final Logger log = LoggerFactory.getLogger(getClass());
/**
* 批量创建机器人虚拟昵称
* @throws IOException
* @throws NoSuchAlgorithmException
*/
@Test
public void robotSaveBatchTest() 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/global/robot/save-batch";
    
    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    
    url = HttpUtil.appendUrl(url, requestMap);
    
    List<Object> jsonList = new ArrayList<>();
    Map<String, String> jsonMap = new HashMap<>();
    jsonMap.put("name","虚拟昵称1");
    jsonMap.put("avatar","https://liveimages.videocc.net/uploaded/images/2023/03/gj5fk2a06r.png");
    jsonList.add(jsonMap);
    jsonMap = new HashMap<>();
    jsonMap.put("name","虚拟昵称2");
    jsonList.add(jsonMap);
    
    String response = HttpUtil.postJsonBody(url, JSON.toJSONString(jsonList),null);
    
    log.info("测试批量创建机器人虚拟昵称成功：{}", response);
    //do somethings
    
}

回應範例

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

成功範例

{
    "code": 200,
    "status": "success",
    "requestId": "99d7e672d04d42698d9c95fb70e7c9ab.66.16790237605309137",
    "data": null,
    "success": true
}

異常範例

{
    "code": 400,
    "status": "error",
    "requestId": "d310b70bc329403f87f77f9203d50f89.128.16360831552223589",
    "error": {
        "code": 20001,
        "desc": "application not found."
    },
    "success": false
}