Path: /api/live/stop
Method: GET
接口描述:
版本:v.1.0.0
最后修改日期:2022-05-18
API系统加密方式:THQS加密
如果请求失败,将返回错误信息,其中错误码可以快速定位问题,建议提供错误码排查问题。
其中常见的错误码如下:
| 错误码 | 描述 | 备注 |
|---|---|---|
| 10000000 | 参数错误 | 检查请求参数正否正确 |
| 10000001 | 系统错误 | 联系客服解决问题 |
| 10000012 | THQS加密错误 | THQS加密错误,原因可能是加密错误(参考TQHS) |
Query
| 参数名称 | 是否必须 | 示例 | 备注 |
|---|---|---|---|
| accountId | 是 | 2BBA984E86119800 | 客户ID |
| liveId | 是 | 000F94FA465E033A9C33DC5901307461 | 直播ID |
| tips | 否 | stu tip::assistant tip::host tip::publisher tip | 提示语。用::分隔,每一角色的提示语不可超过40个字符。 |
| tipIndex | 否 | 0,2,3,1 | 如果赋值,必须给4个数字,依次表示学员、助教、主持人、讲师将收到的提示语在tips中的索引,从0开始。 |
xxxxxxxxxx举例说明:tipIndex 和 tips的使用规则假设入参:tips = "aa::bb::cc::dd"tipIndex = "0,2,3,1"则表示:学员将收到提示提示语aa,助教将收到提示语cc,主持人将收到提示语dd,推流者将收到提示语bb如果各角色收到的提示语完全一致,假设为abc,则可如下赋值tips = "abc"tipIndex = "0,0,0,0"
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| success | boolean | 必须 | true:成功 false:错误 | ||
| error | object | 非必须 | 错误信息 | ||
| ├─code | integer | 非必须 | 错误码 | ||
| ├─message | string | 非必须 | 错误描述信息 |