查询 Directing Travel 生命周期、服务端推流状态、已执行文本指令和章节信息，也可同时上报客户端拉流或播放心跳。
适用范围
查询 Directing 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-directing/openapi/v1/travels/status调用时请将{WorkspaceId}替换为真实的Workspace ID。请求参数 |
|
Authorization string （必选）API Key 鉴权。不强制主 API Key，主 API Key 或临时 API Key 均可调用。
| |
Query 参数 | |
encryptedTravelId string （必选）Directing 加密 Travel ID。由客户端进入房间接口返回。 | |
clientStreamStatus string （可选）客户端 RTC 拉流或播放状态，大小写不敏感。无法识别的值会被忽略。可选值：
| |
clientStreamStatusTimeMs long （可选）客户端状态变更的毫秒时间戳。与 clientStreamStatus 配套使用。 |
响应参数 |
|
code integer返回码。0 表示成功，非 0 为错误码。 | |
message string错误信息。成功时为 null。 | |
data object响应数据。失败时为 null。
属性 encryptedTravelId string加密 Travel ID。status stringTravel 生命周期状态：
string服务端 RTC 推流状态；与客户端上报的 clientStreamStatus 不同。updateTime string最近更新时间，ISO 8601 格式。userInstructions array文本指令列表；无数据时为 null。每项含 instruction、relativeStartTimeMs / relativeEndTimeMs（相对毫秒）、startTime / endTime（时间轴秒数）、status。chapters array章节列表；尚未触发章节检测时为 null。每项含 chapterId、title、brief、actRange、startTime、endTime、chapterImage。characterActions array<string> | nullDirecting 不支持 SDK 动作控制，固定返回空数组；failed 时为 null。environmentActions array<string> | nullDirecting 不支持 SDK 环境动作控制，固定返回空数组；failed 时为 null。errorCode string仅 status=failed 时返回；结构化失败原因代码，取值见错误码。errorMessage string与 errorCode 同时返回；英文失败说明。请按 errorCode 分支处理，不要匹配 errorMessage 文案。 |
前置状态与调用注意事项
- 建议每 2–5 秒轮询。
running状态可按creationModel调用支持的控制接口：普通模式可instruct、pause、resume、rewind、end；剧本模式可update-script、pause、resume、rewind、end。- 本接口不返回
mode、aspectRatio、playUrl、bgmUrl或sessionId；播流配置以进入房间响应为准。 clientStreamStatus是客户端播放侧心跳，rtcStatus是服务端推流侧状态，两者不可互相替代。failed是终态，不会再产生成片；请按errorCode展示失败原因，不要展示为「尚未完成」。
错误码
如果模型调用失败并返回报错信息，请参见HappyOyster 错误码进行解决。
下一步
Travel 为 running 或 paused 时：