Skip to main content

Referencia de la API de HappyOyster-Directing-End Travel

Finaliza un Viaje de Dirección. Después de una finalización normal, el estado cambia a completed y entra en el procesamiento de artefactos; en una finalización por tiempo de espera sin flujo, cambia a failed y no se generan artefactos de repetición.

Ámbito

Finaliza un Viaje de Dirección. Después de una finalización normal, el estado cambia a completed y entra en el procesamiento de artefactos; en una finalización por tiempo de espera sin flujo, cambia a failed y no se generan artefactos de repetición. 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: El viaje no debe haber entrado todavía en un estado terminal y debe estar en un estado que el servidor pueda finalizar. Confírmelo mediante Consultar estado del viaje.
  • Solicitante: Puede invocarla su servidor o su cliente.

Solicitud HTTP

  • Singapore
  • EE. UU. (Virginia)
POST https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-directing/openapi/v1/travels/endReemplace {WorkspaceId} con su ID de espacio de trabajo real.

Parámetros de solicitud

  • Finalización normal
  • Finalización por tiempo de espera sin flujo
curl --location 'https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-directing/openapi/v1/travels/end' \
    -H "Authorization: Bearer $DASHSCOPE_API_KEY" \
    -H 'Content-Type: application/json' \
    -d '{
    "encryptedTravelId": "{encryptedTravelId}",
    "userAgent": "your-client/1.2.0"
}'
Content-Typestring(Requerido)Tipo de contenido de la solicitud. Este parámetro debe establecerse en application/json.
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.
Cuerpo de la solicitud
encryptedTravelId string (Obligatorio)El ID de Viaje cifrado de Dirección que se va a finalizar. Devuelto por Entrar al viaje.
failCode string (Opcional)La razón de finalización por fallo. Cuando se omite, se trata como una finalización normal. Actualmente solo se admite:
  • TRAVEL_NO_STREAM_AUTO_END: para el escenario en el que no se recibe ningún flujo después de entrar en la sala durante más de noStreamAutoEndTimeoutSec; este tipo de finalización no genera artefactos de reproducción
Pasar un valor no compatible devuelve 400000.
userAgent string (Opcional)Identificador de versión del SDK o del cliente. Una cadena no vacía; tiene prioridad sobre el User-Agent HTTP.

Parámetros de respuesta

  • Finalización normal
  • Finalización por tiempo de espera sin flujo
{
    "code": 0,
    "message": null,
    "data": {
        "encryptedTravelId": "trvl_a1b2****",
        "status": "completed",
        "endedAt": "2026-06-04T00:03:00Z",
        "durationSec": 180
    }
}
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 stringEl ID de viaje cifrado que se finalizó.status stringEstado de finalización: completed (finalización normal) / failed (finalización por fallo cuando se proporciona un failCode admitido).errorCode stringCódigo de motivo de fallo; null en una finalización normal.errorMessage stringDescripción del fallo; null en una finalización normal.endedAt stringHora de finalización, en formato ISO 8601.durationSec integerDuración efectiva del video en segundos; null en una finalización por fallo sin flujo o cuando la duración aún no se puede analizar.

Estados previos y notas de llamada

  • El cliente debe sondear Consultar estado del viaje después de entrar a la sala. Si rtcStatus no ha entrado en el estado de transmisión dentro de noStreamAutoEndTimeoutSec, finalícelo con TRAVEL_NO_STREAM_AUTO_END.
  • Después de pasar TRAVEL_NO_STREAM_AUTO_END, el Viaje pasa a ser failed y no se pueden consultar artefactos de repetición.
  • En una finalización normal, durationSec utiliza preferentemente la duración final del archivo de video; cuando el video final aún no está disponible, utiliza el durationMs del último resultado de generación disponible actualmente. Cuando ninguno está disponible, es null.
  • Después de que una finalización normal alcanza completed, la composición de artefactos puede seguir en curso; decida si continuar sondeando basándose en el estado devuelto por Consultar artefactos del viaje.

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 viaje entre en completed: