HappyOyster-Acting-查询Travel状态 API参考

更新时间:
复制 MD 格式

查询 Acting Travel 生命周期、服务端推流状态、已发送文本指令和章节信息,也可同时上报客户端拉流或播放心跳。

适用范围

查询 Acting Travel 生命周期、服务端推流状态、已发送文本指令和章节信息,也可同时上报客户端拉流或播放心跳。调用前请确认以下事项:

  • 鉴权要求不强制主 API Key,主 API Key 或临时 API Key 均可调用。获取方式请参见获取鉴权凭证
  • 前置条件:使用客户端进入房间接口返回的 encryptedTravelId 查询。
  • 调用方:您的服务端或客户端均可调用。建议每 2–5 秒轮询。

HTTP调用

新加坡

GET https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-acting/openapi/v1/travels/status

调用时请将{WorkspaceId}替换为真实的Workspace ID

美国(弗吉尼亚)

GET https://{WorkspaceId}.us-east-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-acting/openapi/v1/travels/status

调用时请将{WorkspaceId}替换为真实的Workspace ID

请求参数

curl --location 'https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-acting/openapi/v1/travels/status?encryptedTravelId={encryptedTravelId}&clientStreamStatus=PLAYING&clientStreamStatusTimeMs=1788940800000' \
    -H "Authorization: Bearer $DASHSCOPE_API_KEY"

Authorization string (必选)

API Key 鉴权。不强制主 API Key,主 API Key 或临时 API Key 均可调用。

  • 主 API Key:以 sk- 开头,如 sk-xxx
  • 临时 API Key:以 st- 开头,如 st-xxx
Query 参数

encryptedTravelId string (必选)

Acting 加密 Travel ID。由客户端进入房间接口返回。

clientStreamStatus string (可选)

客户端 RTC 拉流或播放状态,大小写不敏感。无法识别的值会被忽略。可选值:

  • DISCONNECTED:未连接或已离开频道
  • CONNECTING:正在连接 RTC 频道
  • CONNECTED:已入会,尚未开始播放或首帧未到达
  • PLAYING:已收到远端流并正在渲染
  • BUFFERING:缓冲中
  • PAUSED:客户端暂停播放,不等同于服务端 pause
  • RECONNECTING:重连中

clientStreamStatusTimeMs long (可选)

客户端状态变更的毫秒时间戳。与 clientStreamStatus 配套使用。

响应参数

{
    "code": 0,
    "message": null,
    "data": {
        "encryptedTravelId": "trvl_a1b2****",
        "status": "running",
        "rtcStatus": "PUSHING",
        "updateTime": "2026-09-09T08:30:00Z",
        "userInstructions": [
            {
                "instruction": "微笑着问候,并询问我今天过得怎么样",
                "relativeStartTimeMs": 12000,
                "relativeEndTimeMs": 16000,
                "startTime": 12.0,
                "endTime": 16.0,
                "status": "executed"
            }
        ],
        "chapters": [
            {
                "chapterId": 1,
                "title": "问候",
                "brief": "角色向镜头微笑并开始对谈",
                "actRange": [0, 10],
                "startTime": 4,
                "endTime": 20,
                "chapterImage": "https://cdn.happyoyster.com/chapters/acting_ch1.jpg"
            }
        ],
        "characterActions": [],
        "environmentActions": []
    }
}

code integer

返回码。0 表示成功,非 0 为错误码。

message string

错误信息。成功时为 null

data object

响应数据。失败时为 null

属性

encryptedTravelId string

加密 Travel ID。

status string

Travel 生命周期状态:

  • init:正在初始化会话资源
  • pending:排队或等待服务资源
  • running:正在运行,可发送文本指令、暂停或结束
  • paused:服务端已暂停;可发送文本指令、恢复或结束
  • failed:Travel 失败
  • completed:Travel 已结束,可查询产物

rtcStatus string

服务端 RTC 推流状态;与客户端上报的 clientStreamStatus 不同。

updateTime string

最近更新时间,ISO 8601 格式。

userInstructions array

文本指令列表;无数据时为 null。每项含 instruction(指令文本)、relativeStartTimeMs / relativeEndTimeMs(相对毫秒)、startTime / endTime(时间轴秒数)、status(执行状态)。

chapters array

章节列表;尚未触发章节检测时为 null。每项含 chapterIdtitlebriefactRangestartTimeendTimechapterImage

characterActions array

Acting 不支持 SDK 动作控制,固定返回空数组。

environmentActions array

Acting 不支持 SDK 环境动作控制,固定返回空数组。

前置状态与调用注意事项

  • 建议每 2–5 秒轮询。
  • runningpaused 都允许调用发送文本过程指令;在 paused 状态发送指令不会自动恢复 Travel。
  • 本接口不返回 modeaspectRatioplayUrlbgmUrlsessionId;播流配置与播放器方向以进入房间响应为准。
  • clientStreamStatus 是客户端播放侧心跳,rtcStatus 是服务端推流侧状态,两者不可互相替代。
  • Acting 不支持 SDK sendCommand,不要根据两个空动作数组构造方向或动作控制。

错误码

如果模型调用失败并返回报错信息,请参见HappyOyster 错误码进行解决。

下一步

Travel 为 runningpaused 时: