新东方-获取上传PPT文件token

接口URL

https://document-2.polyv.net/api/live/user/upload/token

接口说明

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

1、获取上传PPT文件token
2、接口支持https协议
3、上传文件到OSS参考 https://www.alibabacloud.com/help/zh/doc-detail/31927.htm

返回结果支持格式

JSON

请求方式

GET

请求数限制

TRUE

请求参数

参数名 必选 类型 说明
fileId string 文件ID (文件MD5+userId+type)
userId string 用户ID
type string PPT类型,“common” 普通ppt , “animate”动画PPT
fileName string 文件名称

响应成功JSON示例:

等待上传

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": {
        "encodedCallback": "eyJjYWxsYmFja1VybCI6Imh0dHA6Ly9kb2N1bWVudC0yLnBvbHl2Lm5ldC90ZXN0L2FsaS9vc3MvY2FsbGJhY2svdXBsb2FkIiwiY2FsbGJhY2tIb3N0IjoiZG9jdW1lbnQtMi5wb2x5di5uZXQiLCJjYWxsYmFja0JvZHkiOiJvYmplY3Q9JHtvYmplY3R9JnNpemU9JHtzaXplfSZidWNrZXQ9JHtidWNrZXR9JmV0YWc9JHtldGFnfSZhdXRvSWQ9MTQ5MzcxNyZmaWxlSWQ9ZDg3MDBhODhhZGUxMDUyOTQwMTM3MDM4MTBmY2ZjMTNjZjdmMDdlMDk2YW5pbWF0ZSIsImNhbGxiYWNrQm9keVR5cGUiOiJhcHBsaWNhdGlvbi94LXd3dy1mb3JtLXVybGVuY29kZWQifQ==",
        "signature": "fcrT21oNF7CMxAdI70D20hUu1fE=",
        "autoId": "1493717",
        "dir": "sources/20201028/",
        "bucket": "polyvppt",
        "accessId": "LTAIjy1Mrh8QQcQH",
        "endpoint": "oss-cn-shenzhen.aliyuncs.com",
        "expire": "1603941652",
        "host": "http://polyvppt.oss-cn-shenzhen.aliyuncs.com",
        "callback": "{\"callbackUrl\":\"http://document-2.polyv.net/test/ali/oss/callback/upload\",\"callbackHost\":\"document-2.polyv.net\",\"callbackBody\":\"object=${object}&size=${size}&bucket=${bucket}&etag=${etag}&autoId=1493717&fileId=d8700a88ade105294013703810fcfc13cf7f07e096animate\",\"callbackBodyType\":\"application/x-www-form-urlencoded\"}",
        "convertStatus": "waitUpload",
        "fileId": "d8700a88ade105294013703810fcfc13cf7f07e096animate",
        "object": "sources/20201028/d8700a88ade105294013703810fcfc13cf7f07e096animate.pptx",
        "policy": "eyJleHBpcmF0aW9uIjoiMjAyMC0xMC0yOVQwMzoyMDo1Mi42OTJaIiwiY29uZGl0aW9ucyI6W1siY29udGVudC1sZW5ndGgtcmFuZ2UiLDAsMzIyMTIyNTQ3MjBdLFsic3RhcnRzLXdpdGgiLCIka2V5Iiwic291cmNlcy8yMDIwMTAyOC8iXV19"
    }
}

等待转换

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": {
        "autoId": "1492485",
        "convertStatus": "waitConvert",
        "fileId": "18947167af136724418f3cfa32343b29cf7f07e096animate"
    }
}

转换成功

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": {
        "autoId": "1493717",
        "convertStatus": "normal",
        "fileId": "d8700a88ade105294013703810fcfc13cf7f07e096animate"
    }
}

响应失败JSON示例:

文件类型错误

{
    "code": 400,
    "status": "error",
    "message": "file type is wrong",
    "data": ""
}

字段说明

