Paginated Query of Invitation Poster Invitation Data
Updated: 2022-09-02 18:08:07
API Description
1、分页查询邀请海报邀请数据
2、接口支持https协议
API URL
http://api.polyv.net/live/v4/statistics/inviter-poster/list
Request Method
GET
API Constraints
- The API supports both HTTP and HTTPS. HTTPS is recommended to ensure interface security. API calls have frequency limits. See 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 never be saved 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 to obtain response data. See Signature Generation Rules |
| channelId | true | String | Channel ID |
| pageNumber | false | Integer | Page number, defaults to 1 |
| pageSize | false | Integer | Number of data items per page, defaults to 10 |
| startTime | false | Long | Invitation start time, supports hours, minutes, and seconds, 13-digit millisecond timestamp |
| endTime | false | Long | Invitation end time, supports hours, minutes, and seconds, 13-digit millisecond timestamp |
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 business logic. 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 status code is not 200 See Error Field Description |
| data | Object | See Data Field Description |
Error Parameter Description
| Parameter | Type | Description |
|---|---|---|
| code | Integer | Error code, used to determine the specific error reason |
| desc | String | Error description, corresponds to error.code |
Data Parameter Description
| Parameter | Type | Description |
|---|---|---|
| pageNumber | Integer | Current page number |
| pageSize | Integer | Number of items per page |
| totalPages | Long | Total number of pages |
| totalItems | Long | Total number of items |
| contents | Array | Content of the current page See Contents Field Description |
Contents Parameter Description
| Parameter | Type | Description |
|---|---|---|
| openId | String | Inviter's WeChat openId |
| viewerId | String | Inviter ID |
| nickname | String | Inviter nickname |
| createdTime | Long | Invitation poster generation time, 13-digit millisecond timestamp |
| receiverOpenId | String | Invitee's WeChat openId |
| receiverViewerId | String | Invitee ID |
| receiverNickname | String | Invitee nickname |
| receiverTime | Long | Invitation time, 13-digit millisecond timestamp |
| param4 | String | User-defined parameter param4 |
| param5 | String | User-defined parameter param5 |
Java Request Example
For quick integration of the base 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 test cases include HttpUtil.java and LiveSignUtil.java in the downloaded file.
Response Example
For global system error descriptions, see Global Error Description
Success Example
Error Example
{
"code": 400,
"status": "error",
"error": {
"code": 10003,
"desc": "时间戳过期"
},
"success": false
}
