异步下载聊天记录接口

接口URL

http://api.polyv.net/live/v3/channel/chat/content/create-task

接口说明

1、异步下载聊天室聊天记录接口
2、如果异步下载成功,返回下载地址,下载地址有效期一天
2、接口支持https

支持格式

JSON

请求方式

POST

请求数限制

TRUE

请求参数

参数名必选类型说明

appId

string

从API设置中获取,在直播系统登记的appId

timestamp

long

当前13位毫秒级时间戳,3分钟内有效

sign

String

签名,为32位大写的MD5值,生成签名的appSecret密钥作为通信数据安全的关键信息,严禁保存在客户端直接使用,所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据【详见签名生成规则

channelId

int

频道号

响应成功JSON示例:

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": {
	   "status": "done",
	   "url": "https://doc-oss.polyv.net/chat/export/xls/130760/130760_1597804097778.xls",
	   "lastExportTime": 1597804097778
    }
}

响应失败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

int

响应代码,成功为200,失败为400,签名错误为401,异常错误500

status

string

成功为success,失败为error

message

string

错误时为错误提示消息

data

object

响应结果集

status

string

异步下载状态 todo:待下载 done:已完成 doing:下载中

url

string

下载地址

lastExportTime

long

最后一次下载的时间,单位:毫秒

Java请求示例

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

Last updated