Référence de l'API HappyOyster-Directing-End Travel - Alibaba Cloud Model Studio

Terminer un voyage de mise en scène. Après une fin normale, le statut passe à completed et le traitement des artefacts commence ; lors d'une fin par expiration du délai sans flux, il passe à failed et aucun artefact de relecture n'est généré.

Scope

Terminer un voyage de mise en scène. Après une fin normale, le statut passe à completed et le traitement des artefacts commence ; lors d'une fin par expiration du délai sans flux, il passe à failed et aucun artefact de relecture n'est généré. Avant d'effectuer l'appel, confirmer les points suivants :

Authentification : La clé API principale n'est pas requise ; la clé principale ou une clé API temporaire peut l'appeler. Pour savoir comment les obtenir, voir Obtenir les identifiants d'authentification.
Prérequis : Le Travel ne doit pas encore avoir atteint un état terminal et doit se trouver dans un état que le serveur peut terminer. Confirmez via Interroger l'état du Travel.
Appelant : Votre serveur ou votre client peut l'appeler.

Requête HTTP

Singapore

POST https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-directing/openapi/v1/travels/end

Remplacez {WorkspaceId} par votre véritable ID d'espace de travail.

États-Unis (Virginie)

POST https://{WorkspaceId}.us-east-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-directing/openapi/v1/travels/end

Remplacez {WorkspaceId} par votre véritable ID d'espace de travail.

Paramètres de la requête

Fin normale

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"
}'

Fin par délai d'attente sans flux

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}",
    "failCode": "TRAVEL_NO_STREAM_AUTO_END",
    "userAgent": "your-client/1.2.0"
}'

Content-Typestring(Requis)

Type de contenu de la requête. Ce paramètre doit être défini sur application/json.

Authorization string (Requis)

Authentification par clé API. La clé API principale n'est pas requise ; la clé principale ou une clé API temporaire peut l'appeler.

Clé API principale : commence par sk-, par ex. sk-xxx.
Clé API temporaire : commence par st-, par exemple st-xxx.

Corps de la requête

encryptedTravelId string (Obligatoire)

L'ID de voyage chiffré de mise en scène à terminer. Retourné par Entrer dans le voyage.

failCode string (Facultatif)

La raison de fin d'échec. Si omis, cela est traité comme une fin normale. Actuellement pris en charge uniquement :

TRAVEL_NO_STREAM_AUTO_END : pour le scénario où aucun flux n'est reçu après l'entrée dans la salle pendant plus de noStreamAutoEndTimeoutSec ; ce type de fin ne génère pas d'artefacts de rediffusion

Le fait de transmettre une valeur non prise en charge renvoie 400000.

userAgent string (Facultatif)

Identifiant de version du SDK ou du client. Une chaîne non vide ; prévaut sur le User-Agent HTTP.

Paramètres de réponse

Fin normale

{
    "code": 0,
    "message": null,
    "data": {
        "encryptedTravelId": "trvl_a1b2****",
        "status": "completed",
        "endedAt": "2026-06-04T00:03:00Z",
        "durationSec": 180
    }
}

Fin par délai d'attente sans flux

{
    "code": 0,
    "message": null,
    "data": {
        "encryptedTravelId": "trvl_a1b2****",
        "status": "failed",
        "errorCode": "TRAVEL_NO_STREAM_AUTO_END",
        "errorMessage": "Something went wrong.",
        "endedAt": "2026-06-04T00:03:00Z",
        "durationSec": null
    }
}

code integer

Code de retour. 0 indique un succès ; une valeur non nulle correspond à un code d'erreur.

message string

Message d'erreur. null en cas de succès.

data object

Données de réponse. null en cas d'échec.

Propriétés

encryptedTravelId string

L'ID de Voyage chiffré qui a été terminé.

status string

Statut de fin : completed (fin normale) / failed (fin d'échec lorsqu'un failCode pris en charge est fourni).

errorCode string

Code de raison de l'échec ; null lors d'une fin normale.

errorMessage string

Description de l'échec ; null lors d'une fin normale.

endedAt string

Heure de fin, au format ISO 8601.

durationSec integer

Durée effective de la vidéo en secondes ; null lors d'une fin d'échec sans flux ou lorsque la durée ne peut pas encore être analysée.

États préalables et notes d'appel

Le client doit interroger Interroger le statut du voyage après être entré dans la salle. Si rtcStatus n'est pas passé à l'état de streaming dans le délai noStreamAutoEndTimeoutSec, le terminer avec TRAVEL_NO_STREAM_AUTO_END.
Après le passage de TRAVEL_NO_STREAM_AUTO_END, le voyage passe à failed et aucun artefact de relecture ne peut être interrogé.
Lors d'une fin normale, durationSec utilise prioritairement la durée du fichier vidéo final ; lorsque la vidéo finale n'est pas encore disponible, il utilise le durationMs du dernier résultat de génération actuellement disponible. Si aucun des deux n'est disponible, la valeur est null.
Une fois qu'une fin normale atteint completed, la composition des artefacts peut encore être en cours ; décider de poursuivre ou non l'interrogation en fonction du statut retourné par Interroger les artefacts du voyage.

Codes d'erreur

Si l'appel du modèle échoue et renvoie une erreur, consultez Codes d'erreur HappyOyster pour la résoudre.

Étapes suivantes

Une fois que le Voyage est passé à l'état completed :

Interroger les artefacts du Travel : interroger régulièrement pour obtenir les variantes originales enregistrées et composées.
Interroger la liste des Travels : consulter les Travels historiques.