保利威文档中心

帮助中心

设置频道详情

更新时间:2022-09-02 18:08:07

接口URL

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

接口说明

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

支持格式

JSON

请求方式

POST

请求参数

参数名 必选 类型 说明
appId string 管理员的appId
timestamp long 13位当前时间戳
sign String 签名,为32位大写的MD5值,生成签名的appSecret密钥作为通信数据安全的关键信息,严禁保存在客户端直接使用,所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据【详见签名生成规则
channelId int 频道id
publisher string 主持人
name string 频道名称
startTime long 开始时间
password string 频道密码,长度不能超过16位
maxViewer int 频道的最大在线人数观看限制的人数
scene string 直播场景:
alone 直播助手
ppt 云课堂
topclass 大班课
streamType string 流类型
watchTitle string 观看页标题
englishSettingEnabled string 英文独立配置 Y是、N否
channelEnglishName string 直播英文名称
publisherEnglishName string 主持人英文名称

响应成功JSON示例:

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

响应失败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,签名错误为403,异常错误500
status 成功为success,失败为error
message 错误时为错误提示消息
联系客服,在线咨询