Query Invitation Poster Ranking

Updated: 2022-09-08 17:08:27

API Description

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

API URL

Request Method

GET

API Constraints

The API supports both HTTP and HTTPS. HTTPS is recommended to ensure security. API calls are subject to rate limits. Click for details

Request Parameter Description

Parameter	Required	Type	Description
appId	true	String	Account appId [See Get Secret Key]
timestamp	true	Long	Current 13-digit millisecond timestamp, valid for 3 minutes
sign	true	String	Signature, a 32-character uppercase MD5 value. `The appSecret key used to generate the signature is critical for communication data security. It must not be stored or used directly on the client side. All APIs must be called through the customer's own server to relay requests to the POLYV server for response data.` [See Signature Generation Rules]
channelId	true	String	Channel ID

Example

Response Parameter Description

Parameter	Type	Description
code	Integer	Status code, same as HTTP status code, used to determine the basic response status
status	String	Response result, determined by the business. Returns "success" on success, "error" on failure
success	Boolean	Whether the response was successful
requestId	String	Request ID, a unique UUID generated for each request. Only used for troubleshooting and debugging, should not be tied to business logic
error	Object	Error information when the status code is not 200 [See Error Field Description]
data	Array	[See data Field Description]

Error Parameter Description

Parameter	Type	Description
code	Integer	Error code, used to identify the specific error reason
desc	String	Error description, corresponding to error.code

data Parameter Description

Parameter	Type	Description
openId	String	WeChat openId
nickname	String	Nickname
avatar	String	Avatar URL
inviteNum	Integer	Number of invitees
rank	Integer	Invitation ranking

Java Request Example

For quick integration of the basic code, please download the relevant dependency source code. Click here to download the source code. After downloading, add it to your own source code project. The HttpUtil.java and LiveSignUtil.java in the test cases are included in the downloaded file.

It is strongly recommended to use the Live Java SDK for API integration. The Live Java SDK provides unified encapsulation and optimization for API call logic, exception handling, data signing, and HTTP request thread pools.

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

Response Example

For global system error descriptions, see Global Error Description

Success Example

{
    "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
}

Error Example

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

Live Streaming Server API