tencent cloud

文档反馈

查询会话状态

最后更新时间:2024-07-19 10:02:21
    查询指定会话的当前状态。

    调用协议

    HTTPS + JSON
    POST /v2/ivh/sessionmanager/sessionmanagerservice/statsession
    Header Content-Type: application/json;charset=utf-8

    请求参数

    参数名称
    必选
    类型
    描述
    ReqId
    String
    单次请求唯一标识,长度为32的 uuid。
    SessionId
    String
    会话唯一标识。

    返回参数

    参数名称
    必选
    类型
    描述
    ReqId
    String
    单次请求唯一标识。
    SessionStatus
    int
    流状态。1:进行中,2:已关闭,3:准备中,4:建流失败
    PlayStreamAddr
    string
    流播放地址
    SpeakStatus
    string
    数智人状态。Initial:初始状态。WaitingTextStart:等待文本播报开始。TextStart:文本播报中。WaitingTextOver:等待文本播报结束。TextOver:文本播报结束。WaitingAudioStart:等待音频开始播报。AudioStart:音频开始播报。WaitingAudioOver:等待音频播报结束。AudioOver:音频播报结束。Error:驱动错误(与 TextOver 和 AudioOver 含义一样表示一次驱动的终态),仅表示最近一次驱动失败,不影响继续发送驱动命令。
    IsSessionStarted
    bool
    是否已经开启会话,只有开启状态,才可以发送驱动指令。
    注意:
    返回 false 时,需要调用开启会话接口进行开启
    ErrorCode
    int
    当前状态对应的错误码,0为正常。错误码列表参考7.2
    ErrorMessage
    string
    当前状态对应的错误信息。

    请求示例

    {
    "Header": {},
    "Payload": {
    "ReqId": "d7aa08da33dd4a662ad5be508c5b77cf",
    "SessionId": "m123"
    }
    }

    返回示例

    {
    "Header": {
    "Code": 0,
    "Message": "",
    "RequestID": "123",
    },
    "Payload": {
    "ReqId": "d7aa08da33dd4a662ad5be508c5b77cf",
    "SessionStatus": 1,
    "PlayStreamAddr": "rtmp://live.qq.com/live/m789",
    "SpeakStatus": "TextOver",
    "IsSessionStarted": true,
    "ErrorCode": 0,
    "ErrorMessage": ""
    }
    }
    
    联系我们

    联系我们,为您的业务提供专属服务。

    技术支持

    如果你想寻求进一步的帮助,通过工单与我们进行联络。我们提供7x24的工单服务。

    7x24 电话支持