参数名 说明
code 请求状态响应码
status 请求状态
message 错误信息
data 请求失败时为空,请求成功为成功信息
data.autoId 记录ID
data.fileId 文件ID
data.convertStatus PPT状态,“normal” 正常,不需要重复上传文件,已经有上传成功的相同PPT,可以直接进入轮询。“waitConvert”转换PPT中,已经有相同的文件正在转换中,直接进入轮询。“waitUpload” 等待上传状态,进入上传阿里云步骤。“failConvert” 转换失败
data.accessId oss上传OSSAccessKeyId
data.signature oss上传signature
data.policy oss上传policy
data.endpoint oss上传的endpoint
data.encodedCallback oss上传的回调参数BASE64编码
data.callback oss上传的回调参数
data.object oss上传文档key
data.host oss上传地址
data.bucket oss上传桶
data.expire oss上传有效时间
data.dir 上传到oss的文件夹

java请求示例

public static void test() {
        String url = "https://document-2.polyv.net/api/live/user/upload/token";

        Map<String, String> params = new HashMap<>();
        params.put("fileId", "d8700a88ade105294013703810fcfc13cf7f07e096animate");
        params.put("type", "animate");
        params.put("fileName", "animate.pptx");
        params.put("userId", "cf7f07e096");
        // 调用Polyv的httpClient工具类发送请求
        String content = HttpClientUtil.getInstance().sendHttpPost(url, params);
        System.out.println(content);
    }
以上内容是否对您有帮助?根本没有帮助文档较差文档一般文档不错文档很好
Loading...

新东方-获取PPT文件信息

接口URL

https://document-2.polyv.net/api/live/user/get

接口说明

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

1、获取PPT文件信息
2、接口支持https协议

返回结果支持格式

JSON

请求方式

GET

请求数限制

TRUE

请求参数

参数名 必选 类型 说明
autoId string 记录ID
fileId string 文件ID
userId string 用户ID

响应成功JSON示例:

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": {
        "autoId": 1492485,
        "fileId": "18947167af136724418f3cfa32343b29cf7f07e096animate",
        "fileName": null,
        "fileUrl": "http://doc-2.polyv.net/sources/20201027/18947167af136724418f3cfa32343b29cf7f07e096animate.pptx",
        "fileType": ".pptx",
        "totalPage": 25,
        "channelId": "cf7f07e096",
        "status": "normal",
        "createTime": 1603770982000,
        "convertType": "common",
        "smallImagesZip": "images/2020/10/18947167af136724418f3cfa32343b29cf7f07e096animate/smallImages.zip",
        "imagesZip": "images/2020/10/18947167af136724418f3cfa32343b29cf7f07e096animate/images.zip",
        "htmlUrlZip": ""
    }
}

响应失败JSON示例:

记录ID非法

{
    "code": 400,
    "status": "error",
    "message": "autoId is illegal",
    "data": ""
}

字段说明

参数名 说明
code 请求状态响应码
status 请求状态
message 错误信息
data 请求失败时为空,请求成功为成功信息
data.autoId 记录ID
data.fileId 文件ID
data.status PPT状态,“normal” 正常,不需要重复上传文件,已经有上传成功的相同PPT,可以直接进入轮询。“waitConvert”转换PPT中,已经有相同的文件正在转换中,直接进入轮询。“waitUpload” 等待上传状态,进入上传阿里云步骤。“failConvert” 转换失败
data.fileUrl 文件地址
data.fileType 文件类型
data.totalPage 总页数
data.convertType 转换类型
data.smallImagesZip 小图ZIP地址
data.imagesZip 大图ZIP地址
data.htmlUrlZip 动效文件ZIP地址
data.fileName 文件名

java请求示例

public static void test() {
        String url = "https://document-2.polyv.net/api/live/user/get";

        Map<String, String> params = new HashMap<>();
        params.put("fileId", "d8700a88ade105294013703810fcfc13cf7f07e096animate");
        params.put("autoId", "1492485");
        params.put("userId", "cf7f07e096");
        // 调用Polyv的httpClient工具类发送请求
        String content = HttpClientUtil.getInstance().sendHttpPost(url, params);
        System.out.println(content);
    }
