版本:v.1.0.2
最后修改日期:2020-07-10
加密方式:THQS加密
如果请求失败,将返回错误信息,其中错误码可以快速定位问题,建议提供错误码排查问题。
其中常见的错误码如下:
| 错误码 | 描述 | 备注 |
|---|---|---|
| 10000000 | 参数错误 | 检查请求参数是否有问题 |
| 10000001 | 系统错误 | 联系客服解决问题 |
| 10000010 | ID错误 | 传入加密ID存在问题 |
| 10000011 | 加密KEY错误 | 账号KEY非法,请求可能传入非法客户ID,或者该客户的加密KEY不存在 |
| 10000012 | THQS加密错误 | THQS加密错误,原因可能是加密错误(参考TQHS),也能是超时 |
| 10000013 | 组件异常 | 联系客服解决问题 |
| 10000014 | 存在无效参数 | 可能是直播间与账号不一致、直播不存在等原因导致。 |
| 10000015 | 直播间平台错误 | 某些操作只能操作直播平台的直播间,如果传入非直播平台的直播间则报该错误信息。 |
| 10000016 | 直播间状态非法 | 某操作无法在该状态的直播间上进行操作,比如:无法对已关闭的直播间进行开始直播的操作。 |
| 10000017 | 组件调用错误 | 联系客服解决问题 |
| 10000018 | 组件处理失败 | 联系客服解决问题 |
| 10000019 | 直播间配置错误 | 无法对该配置的直播间进行操作,比如:无法对非主持人模式的直播间进行主持人相关的操作 |
| 10000020 | 直播间状态错误 | 该功能无法在该状态的直播间上进行操作,比如:无法对已删除的直播进行开始直播的操作。 |
| 20000000 | 主槽没有流 | 主持人,主槽没有流,无法开始直播,主槽推流 |
Path: https://api.csslcloud.net/api/host/live/start
Method: GET
接口描述:
Query
| 参数名称 | 是否必须 | 示例 | 备注 |
|---|---|---|---|
| accountId | 是 | 2BBA984E86119800 | 客户ID |
| roomId | 是 | 000F94FA465E033A9C33DC5901307461 | 直播间ID |
| record | 否 | 1 | 是否录制,1:录制,0:不录制(默认为0) |
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| success | boolean | 必须 | |||
| error | object | 非必须 | 错误信息 | ||
| ├─ code | integer | 非必须 | 错误码 | ||
| ├─ message | string | 非必须 | 错误描述信息 | ||
| data | object | 非必须 | |||
| ├─ live | object | 非必须 | |||
| ├─ id | string | 非必须 | 开始的直播ID |
Path: https://api.csslcloud.net/api/host/live/stop
Method: GET
接口描述:
Query
| 参数名称 | 是否必须 | 示例 | 备注 |
|---|---|---|---|
| accountId | 是 | 2BBA984E86119800 | 客户ID |
| liveId | 是 | 753C612EB38A8D5A | 直播ID |
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| success | boolean | 必须 | |||
| error | object | 非必须 | |||
| ├─ code | integer | 非必须 | 错误码 | ||
| ├─ message | string | 非必须 | 错误描述信息 | ||
| data | object | 非必须 |