保利威文档中心

帮助中心

获取频道详情信息

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

接口URL

http://api.polyv.net/live/v3/channel/detail/get

接口说明

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

支持格式

JSON

请求方式

GET

请求参数

参数名 必选 类型 说明
appId string 管理员的appId
timestamp long 13位当前时间戳
sign String 签名,为32位大写的MD5值,生成签名的appSecret密钥作为通信数据安全的关键信息,严禁保存在客户端直接使用,所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据【详见签名生成规则
channelId int 频道id

响应成功JSON示例:

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": {
        "channelId": 101385,
        "name": "测试的频道号",
        "publisher": "liveTest1",
        "startTime": 1500496639000,
        "channelPasswd": "abcdefg",
        "scene": "ppt",
        "maxViewer": 100
    }
}

响应失败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 错误时为错误提示消息
data.channelId 频道号
data.name 频道名称
data.publisher 频道主持人
data.startTime 开始直播时间的时间戳,未设置过返回0
data.channelPasswd 频道密码
data.scene 直播场景,alone(活动直播),topclass(大班),ppt(三分屏)
data.cnAndEnLiveEnabled 中英文直播间标识,N不开启中英直播间 、Y开启中英直播间
data.englishSettingEnabled 英文直播间独立配置,N不开启、Y开启
data.channelEnglishName 直播名称英文文案
data.publisherEnglishName 主持人名称英文文案
联系客服,在线咨询