以上内容是否对您有帮助?根本没有帮助文档较差文档一般文档不错文档很好
Loading...

批量删除聊天记录

接口URL

https://api.polyv.net/live/v3/channel/chat/remove-contents

接口说明

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

1、根据聊天的id删除对应聊天记录
2、接口支持https协议
3、接口支持批量删除操作

返回结果支持格式

JSON

请求方式

POST

请求数限制

TRUE

请求参数

参数名 必选 类型 说明
appId string 从API设置中获取,在直播系统登记的appId
channelId int 频道ID
ids string 聊天记录对应的id(多个id使用英文逗号隔开)
timestamp string 当前13位毫秒级时间戳,3分钟内有效
sign string 签名,32位大写MD5值

响应成功JSON示例:

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": "remove chat contents success"
}

响应失败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": 400,
    "status": "error",
    "message": "channel not found.",
    "data": ""
}

其他错误

{
    "code": 400,
    "status": "error",
    "message": "remove chat contents occur an error",
    "data": ""
}

字段说明

参数名 说明
code 请求状态响应码
status 请求状态
message 错误信息
data 请求失败时为空,请求成功为成功信息

java请求示例

public static void test() {
        String url = "https://api.polyv.net/live/v3/channel/chat/remove-contents";
        // 用户对应的appId和加密串
        String appId = "xxxxxxxxx";
        String appSecret = "xxxxxxxxxxxxxxxxxxxxxxxxxx";
        int channelId = 10001;
        Map<String, String> params = new HashMap<>();
        params.put("channelId", channelId);
        params.put("ids", "12213,22334");
        PolyvTool.setLiveSign(params, appId, appSecret);
        // 调用Polyv的httpClient工具类发送请求
        String content = HttpClientUtil.getInstance().sendHttpPost(url, params);
        System.out.println(content);
    }

签名规则(PolyvTool.java文件代码查看)

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

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

查询连麦详单

接口URL

https://api.polyv.net/live/v3/channel/link-mic/detail-list

接口说明

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

1、接口用于查询连麦详单
2、接口支持https

返回结果格式

JSON

请求方式

GET

请求参数

参数名 必选 类型 说明
appId string 从API设置中获取,在直播系统登记的appId
timestamp long 当前13位毫秒级时间戳,3分钟内有效
sign string 签名,为32位大写的MD5值
channelId int 频道号
startDate string 开始日期, 日期格式:yyyy-MM-dd,如2020-10-01
endDate string 结束日期, 日期格式:yyyy-MM-dd,如2020-10-01

响应成功JSON示例:

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": {
        "hasMore": true,
        "contents": [
            {
                "identity": "teacher",
                "viewerId": "xxxxxxx",
                "nickname": "xxxxx",
                "enterRtcTime": 1592040864000,
                "leaveRtcTime": 1592040864000,
                "startPushTime": 1592040864000,
                "endPushTime": 1592040864000,
                "channelSessionId": "xxxxxx",
                "channelId": 1592040
            },
            {
                "identity": "teacher",
                "viewerId": "xxxxxxx",
                "nickname": "xxxxx",
                "enterRtcTime": 1592040864000,
                "leaveRtcTime": 1592040864000,
                "startPushTime": 1592040864000,
                "endPushTime": 1592040864000,
                "channelSessionId": "xxxxxx",
                "channelId": 1592040
            }
        ],
    }
}

响应失败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
data 响应结果
message 异常错误信息
channelId 频道号
channelSessionId 场次号
viewerId 观众ID
identity 身份,嘉宾:guest、特邀观众:vistor、普通观众:viewer
nickname 昵称
terminal 终端
version 终端版本
enterRtcTime 进入 rtc 的时间, 13位毫秒时间戳
leaveRtcTime 离开 rtc 的时间, 13位毫秒时间戳
startPushTime 开始推流时间, 13位毫秒时间戳
endPushTime 结束推流时间, 13位毫秒时间戳
hasMore 是否还有数据,数据量太大需要多次拉取列表的方式来满足需求

