Query the Acting Travel lifecycle, server-side streaming status, sent text instructions, and chapter information; you can also report the client's pull-stream or playback heartbeat at the same time.
Scope
Query the Acting Travel lifecycle, server-side streaming status, sent text instructions, and chapter information; you can also report the client's pull-stream or playback heartbeat at the same time. Before calling, confirm the following:
- Authentication: The primary API Key is not required; either the primary or a temporary API Key can call it. For how to obtain them, see Obtain authentication credentials.
- Prerequisites: Query with the
encryptedTravelIdreturned by Enter Travel. - Caller: Either your server or your client can call it. Polling every 2–5 seconds is recommended.
HTTP request
- Singapore
- US (Virginia)
GET https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-acting/openapi/v1/travels/statusReplace {WorkspaceId} with your actual Workspace ID.Request parameters |
|
Authorization string (Required)API Key authentication. The primary API Key is not required; either the primary or a temporary API Key can call it.
| |
Query parameters | |
encryptedTravelId string (Required)The Acting encrypted Travel ID. Returned by Enter Travel. | |
clientStreamStatus string (Optional)The client's RTC pull-stream or playback status, case-insensitive. Unrecognized values are ignored. Allowed values:
| |
clientStreamStatusTimeMs long (Optional)The millisecond timestamp of the client state change. Used together with clientStreamStatus. |
Response parameters |
|
code integerReturn code. 0 means success; non-zero is an error code. | |
message stringError message. null on success. | |
data objectResponse data. null on failure.
Properties encryptedTravelId stringEncrypted Travel ID.status stringTravel lifecycle status:
stringServer-side RTC streaming status; different from the clientStreamStatus reported by the client.updateTime stringLast update time, in ISO 8601 format.userInstructions arrayThe list of text instructions; null when there is no data. Each item contains instruction (instruction text), relativeStartTimeMs / relativeEndTimeMs (relative milliseconds), startTime / endTime (timeline seconds), and status (execution status).chapters arrayThe chapter list; null when chapter detection has not been triggered. Each item contains chapterId, title, brief, actRange, startTime, endTime, and chapterImage.characterActions array<string> | nullActing does not support SDK action control; returns an empty array; null when failed.environmentActions array<string> | nullActing does not support SDK environment action control; returns an empty array; null when failed.errorCode stringReturned only when status=failed; a structured failure reason code. See Error codes for values.errorMessage stringReturned together with errorCode; an English failure description. Branch on errorCode, not on errorMessage. |
Prerequisite states and call notes
- Polling every 2–5 seconds is recommended.
- Both
runningandpausedallow calling Send Process Instruction; sending an instruction in thepausedstate does not automatically resume the Travel. - This endpoint does not return
mode,aspectRatio,playUrl,bgmUrl, orsessionId; the streaming configuration and player orientation are based on the Enter Travel response. clientStreamStatusis the client-side playback heartbeat, andrtcStatusis the server-side streaming status; they are not interchangeable.- Acting does not support the SDK
sendCommand; do not build direction or action controls based on the two empty action arrays. failedis a terminal state and no video will be produced; show the failure reason based onerrorCode, and do not display it as "not yet complete".
Error codes
If the model call fails and returns an error, see HappyOyster Error Codes to resolve it.
Next steps
When the Travel is running or paused:
- Send Process Instruction: drive the subsequent character performance.
- Pause Travel / Resume Travel.
- End Travel: query artifacts after ending.