Referencia de la API de consulta de estado de Travel de HappyOyster-Adventure - Alibaba Cloud Model Studio

Consulta el ciclo de vida del Travel de Adventure, el estado de streaming en el servidor y el conjunto de acciones del mundo actual; también puede reportar simultáneamente el heartbeat de pull-stream o reproducción del cliente.

Ámbito

Autenticación: La clave de API principal no es obligatoria; pueden invocarla tanto la clave principal como una temporal. Para saber cómo obtenerlas, consulte Obtener credenciales de autenticación.
Requisitos previos: Consulte con el encryptedTravelId devuelto por Ingresar a Travel.
Solicitante: Puede invocarlo su servidor o su cliente. Se recomienda sondear cada 2–5 segundos.

Solicitud HTTP

Singapore

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

Reemplace {WorkspaceId} con su ID de espacio de trabajo real.

China (Beijing)

GET https://{WorkspaceId}.cn-beijing.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-adventure/openapi/v1/travels/status

Reemplace {WorkspaceId} con su ID de espacio de trabajo real.

EE. UU. (Virginia)

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

Reemplace {WorkspaceId} con su ID de espacio de trabajo real.

Parámetros de solicitud

Consultar estado de Travel

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

Authorization string (Requerido)

Autenticación mediante clave de API. No se requiere la clave de API principal; pueden invocarla tanto la clave principal como una temporal.

Clave de API principal: comienza con sk-, por ejemplo, sk-xxx.
Clave de API temporal: comienza con st-, por ejemplo, st-xxx.

Parámetros de consulta

encryptedTravelId string (Obligatorio)

El ID de Travel cifrado de Adventure. Devuelto por Enter Travel.

clientStreamStatus string (Opcional)

El estado de recepción de flujo o reproducción RTC del cliente, sin distinción entre mayúsculas y minúsculas. Los valores no reconocidos se ignoran. Valores permitidos:

DISCONNECTED: no conectado o ha abandonado el canal
CONNECTING: conectando al canal RTC
CONNECTED: unido, pero la reproducción no ha comenzado o el primer fotograma no ha llegado
PLAYING: se ha recibido la transmisión remota y se está renderizando
BUFFERING: almacenando en búfer
PAUSED: el cliente pausó la reproducción; esto no significa que el Travel de Adventure admita la pausa en el servidor
RECONNECTING: reconectando

clientStreamStatusTimeMs long (Opcional)

La marca de tiempo en milisegundos del cambio de estado del cliente. Se utiliza junto con clientStreamStatus.

Parámetros de respuesta

Travel en ejecución

{
    "code": 0,
    "message": null,
    "data": {
        "encryptedTravelId": "trvl_a1b2****",
        "status": "running",
        "rtcStatus": "PUSHING",
        "updateTime": "2026-06-04T00:02:00Z",
        "userInstructions": null,
        "chapters": null,
        "characterActions": [
            "dash",
            "jump",
            "crouch",
            "attack"
        ],
        "environmentActions": [
            "ride_motorcycle",
            "enter_exit_car"
        ]
    }
}

code integer

Código de retorno. 0 indica éxito; un valor distinto de cero es un código de error.

message string

Mensaje de error. null en caso de éxito.

data object

Datos de respuesta. null en caso de fallo.

Propiedades

encryptedTravelId string

ID de viaje cifrado.

status string

Estado del ciclo de vida del Travel:

init: inicializando recursos de sesión
pending: en cola o esperando recursos del servicio
running: en ejecución; puede controlarlo en tiempo real mediante el SDK sendCommand
failed: el Travel falló
completed: el Travel ha finalizado; se pueden consultar los artefactos

Las capacidades del producto Adventure no tienen estado paused; no construya una máquina de estados basada en pausa / reanudación.

rtcStatus string

Estado de transmisión RTC del lado del servidor; diferente del clientStreamStatus reportado por el cliente.

updateTime string

Última hora de actualización, en formato ISO 8601.

userInstructions null | array

Adventure no admite HTTP instruct, y las acciones de exploración no se reflejan en este campo; usualmente es null o [], y puede ignorarse.

chapters array

La lista de capítulos; null cuando no se han generado datos de capítulos.

characterActions array

IDs de acción disponibles para el personaje o sujeto actual; [] cuando no hay recomendaciones. Por lo general, se devuelven de 2 a 4. Acciones comunes:

dash: avanzar rápidamente
jump: saltar
crouch: agacharse / tumbarse
attack: atacar

environmentActions array

IDs de acción de interacción con el entorno disponibles para la escena actual; [] cuando no hay recomendaciones. El servidor selecciona de 0 a 3 de un conjunto fijo de acciones según la escena y puede devolver una matriz vacía. Acciones comunes:

ride_horse: montar a caballo
ride_bicycle: montar en bicicleta
ride_motorcycle: conducir una motocicleta
enter_exit_car: entrar / salir de un automóvil
open_close_door: abrir / cerrar una puerta
take_cover: ponerse a cubierto
car_light: encender las luces del automóvil; puede aparecer solo cuando también se devuelve enter_exit_car
car_horn: tocar la bocina; puede aparecer solo cuando también se devuelve enter_exit_car

Estados previos y notas de llamada

Sondee cada 2–5 segundos.
Las capacidades del producto Adventure no tienen estado paused; no construya una máquina de estados basada en pausa / reanudación.
characterActions y environmentActions son sugerencias de acciones disponibles; el control real todavía se envía mediante el SDK sendCommand.
Este endpoint no devuelve mode, playUrl, bgmUrl ni sessionId; la configuración de streaming se basa en la respuesta de Enter Travel.
clientStreamStatus es el latido de reproducción del lado del cliente, y rtcStatus es el estado de transmisión del lado del servidor; no son intercambiables.
Adventure no admite HTTP instruct, pause, resume, rewind ni update-script; no integre las siguientes rutas como capacidades HTTP disponibles: /travels/instruct, /travels/pause, /travels/resume, /travels/rewind, /travels/update-script.

Códigos de error

Si la llamada al modelo falla y devuelve un error, consulte Códigos de error de HappyOyster para resolverlo.

Siguientes pasos

Después de que el Travel pase a running:

El cliente envía controles de dirección, punto de vista y acción a través del SDK sendCommand (puede leer primero el conjunto de acciones devuelto por este endpoint).
Finalizar Travel: finalice la sesión y gestione los artefactos.