查詢邀請海報排行

更新時間：2022-09-08 17:08:27

介面描述

1、查询邀请海报排行
2、接口支持https协议

介面URL

請求方式

GET

介面限制

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

請求參數描述

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

範例

回應參數描述

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

Error參數描述

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

data參數描述

參數名	類型	說明
openId	String	微信openId
nickname	String	暱稱
avatar	String	頭像url
inviteNum	Integer	邀請人數
rank	Integer	邀請排名

Java請求範例

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

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

private static final Logger log = LoggerFactory.getLogger(getClass());

回應範例

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

成功範例

{
    "code": 200,
    "status": "success",
    "requestId": "7e1dbcafd52042dba58123f11b82a3be.63.16566368534184845",
    "data": [
        {
            "inviteNum": 3,
            "openId": "ovtl9t44bqXDfubCPlAukB5ImaeQ",
            "nickname": "sadboy",
            "avatar": "https://thirdwx.qlogo.cn/mmopen/vi_32/Q3auHgzwzM6n3d8AYtzyMiaE1U4fYNAJ7rXJExuB4a2dMweEsPJS4qLcBYK22bXibfa4mJGKSULBKBCMicKJaKtqw/132",
            "rank": 1
        },
        {
            "inviteNum": 1,
            "openId": "YWmwEacgMPEuG39HKZEK1Ao3IZHw",
            "nickname": "sadman",
            "avatar": "https://thirdwx.qlogo.cn/mmopen/vi_32/Q3auHgzwzM6n3d8AYtzyMiaE1U4fYNAJ7rXJExuB4a2dMweEsPJS4qLcBYK22bXibfa4mJGKSULBKBCMicKJaKtqw/132",
            "rank": 2
        }
    ],
    "success": true
}

異常範例

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