修改邀請員資訊

更新時間：2025-06-05 18:34:19

介面描述

1、修改账号下的某些邀请员的信息
2、接口支持https协议

介面URL

https://api.polyv.net/live/v4/user/invite-sales/update

請求方式

POST

介面限制

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

請求參數描述

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

請求體參數描述

參數名	必填	類型	說明
viewerUnionIds	true	Array	要操作的邀請員使用者ID列表，每次呼叫最多操作200個使用者。如果存在無效的使用者ID，則操作失敗。
organizationId	true	Integer	邀請員所屬組織ID。

請求範例

https://api.polyv.net/v4/user/invite-sales/add?appId=xxx&timestamp=1670471250000&sign=xxx

請求體json參數：

{
    "viewerUnionIds": [
        "xxxabc",
        "xxxdef"
    ],
    "organizationId": 123
}

回應參數描述

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

error物件說明

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

Java請求範例

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

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

import java.util.Arrays;

public void test() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId = super.appId;
    String appSecret = super.appSecret;
    String timestamp = String.valueOf(System.currentTimeMillis());
    
    //业务参数
    List<String> viewerUnionIds = Arrays.asList("xxxabc", "xxxdef");
    Integer organizationId = 123;
    
    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    
    Map<String, Object> jsonMap = new HashMap<>();
    jsonMap.put("viewerUnionIds", viewerUnionIds);
    jsonMap.put("organizationId", organizationId);
    
    String url = "https://api.polyv.net/v4/user/invite-sales/update";
    url = HttpUtil.appendUrl(url, requestMap);
    String response = HttpUtil.postJsonBody(url, JSON.toJSONString(jsonMap), null);
    log.info("response: {}", response);
}

回應範例

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

成功範例

{
    "code": 200,
    "status": "success",
    "success": true,
    "requestId": "5b33d00b-d284-4a3d-adcd-38210f8681c8",
    "data": null
}

失敗範例

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