Skip to main content

Referencia de API HappyOyster-Acting-Query Travel Status

Consulta el ciclo de vida del Travel de Acting, el estado de transmisión del lado del servidor, las instrucciones de texto enviadas y la información de capítulos; también puede reportar simultáneamente el latido de recepción de flujo o reproducción del cliente.

Ámbito

Consulta el ciclo de vida del Travel de Acting, el estado de transmisión del lado del servidor, las instrucciones de texto enviadas y la información de capítulos; también puede reportar simultáneamente el latido de recepción de flujo o reproducción del cliente. Antes de realizar la llamada, confirme lo siguiente:
  • 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
  • EE. UU. (Virginia)
GET https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-acting/openapi/v1/travels/statusReemplace {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-acting/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 Acting. Devuelto por Ingresar a 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 implica la acción pause del lado del 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
  • Travel fallido
{
    "code": 0,
    "message": null,
    "data": {
        "encryptedTravelId": "trvl_a1b2****",
        "status": "running",
        "rtcStatus": "PUSHING",
        "updateTime": "2026-09-09T08:30:00Z",
        "userInstructions": [
            {
                "instruction": "Greet with a smile and ask how my day is going",
                "relativeStartTimeMs": 12000,
                "relativeEndTimeMs": 16000,
                "startTime": 12.0,
                "endTime": 16.0,
                "status": "executed"
            }
        ],
        "chapters": [
            {
                "chapterId": 1,
                "title": "Greeting",
                "brief": "The character smiles at the camera and starts the conversation",
                "actRange": [0, 10],
                "startTime": 4,
                "endTime": 20,
                "chapterImage": "https://cdn.happyoyster.com/chapters/acting_ch1.jpg"
            }
        ],
        "characterActions": [],
        "environmentActions": []
    }
}
code integerCódigo de retorno. 0 indica éxito; un valor distinto de cero es un código de error.
message stringMensaje de error. null en caso de éxito.
data objectDatos de respuesta. null en caso de fallo.

Propiedades

encryptedTravelId stringID de viaje cifrado.status stringEstado 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 enviar instrucciones de texto, pausar o finalizar
  • paused: pausado en el lado del servidor; puede enviar instrucciones de texto, reanudar o finalizar
  • failed: el Travel falló; consulte errorCode / errorMessage para conocer el motivo
  • completed: el Travel ha finalizado; se pueden consultar los artefactos
rtcStatus stringEstado 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 arrayLa lista de instrucciones de texto; null cuando no hay datos. Cada elemento contiene instruction (texto de la instrucción), relativeStartTimeMs / relativeEndTimeMs (milisegundos relativos), startTime / endTime (segundos de línea de tiempo) y status (estado de ejecución).chapters arrayLa lista de capítulos; null cuando no se ha activado la detección de capítulos. Cada elemento contiene chapterId, title, brief, actRange, startTime, endTime y chapterImage.characterActions array<string> | nullActing no admite el control de acciones mediante SDK; devuelve una matriz vacía; null cuando está en estado failed.environmentActions array<string> | nullActing no admite el control de acciones de entorno del SDK; devuelve un arreglo vacío; null cuando failed.errorCode stringSe devuelve solo cuando status=failed; un código estructurado de motivo de fallo. Consulte Códigos de error para ver los valores.errorMessage stringSe devuelve junto con errorCode; una descripción de fallo en inglés. Ramifique según errorCode, no según errorMessage.

Estados previos y notas de llamada

  • Se recomienda sondear cada 2–5 segundos.
  • Tanto running como paused permiten llamar a Enviar instrucción de proceso; enviar una instrucción en el estado paused no reanuda automáticamente el Travel.
  • Este endpoint no devuelve mode, aspectRatio, playUrl, bgmUrl ni sessionId; la configuración de transmisión y la orientación del reproductor se basan en la respuesta de Ingresar a 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.
  • Acting no admite el sendCommand del SDK; no construya controles de dirección o acción basados en los dos arreglos de acciones vacíos.
  • failed es un estado terminal y no se producirá ningún video; muestre el motivo del fallo basándose en errorCode, y no lo muestre como "aún no completado".

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

Cuando el Travel está en running o paused: