Query WeChat Appointment Data

Updated: 2022-09-02 18:08:07

API Description

1、查询微信预约数据
2、接口支持https协议

API URL

http://api.polyv.net/live/v4/channel/booking/list

Online API Call

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 within 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
startTime	false	Long	Appointment start time, 13-digit millisecond timestamp
endTime	false	Long	Appointment end time, 13-digit millisecond timestamp
pageNumber	false	Integer	Current page number
pageSize	false	Integer	Number of items per page, default 10, maximum 1000

Example

http://api.polyv.net/live/v4/channel/booking/list?channelId=2191532&appId=frlr1zazn3&timestamp=1655711232000&sign=572FA5A8502E2B621B6773FCB5CF93A1

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 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 identify the specific error reason
desc	String	Error description, corresponding 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
channelId	String	Channel ID
channelName	String	Channel name
openId	String	User ID (WeChat openId)
createdTime	Long	Appointment time, 13-digit millisecond timestamp

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 project. The test cases include HttpUtil.java and LiveSignUtil.java, both contained 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());
/**
 * 查询微信预约数据
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void channelBookingStatsTest() 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/booking/list";
    String channelId = "2272655";
    
    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("channelId", channelId);
    
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    
    String response = HttpUtil.get(url, requestMap);
    log.info("测试查询微信预约数据成功：{}", response);
    //do somethings
}

Response Example

For a description of global system errors, see Global Error Description

Success Example

{
    "code": 200,
    "status": "success",
    "requestId": "4c9fe1757834435a84e7a4086fa60300.67.16560360397655577",
    "data": {
        "pageNumber": 1,
        "pageSize": 10,
        "totalPages": 1,
        "totalItems": 1,
        "contents": [
            {
                "channelId": 3171796,
                "channelName": "三分屏",
                "openId": "ovtl9t44bqXDfubCPlAukB5ImaeQ",
                "nickname": null,
                "createdTime": 1656034291000,
                "TBname": null,
                "TBnumber": null
            }
        ]
    },
    "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