概述

版本: 2.6.0
日期: 2019-05-22

相关说明

利用Live API 可以与CC直播进⾏对接,使用直播系统的主要功能。 目前Live API 仅对合作⽅开启,如果您有使用的需求,请通过CC直播后台获取API Key。

通信约定

Live API 的远程通信接口基于 HTTP 协议,并有以下约定:

HTTP方法

所有接口如没特别说明均采用 GET 请求,同一账号接口请求次数上限为200次/分钟。

返回格式

接口的返回格式为JSON 格式,编码均为 UTF-8。对于不同的接口,正确的返回结果的格式会在每个接口中单独定义,错误的返回结果具有统一的形式,如下所示:

{
    "result": "FAIL",
    "reason": "错误原因"
}

错误原因对照表:

失败原因 说明
invalid param 请求参数无效,请检查参数名称以及参数值是否正确
invalid encrypt 接口THQS加密请求无效
database error 系统内部错误,请稍后重试
system error 系统内部错误,请稍后重试
invalid operation 操作无效,例如:直播间有直播正在进行时,关闭直播间则报此类错误

编码格式

Live API 只接受 UTF-8 格式编码的信息,返回的数据也都是 UTF-8 编码的。当需要通过 GET 请求传递参数时,QueryString 里面的 value 值都需要进行 URL Encode 之后,再进行THQS加密。

加密

所有的 HTTP 通信都是加密的,加密的核心思想是将原始的 QueryString 转换为和请求时间相关的 HashedQueryString,我们称这个加密算法为 THQS 算法。关于 THQS 算法的细节请参见HTTP通信加密算法

接口请求参数

所有接口请求参数如果没有特别说明都是必填项。

直播间模板类型及说明

模板类型 说明
1 模板一 视频直播
2 模板二 视频直播+聊天互动+直播问答
3 模板三 视频直播+聊天互动
4 模板四 视频直播+聊天互动+直播文档
5 模板五 视频直播+聊天互动+直播文档+直播问答
6 模板六 视频直播+直播问答

results matching ""

    No results matching ""