Add Channel Coupon
Updated: 2026-01-06 09:17:49
API Description
1、将平台优惠券添加到频道中
2、接口支持https协议
API URL
https://api.polyv.net/live/v4/channel/coupon/create
Request Method
POST
API Constraints
- The API supports both HTTP and HTTPS. HTTPS is recommended to ensure API security. API calls have a frequency limit. See details
Request Parameter Description
| Parameter | Required | Type | Description |
|---|---|---|---|
| appId | true | String | Account appId See details for obtaining 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. 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 |
Request Body Parameter Description
| Parameter | Required | Type | Description |
|---|---|---|---|
| channelId | true | String | Channel ID |
| couponIds | true | Array | List of coupon IDs, quantity range 1-30. If invalid or already added coupons are included, they will be ignored, and only valid coupon IDs will be processed. If all coupon IDs are invalid, a failure prompt will be returned. |
Example
https://api.polyv.net/live/v4/channel/coupon/create?appId=frlr1zazn3&sign=012332FBD8DBCFC068AFCB484A2ADECB×tamp=1670550787318
Request body JSON parameters:
{
"channelId": "123456",
"couponIds": [
"caqfi6rqutunvofor5jrqbinswh14p2g",
"cbbfi6rqutunvofor5jrqbinswh14p2h"
]
}
Response Parameter Description
| Parameter | Type | Description |
|---|---|---|
| code | Integer | Response status code, 200 for success, non-200 for failure |
| status | String | Response result, determined by business logic, returns success on success, error on failure |
| success | Boolean | Response result, determined by business logic, returns true on success, false on failure |
| data | Boolean | Returns true on success |
| error | Object | Error information when status code is non-200 See 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 Parameter Description
| Parameter | Type | Description |
|---|---|---|
| code | Integer | Error code, used to determine the specific error reason |
| desc | String | Error description, corresponds to error.code |
Response Example
See Global Error Description for system-wide error descriptions.
Success Example
{
"code": 200,
"status": "success",
"requestId": "f9a9577b-cf74-4bf4-96e9-067ea23f1685",
"data": true,
"success": true
}
Error Example
{
"code": 400,
"status": "error",
"requestId": "d310b70bc329403f87f77f9203d50f89.128.16360831552223589",
"error": {
"code": 10003,
"desc": "时间戳过期"
},
"success": false
}
