有奖捉虫:云通信与企业服务文档专题,速来> HOT

1. 接口描述

接口请求域名: live.tencentcloudapi.com 。

返回直播中、无推流或者禁播等状态。

使用建议:
该接口提供实时流状态查询功能,鉴于网络抖动等一些不可抗因素,使用该接口作为判断主播是否开播等重要业务场景时,请参考以下使用建议。

  1. 优先使用业务自身的房间开关播逻辑,判断主播是否在线,譬如客户端开播信令和主播在线心跳等。
  2. 对于没有房间管理的直播场景,可以结合以下方案综合判断。
    2.1 根据推断流事件通知 判断主播在线状态。
    2.2 通过定时(间隔>1min)查询直播中的流接口,判断主播是否在线。
    2.3 通过 本接口 查询直播流状态,判断主播是否在线。
    2.4 以上任一方式判断为在线,都认为主播开播中,并且接口查询超时或解析异常时,也默认为在线,减少对业务的影响。

默认接口请求频率限制:300次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeLiveStreamState。
Version String 公共参数,本接口取值:2018-08-01。
Region String 公共参数,本接口不需要传递此参数。
AppName String 推流路径,与推流和播放地址中的AppName保持一致,默认为 live。
示例值:live
DomainName String 您的推流域名。
示例值:5000.livepush.myqcloud.com
StreamName String 流名称。
示例值:stream1

3. 输出参数

参数名称 类型 描述
StreamState String 流状态,
active:活跃,
inactive:非活跃,
forbid:禁播。
示例值:active
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 请求示例

查询流的活跃状态。

输入示例

https://live.tencentcloudapi.com/?Action=DescribeLiveStreamState
&DomainName=5000.livepush.myqcloud.com
&AppName=live
&StreamName=stream1
&<公共请求参数>

输出示例

{
    "Response": {
        "StreamState": "active",
        "RequestId": "8e50cdb5-56dc-408b-89b0-31818958d424"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation 操作失败。
FailedOperation.CallOtherSvrFailed 调用内部服务失败。
InternalError 内部错误。
InternalError.CallOtherSvrError 调用内部服务错误。
InternalError.ConfigNotExist 配置不存在。
InternalError.GetBizidError 获取用户账号错误。
InternalError.GetStreamInfoError 获取流信息失败。
InternalError.GetUpstreamInfoError 获取直播源信息错误。
InternalError.NotPermmitOperat 无权限操作。
InternalError.StreamStatusError 流状态异常。
InternalError.UpdateDataError 更新数据失败。
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误。
MissingParameter 缺少参数错误。
ResourceNotFound.ForbidService 用户被禁用。
ResourceNotFound.FreezeService 用户服务被冻结。
ResourceNotFound.StopService 账号停服,请先冲正开通服务后再操作。
ResourceNotFound.UserDisableService 用户主动停服。
ResourceNotFound.UserNotExist 用户未注册直播。