Page Menu Settings
Updated: 2022-09-02 18:08:07
Interface URL
http://api.polyv.net/live/v3/channel/menu/update-list
Interface Description
1、接口用于频道的简单详情信息
2、接口支持https
Supported Format
JSON
Request Method
POST
Request Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
| appId | Yes | string | The appId of the administrator |
| timestamp | Yes | long | 13-digit current timestamp |
| sign | Yes | 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 request data to the POLYV server and obtain responses. For details, see Signature Generation Rules |
| channelId | Yes | int | Channel ID |
| menuList | Yes | string | Menu list in JSON format, e.g., [{"id1":"name1"}, {"id2":"name2"}] |
| lang | No | string | Menu language. Default: zh_CN (Chinese), EN (English) |
Example of a Successful JSON Response:
{
"code": 200,
"status": "success",
"message": "",
"data": ""
}
Example of a Failed JSON Response:
appId not provided
{
"code": 400,
"status": "error",
"message": "appId is required.",
"data": ""
}
Incorrect appId
{
"code": 400,
"status": "error",
"message": "application not found.",
"data": ""
}
Timestamp error
{
"code": 400,
"status": "error",
"message": "invalid timestamp.",
"data": ""
}
Signature error
{
"code": 403,
"status": "error",
"message": "invalid signature.",
"data": ""
}
Field Description
| Parameter | Description |
|---|---|
| code | Response code: 200 for success, 400 for failure, 403 for signature error, 500 for server error |
| status | "success" for success, "error" for failure |
| message | Error message when status is "error" |
