保利威文档中心

幫助中心

分頁查詢邀請海報邀請資料

更新時間：2022-09-02 18:08:07

介面描述

1、分页查询邀请海报邀请数据
2、接口支持https协议

介面URL

http://api.polyv.net/live/v4/statistics/inviter-poster/list

請求方式

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 頻道號
pageNumber false Integer 頁數，預設為1
pageSize false Integer 每頁顯示的資料筆數，預設每頁顯示10筆資料
startTime false Long 受邀開始時間，支援到時分秒，13位毫秒級時間戳記
endTime false Long 受邀結束時間，支援到時分秒，13位毫秒級時間戳記

範例

回應參數描述

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

參數名 類型 說明
pageNumber Integer 目前頁碼
pageSize Integer 每頁資料量
totalPages Long 頁面總數
totalItems Long 總資料量
contents Array 目前頁內容【詳見contents欄位說明】

Contents參數描述

參數名 類型 說明
openId String 邀請人微信openId
viewerId String 邀請人Id
nickname String 邀請人暱稱
createdTime Long 邀請海報產生時間，13位毫秒級時間戳記
receiverOpenId String 受邀人微信openId
receiverViewerId String 受邀人Id
receiverNickname String 受邀人暱稱
receiverTime Long 受邀時間，13位毫秒級時間戳記
param4 String 使用者自訂參數param4
param5 String 使用者自訂參數param5

Java請求範例

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

回應範例

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

成功範例

異常範例

{
    "code": 400,
    "status": "error",
    "error": {
        "code": 10003,
        "desc": "时间戳过期"
    },
    "success": false
}
联系客服，在线咨询