查询 Adventure Travel 生命周期、服务端推流状态和当前世界的动作池,也可同时上报客户端拉流或播放心跳。
适用范围
查询 Adventure Travel 生命周期、服务端推流状态和当前世界的动作池,也可同时上报客户端拉流或播放心跳。调用前请确认以下事项:
- 鉴权要求:不强制主 API Key,主 API Key 或临时 API Key 均可调用。获取方式请参见获取鉴权凭证。
- 前置条件:使用客户端进入房间接口返回的
encryptedTravelId查询。 - 调用方:您的服务端或客户端均可调用。建议每 2–5 秒轮询。
HTTP调用
- 新加坡
- 华北2(北京)
- 美国(弗吉尼亚)
GET https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-adventure/openapi/v1/travels/status调用时请将{WorkspaceId}替换为真实的Workspace ID。请求参数 |
|
Authorization string (必选)API Key 鉴权。不强制主 API Key,主 API Key 或临时 API Key 均可调用。
| |
Query 参数 | |
encryptedTravelId string (必选)Adventure 加密 Travel ID。由客户端进入房间接口返回。 | |
clientStreamStatus string (可选)客户端 RTC 拉流或播放状态,大小写不敏感。无法识别的值会被忽略。可选值:
| |
clientStreamStatusTimeMs long (可选)客户端状态变更的毫秒时间戳。与 clientStreamStatus 配套使用。 |
响应参数 |
|
code integer返回码。0 表示成功,非 0 为错误码。 | |
message string错误信息。成功时为 null。 | |
data object响应数据。失败时为 null。
属性 encryptedTravelId string加密 Travel ID。status stringTravel 生命周期状态:
paused 状态,不要围绕暂停 / 恢复构建状态机。rtcStatus string服务端 RTC 推流状态;与客户端上报的 clientStreamStatus 不同。updateTime string最近更新时间,ISO 8601 格式。userInstructions null | arrayAdventure 不支持 HTTP instruct,探索动作也不会回显到该字段;通常为 null 或 [],请忽略。chapters array章节列表;未生成章节数据时为 null。characterActions array当前角色 / 主体可用动作 ID;无推荐时为 []。通常返回 2–4 个。常见动作:
array当前场景可用环境交互动作 ID;无推荐时为 []。服务端按场景从固定动作池中选择 0–3 个,可返回空数组。常见动作:
|
前置状态与调用注意事项
- 建议每 2–5 秒轮询。
- Adventure 产品能力没有
paused状态,不要围绕暂停 / 恢复构建状态机。 characterActions和environmentActions是可用动作提示;实际操控仍通过 SDKsendCommand发送。- 本接口不返回
mode、playUrl、bgmUrl或sessionId;播流配置以进入房间响应为准。 clientStreamStatus是客户端播放侧心跳,rtcStatus是服务端推流侧状态,两者不可互相替代。- Adventure 不支持 HTTP
instruct、pause、resume、rewind、update-script;不要把以下路径作为可用 HTTP 能力集成:/travels/instruct、/travels/pause、/travels/resume、/travels/rewind、/travels/update-script。
错误码
如果模型调用失败并返回报错信息,请参见HappyOyster 错误码进行解决。
下一步
Travel 为 running 后:
- 客户端通过 SDK
sendCommand发送方向、视角和动作控制(可先读取本接口返回的动作池)。 - 结束Travel:结束会话并处理产物。