获取双师或转播列表信息

接口URL

https://api.polyv.net/live/v3/channel/transmit/get-associations

接口说明

(接口调用有频率限制,详细请查看)

1、接口用于获取账号或频道下的转播列表信息
2、接口支持https

返回结果支持格式

JSON

请求方式

GET

请求数限制

TRUE

请求参数

参数名 必选 类型 说明
appId string 从API设置中获取,在直播系统登记的appId
timestamp long 13位当前毫秒级时间戳
sign string 签名值
channelId int 频道号,如果不传,则查询appId对应的账号下所有转播频道关联关系
transmitType string 1、如果传了频道号,默认查询和频道同一类型频道;
2、如果不传频道号,默认获取转播频道,double:获取双师频道列表

响应成功JSON示例:

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": [
        {
            "channelId": 1853794,
            "receiveChannelId": 1853782
        },
        {
            "channelId": 1852725,
            "receiveChannelId": 1853044
        }
    ]
}

响应字段说明

参数名 说明
code 状态码,成功为200,签名失败为403,参数错误为400,服务端错误为500
status 成功为success,错误时为error
message 成功为"",错误时为错误描述信息
data 响应数据
data[0].channelId 发起转播频道号,如果一个接收转播频道没有关联主频道,则该值为null
data[0].receiveChannelId 接收转播频道号

响应失败JSON示例:

参数错误

{
    "code": 400,
    "status": "error",
    "message": "param validate error",
    "data": ""
}

未输入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": 403,
    "status": "error",
    "message": "illegal channel id: %s",
    "data": ""
}

java请求示例

public void testGetAssociations() {
        String url = "https://api.polyv.net/live/v3/channel/transmit/get-associations";
        // appId和加密串
        String appId = "xxxxxxx";
        String appSecret = "xxxxxxxxxxxxxxxx";
        // 如果不传频道号,则查询当前appId对应的账号下所有的转播频道关联关系
        int channelId = 123;
        Map<String, String> params = new HashMap<>();
        params.put("channelId", String.valueOf(channelId));
        // 调用Polyv的工具类方法设置sign
        PolyvTool.setLiveSign(params, appId, appSecret);
        String content = HttpClientUtil.getInstance()
                .sendHttpGet(url + "?" +  PolyvTool.mapJoinNotEncode(params));
        System.out.println(content);
}

签名规则及工具文件代码

https://dev.polyv.net/2020/liveproduct/l-api/rule/live-api-java-detail/

以上内容是否对您有帮助?根本没有帮助文档较差文档一般文档不错文档很好
Loading...