Polyv Help Center

Help Center

Get Channel Settings (Channel Icon, Splash Image)

Updated: 2022-05-23 17:54:01

Interface URL

https://api.polyv.net/live/v3/channel/setting/get

Interface Description

1、接口用于获取频道设置
2、接口支持https

Supported Formats

JSON

Request Method

GET

Request Limit

TRUE

Request Parameters

Parameter Required Type Description
appId Yes string Admin's appId
timestamp Yes long 13-digit current timestamp
sign Yes string Signature value
channelId Yes string Channel ID

Successful Response JSON Example:

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": {
        "channelId": 10001,
        "coverImg": "http://www.polyv.net/1.png",
        "splashImg": "http://www.polyv.net/2.png",
        "splashEnabled": "Y"
    }
}

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, 401 for signature error, 500 for exception error
status "success" for success, "error" for failure
message Error message when an error occurs
data Relevant information on successful response
data.channelId Channel ID
data.coverImg Channel icon
data.splashImg Channel splash image
data.splashEnabled Splash image toggle ('Y' or 'N')
联系客服,在线咨询