Java请求示例

public void test() {
        String url = "https://api.polyv.net/live/v3/channel/link-mic/detail-list";
        // 用户对应的appId和加密串
        String appId = "xxxxxxxxx";
        String appSecret = "xxxxxxxxxxxxxxxxxxxxxxxxxx";
        Map<String, String> params = new HashMap<>();
        params.put("viewerId", "xxxxx");
        params.put("channelId", "1234567");
        params.put("startDate", "2020-10-22");
        params.put("enddate", "2020-10-23");
        PolyvTool.setLiveSign(params, appId, appSecret);
        // 调用Polyv的httpClient工具类发送请求
        String content = HttpClientUtil.getInstance()
                .sendHttpGet(url + "?" + PolyvTool.mapJoinNotEncode(params));
        System.out.println(content);
    }

签名规则(PolyvTool.java文件代码查看)

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

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

分页获取频道聊天室房间在线人数列表

接口URL

http://api.polyv.net/live/v3/channel/chat/get-chat-user-list

接口说明

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

1、分页获取频道聊天室房间在线人数
2、支持分页,最大每页1000条数据,最小每页1条数据
3、接口支持https

返回结果支持格式

JSON

请求方式

GET

请求数限制

TRUE

请求参数

参数名 必选 类型 说明
appId string 从API设置中获取,在直播系统登记的appId
timestamp long 当前13位毫秒级时间戳,3分钟内有效
sign string 签名,为32位大写的MD5值
channelId int 频道号
page int 第几页,默认:1(第一页)
pageSize int 每页数据大小,默认每页100条数据,最大每页1000条数据,最小每页1条数据
toGetSubRooms int 是否获取转播频道在线人数,1:表示获取,0:表示不获取

响应成功JSON示例:

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": {
        "pageSize": 2,
        "pageNumber": 1,
        "totalItems": 2,
        "contents": [
            {
                "userId": "ovtl9t4a6-vVGrnOVZvA95zuk2x4",
                "pic": "https://s1.videocc.net/default-img/avatar/viewer.png",
                "nick": "123",
                "roomId": "1888749"
            }
        ],
        "startRow": 1,
        "firstPage": true,
        "lastPage": true,
        "prePageNumber": 1,
        "limit": 2,
        "totalPages": 1,
        "endRow": 2,
        "nextPageNumber": 1,
        "offset": 0
    }
}

响应失败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": 403,
    "status": "error",
    "message": "illegal channel id: 1779742",
    "data": ""
}

非法参数

{
    "code": 400,
    "status": "error",
    "message": "param is not digit: size",
    "data": ""
}

参数数值超出规定范围

{
    "code": 400,
    "status": "error",
    "message": "number range error",
    "data": ""
}

字段说明

参数名 类型 说明
code int 响应代码,成功为200,失败为400,签名错误为401,异常错误500
status string 成功为success,失败为error
message string 错误时为错误提示消息
data object 响应结果集
pageNumber int 当前的页数
totalItems int 总的条数
contents array 查询的结果列表
contents[0].userId int 加入房间的userId
contents[0].pic string 加入房间的头像
contents[0].nick int 加入房间的昵称
contents[0].roomId string 房间号
firstPage boolean 是否为第一页,值为:true/false
lastPage boolean 是否为最后一页,值为:true/false
nextPageNumber int 下一页编号
prePageNumber int 上一页编号
totalPages int 总页数
startRow int 当前页第一个数量的位置
endRow int 当前页最后一个数量的位置
limit int 每页数量大小

Java请求示例

public static void main(String[] args) {
        String url = "https://api.polyv.net/live/v3/channel/chat/get-chat-user-list";
        // 用户对应的appId和加密串
        String appId = "xxxxxxxxx";
        String appSecret = "xxxxxxxxxxxxxxxxxxxxxxxxxx";
        Map<String, String> params = new HashMap<>();
        params.put("channelId", "0000000");
        params.put("page", "1");
        params.put("size", "10");
        PolyvTool.setLiveSign(params, appId, appSecret);
        // 调用Polyv的httpClient工具类发送请求
        String content = HttpClientUtil.getInstance()
                .sendHttpGet(url + "?" + PolyvTool.mapJoinNotEncode(params));
        System.out.println(content);
    }

