Query Channel Coupon Toggle Status
Updated: 2026-04-14 11:38:30
API Description
1、查询频道优惠券开关状态
2、接口支持https协议
API URL
https://api.polyv.net/live/v4/channel/coupon/get-enabled
Request Method
GET
API Constraints
- The API supports both HTTP and HTTPS. HTTPS is recommended for security. API calls have frequency limits. See details
Request Parameters Description
| Parameter | Required | Type | Description |
|---|---|---|---|
| appId | true | String | Account appId See details: 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 on the client side for direct use. All APIs must be called through the customer's own server to relay requests to the POLYV server for response data. See details: Signature Generation Rules |
| channelId | true | Integer | Channel ID |
Example
https://api.polyv.net/live/v4/channel/coupon/get-enabled?appId=frlr1zazn3&sign=012332FBD8DBCFC068AFCB484A2ADECB×tamp=1670550787318&channelId=4854808
Response Parameters Description
| Parameter | Type | Description |
|---|---|---|
| code | Integer | Response status code, 200 for success, non-200 for failure |
| status | String | Response result, determined by business logic: success returns "success", failure returns "error" |
| success | Boolean | Response result, determined by business logic: success returns true, failure returns false |
| data | String | Coupon toggle status: Y - Enabled, N - Disabled |
| error | Object | Error information when status code is non-200 See details: Error Field Description |
| 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 Parameters Description
| Parameter | Type | Description |
|---|---|---|
| code | Integer | Error code, used to identify the specific error reason |
| desc | String | Error description, corresponding to error.code |
Response Example
For global error descriptions, see Global Error Description
Success Example
{
"code": 200,
"status": "success",
"requestId": "46c21cc2-d4da-4fe8-ae34-118c36ce99f6",
"data": "N",
"success": true
}
Error Example
{
"code": 400,
"status": "error",
"requestId": "d310b70bc329403f87f77f9203d50f89.128.16360831552223589",
"error": {
"code": 10003,
"desc": "时间戳过期"
},
"success": false
}
