Polyv Help Center

Help Center

Set Channel Details

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

Interface URL

http://api.polyv.net/live/v3/channel/detail/update-simple-setting

Interface Description

1、接口用于设置频道的简单详情信息
2、接口支持https

Supported Format

JSON

Request Method

POST

Request Parameters

Parameter Required Type Description
appId Yes string Admin's appId
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 requests to the POLYV server and obtain response data. See Signature Generation Rules
channelId Yes int Channel ID
publisher No string Host
name No string Channel name
startTime No long Start time
password No string Channel password, maximum length 16 characters
maxViewer No int Maximum concurrent online viewers limit
scene No string Live streaming scenario:
alone - Live Assistant
ppt - Cloud Classroom
topclass - Large Class
streamType No string Stream type
watchTitle No string Watch page title
englishSettingEnabled No string Independent English configuration: Y for Yes, N for No
channelEnglishName No string Live stream English name
publisherEnglishName No string Host English name

Successful Response JSON Example:

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": ""
}

Failed Response JSON Example:

No appId 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 exception error
status success for success, error for failure
message Error message when an error occurs
联系客服,在线咨询