签名规则(PolyvTool.java文件代码查看)

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

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

观众进行积分打赏的接口

接口URL

https://api.polyv.net/live/v3/channel/donate/point/reward

接口说明

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

1、接口用于观众进行积分打赏的接口
2、接口支持https

返回结果格式

JSON

请求方式

POST

请求参数

参数名 必选 类型 说明
token string 接口请求的凭证
channelId int 频道号
viewerId string 观众ID
goodId int 打赏的ID
goodNum int 打赏的数量,默认为1
nickname string 观众昵称
avartar string 观众头像

响应成功JSON示例:

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

响应失败JSON示例:

token过期了

{
    "code": 400,
    "status": "error",
    "message": "token expired",
    "data": ""
}

非法的token

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

必填参数不能空

{
    "code": 400,
    "status": "error",
    "message": "param should not be empty: viewerId",
    "data": ""
}
{
    "code": 400,
    "status": "error",
    "message": "param should not be empty: channelId",
    "data": ""
}
{
    "code": 400,
    "status": "error",
    "message": "param should not be empty: goodId",
    "data": ""
}

非法的访问

{
    "code": 400,
    "data": "",
    "message": "forbidden",
    "status": "error"
}

字段说明

参数名 说明
code 响应代码,成功为200,失败为400,签名错误为403,异常错误500
status 成功为success,失败为error
message 错误时为错误提示消息
data int,返回观众对应的可用积分数

Java请求示例

public static void test() {
        String url = "https://api.polyv.net/live/v3/channel/donate/point/reward";
        String token = "xxxxxxxxx";
        String viewerId = "xxxxxxxxxxxxxxxxxxxxxxxxxx";
        int channelId = 10001;
        int goodId = 2;
        Map<String, String> params = new HashMap<>();
        params.put("channelId", channelId);
        params.put("viewerId", viewerId);
        params.put("token", token);
        params.put("goodId",goodId);
        // 调用Polyv的httpClient工具类发送请求
        String content = HttpClientUtil.getInstance()
                .sendHttpGet(url + "?" + PolyvTool.mapJoinNotEncode(params));
        System.out.println(content);
    }

签名规则(PolyvTool.java文件代码查看)

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

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

获取观众积分打赏的积分

接口URL

https://api.polyv.net/live/v3/channel/donate/point/get

接口说明

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

1、接口用于获取观众积分打赏的积分
2、接口支持https

返回结果格式

JSON

请求方式

GET

请求参数

参数名 必选 类型 说明
token string 接口请求的凭证
channelId int 频道号
viewerId string 观众ID
nickname string 观众昵称,做urlencode

响应成功JSON示例:

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

响应失败JSON示例:

token过期了

{
    "code": 400,
    "status": "error",
    "message": "token expired",
    "data": ""
}

非法的token

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

必填参数不能空

{
    "code": 400,
    "status": "error",
    "message": "param should not be empty: viewerId",
    "data": ""
}
{
    "code": 400,
    "status": "error",
    "message": "param should not be empty: channelId",
    "data": ""
}

非法的访问

{
    "code": 400,
    "data": "",
    "message": "forbidden",
    "status": "error"
}

字段说明

参数名 说明
code 响应代码,成功为200,失败为400,签名错误为403,异常错误500
status 成功为success,失败为error
message 错误时为错误提示消息
data int,返回观众对应的可用积分数

Java请求示例

public static void test() {
        String url = "https://api.polyv.net/live/v3/channel/donate/point/get";
        String token = "xxxxxxxxx";
        String viewerId = "xxxxxxxxxxxxxxxxxxxxxxxxxx";
        int channelId = 10001;
        Map<String, String> params = new HashMap<>();
        params.put("channelId", channelId);
        params.put("viewerId", viewerId);
        params.put("token", token);
        // 调用Polyv的httpClient工具类发送请求
        String content = HttpClientUtil.getInstance()
                .sendHttpGet(url + "?" + PolyvTool.mapJoinNotEncode(params));
        System.out.println(content);
    }

