建立邀請者

更新時間：2022-11-14 18:23:35

介面描述

1、邀请海报-创建邀请者
2、appId、timestamp、sign必须通过url传递
3、接口支持https协议

介面URL

http://api.polyv.net/live/v4/channel/invite/poster/create

線上API呼叫

請求方式

POST

介面限制

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

2、觀看頁連結存取方式：https://live.polyv.cn/watch/{channelId}?invitePosterId={invitePosterId} 例如：https://live.polyv.cn/watch/3121680?invitePosterId=4fdb2496，受邀用戶在微信存取該連結即可完成邀請綁定，邀請明細資料可透過「查詢邀請海報明細資料」介面取得

請求參數說明

參數名稱	必填	類型	說明
appId	true	String	帳號appId【詳見取得金鑰】
timestamp	true	Long	目前13位毫秒級時間戳記，3分鐘內有效
sign	true	String	簽名，為32位大寫的MD5值，僅query參數參與簽名【詳見簽名產生規則】
channelId	true	String	頻道號
openId	true	String	邀請者用戶ID
nickname	true	String	邀請者暱稱
avatar	false	String	邀請者頭像url位址，如果為空，則使用預設頭像
viewerId	false	String	邀請者觀眾ID
invitee	false	String	自訂邀請ID

範例

http://api.polyv.net/live/v4/channel/invite/poster/create?appId=frlr1zazn3&timestamp=1653556311000&channelId=3121680&sign=959D476D141DC170E0118DCC43839101&openId=jiangyifana&nickname=%E5%B8%86%E7%83%A6%E5%8F%8D%E9%A5%AD

回應參數說明

參數名稱	類型	說明
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參數說明

參數名稱	類型	說明
invitePosterId	String	邀請海報ID
channelId	Integer	頻道ID
openId	String	邀請者用戶ID
invitee	String	自訂邀請ID

Java請求範例

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

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

private static final Logger log = LoggerFactory.getLogger(ChannelOperateTest.class);
/**
 * 创建邀请者
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void inviterCreateTest() 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/channel/invite/poster/create";
    String channelId = "3121680";
    String openId = "1yexRmHZoJrcw40";
    String nickname = "张三";
    String viewerId = "UPpuW43RFIKSveD";
    
    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("channelId", channelId);
    requestMap.put("openId", openId);
    requestMap.put("nickname", nickname);
    requestMap.put("viewerId", viewerId);
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    
    url = HttpUtil.appendUrl(url, requestMap);
    String response = HttpUtil.postFormBody(url, null);
    
    log.info("测试创建邀请者成功：{}", response);
    //do somethings
    
}

回應範例

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

成功範例

{
    "code": 200,
    "status": "success",
    "requestId": "2a8712050df1475db89fbb9348efc035.65.16541338429926329",
    "data": {
        "invitePosterId": "2325308f",
        "channelId": 3121680,
        "openId": "1yexRmHZoJrcw40",
        "invitee": null
    },
    "success": true
}

異常範例

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