保利威文档中心

帮助中心

获取频道设置(频道图标,引导图)

更新时间:2022-05-23 17:54:01

接口URL

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

接口说明

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

支持格式

JSON

请求方式

GET

请求数限制

TRUE

请求参数

参数名 必选 类型 说明
appId string 管理员的appId
timestamp long 13位当前时间戳
sign string 签名值
channelId string 频道ID

响应成功JSON示例:

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

响应失败JSON示例:

未输入appId

{
    "code": 400,
    "status": "error",
    "message": "appId is required.",
    "data": ""
}

appId不正确

{
    "code": 400,
    "status": "error",
    "message": "application not found.",
    "data": ""
}

时间戳错误

{
    "code": 400,
    "status": "error",
    "message": "invalid timestamp.",
    "data": ""
}

签名错误

{
    "code": 403,
    "status": "error",
    "message": "invalid signature.",
    "data": ""
}

字段说明

参数名 说明
code 响应代码,成功为200,失败为400,签名错误为401,异常错误500
status 成功为success,失败为error
message 错误时为错误提示消息
data 成功响应时为相关的信息
data.channelId 频道ID
data.coverImg 频道图标
data.splashImg 频道引导图
data.splashEnabled 引导图开关('Y' 或 'N')
联系客服,在线咨询