签名规则(PolyvTool.java文件代码查看)

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

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

获取观众观看调用接口token

接口URL

http://api.polyv.net/live/v3/channel/watch/get-api-token

接口说明

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

1、获取观众观看调用接口token
2、接口支持https

返回结果支持格式

JSON

请求方式

POST

请求数限制

TRUE

请求参数

参数名 必选 类型 说明
appId string 从API设置中获取,在直播系统登记的appId
timestamp long 当前13位毫秒级时间戳,3分钟内有效
sign string 签名,为32位大写的MD5值
channelId int 频道号
viewerId string 观众viewerId,长度:1-64位字符

响应成功JSON示例:

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

响应失败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": 403,
    "status": "error",
    "message": "illegal channel id: 1779742",
    "data": ""
}

字段说明

参数名 类型 说明
code int 响应代码,成功为200,失败为400,签名错误为401,异常错误500
status string 成功为success,失败为error
message string 错误时为错误提示消息
data object 返回接口对象
token string 调用接口token, 8小时有效

Java请求示例

public static void main(String[] args) {
        String url = "http://api.polyv.net/live/v3/channel/watch/get-api-token";
        // 用户对应的appId和加密串
        String appId = "xxxxxxxxx";
        String appSecret = "xxxxxxxxxxxxxxxxxxxxxxxxxx";
        Map<String, String> params = new HashMap<>();
        params.put("channelId", "0000000");
        params.put("viewerId", "1234567890");
        PolyvTool.setLiveSign(params, appId, appSecret);
        // 调用Polyv的httpClient工具类发送请求
        String content = HttpClientUtil.getInstance()
                .sendHttpPost(url, params, null);
        System.out.println(content);
    }

签名规则(PolyvTool.java文件代码查看)

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

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

获取频道的rtmp拉流地址

接口URL

https://api.polyv.net/live/v3/channel/monitor/rtmp-pull-url

接口说明

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

1、接口用于获取频道获取频道的rtmp拉流地址
2、接口支持https

返回结果格式

JSON

请求方式

GET

请求参数

参数名 必选 类型 说明
appId string 从API设置中获取,在直播系统登记的appId
timestamp long 当前13位毫秒级时间戳,3分钟内有效
sign string 签名,为32位大写的MD5值
channelId int 频道号
day int 有效期天数,如:1表示从当前时间算起一天内有效

响应成功JSON示例:

{
    "code": 200,
    "status": "success",
    "message": "",
    "data":  "rtmp://pull-d1.videocc.net/recordf/4f57ea01de16002237826505a7b?auth_key=1602645379-0-0-5d6bc0d1ea472b161ee9e0ea3646bess"
}

响应失败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": 400,
    "data": "",
    "message": "forbidden",
    "status": "error"
}

字段说明

参数名 说明
code 响应代码,成功为200,失败为400,签名错误为403,异常错误500
status 成功为success,失败为error
message 错误时为错误提示消息
data 成功数据

Java请求示例

public static void test() {
        String url = "https://api.polyv.net/live/v3/channel/monitor/rtmp-pull-url";
        // 用户对应的appId和加密串
        String appId = "xxxxxxxxx";
        String appSecret = "xxxxxxxxxxxxxxxxxxxxxxxxxx";
        int channelId = 10001;
        Map<String, String> params = new HashMap<>();
        params.put("channelId", channelId);
        params.put("day", 1);
        PolyvTool.setLiveSign(params, appId, appSecret);
        // 调用Polyv的httpClient工具类发送请求
        String content = HttpClientUtil.getInstance()
                .sendHttpGet(url + "?" + PolyvTool.mapJoinNotEncode(params));
        System.out.println(content);
    }

签名规则(PolyvTool.java文件代码查看)

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

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