Skip to main content

Référence de l'API HappyOyster-Directing-Query Travel Status

Interroger le cycle de vie du Voyage Directing, le statut du streaming côté serveur, les instructions textuelles exécutées et les informations sur les chapitres ; vous pouvez également signaler le heartbeat de pull-stream ou de lecture du client en même temps.

Scope

Interroger le cycle de vie du Voyage Directing, le statut du streaming côté serveur, les instructions textuelles exécutées et les informations sur les chapitres ; vous pouvez également signaler le heartbeat de pull-stream ou de lecture du client en même temps. Avant d'appeler, confirmez 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 : Interrogez avec l'encryptedTravelId renvoyé par Enter Travel.
  • Appelant : Votre serveur ou votre client peut l'appeler. Il est recommandé d'effectuer une interrogation toutes les 2 à 5 secondes.

Requête HTTP

  • Singapore
  • États-Unis (Virginie)
GET https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-directing/openapi/v1/travels/statusRemplacez {WorkspaceId} par votre véritable ID d'espace de travail.

Paramètres de la requête

  • Interroger le statut du Travel
curl --location 'https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-directing/openapi/v1/travels/status?encryptedTravelId={encryptedTravelId}&clientStreamStatus=PLAYING&clientStreamStatusTimeMs=1788940800000' \
    -H "Authorization: Bearer $DASHSCOPE_API_KEY"
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.
Paramètres de requête
encryptedTravelId string (Obligatoire)L'ID de Voyage chiffré Directing. Retourné par Entrer dans le voyage.
clientStreamStatus string (Facultatif)Le statut de pull-stream RTC ou de lecture du client, insensible à la casse. Les valeurs non reconnues sont ignorées. Valeurs autorisées :
  • DISCONNECTED : non connecté ou a quitté le canal
  • CONNECTING : connexion au canal RTC
  • CONNECTED : connecté, mais la lecture n'a pas commencé ou la première image n'est pas arrivée
  • PLAYING : le flux distant a été reçu et est en cours de rendu
  • BUFFERING : mise en mémoire tampon
  • PAUSED : le client a mis la lecture en pause ; cela n'équivaut pas à pause côté serveur
  • RECONNECTING : reconnexion
clientStreamStatusTimeMs long (Facultatif)L'horodatage en millisecondes du changement d'état du client. Utilisé conjointement avec clientStreamStatus.

Paramètres de réponse

  • Travel en cours
{
    "code": 0,
    "message": null,
    "data": {
        "encryptedTravelId": "trvl_a1b2****",
        "status": "running",
        "rtcStatus": "PUSHING",
        "updateTime": "2026-06-04T00:02:00Z",
        "userInstructions": [
            {
                "instruction": "A giant robotic dinosaur suddenly appears",
                "relativeStartTimeMs": 12000,
                "relativeEndTimeMs": 16000,
                "startTime": 12.0,
                "endTime": 16.0,
                "status": "executed"
            }
        ],
        "chapters": [
            {
                "chapterId": 1,
                "title": "Chapter 1",
                "brief": "The detective enters the cyberpunk city",
                "actRange": [0, 10],
                "startTime": 4,
                "endTime": 20,
                "chapterImage": "https://cdn.happyoyster.com/chapters/ch1.jpg"
            }
        ],
        "characterActions": [],
        "environmentActions": []
    }
}
code integerCode de retour. 0 indique un succès ; une valeur non nulle correspond à un code d'erreur.
message stringMessage d'erreur. null en cas de succès.
data objectDonnées de réponse. null en cas d'échec.

Propriétés

encryptedTravelId stringIdentifiant de voyage chiffré.status stringStatut du cycle de vie du Travel :
  • init : initialisation des ressources de session
  • pending : en file d'attente ou en attente de ressources de service
  • running : en cours d'exécution ; vous pouvez appeler les points de terminaison de contrôle pris en charge selon le sous-mode de création
  • paused : pause côté serveur terminée ; peut être repris ou rembobiné
  • failed : le Travel a échoué
  • completed : le Travel est terminé ; les artefacts peuvent être interrogés
rtcStatus stringStatut de streaming RTC côté serveur ; différent du clientStreamStatus signalé par le client.updateTime stringHeure de dernière mise à jour, au format ISO 8601.userInstructions arrayLa liste des instructions textuelles ; null lorsqu'il n'y a aucune donnée. Chaque élément contient instruction, relativeStartTimeMs / relativeEndTimeMs (millisecondes relatives), startTime / endTime (secondes de la chronologie) et status.chapters arrayLa liste des chapitres ; null lorsque la détection des chapitres n'a pas encore été déclenchée. Chaque élément contient chapterId, title, brief, actRange, startTime, endTime et chapterImage.characterActions arrayFixé à un tableau vide pour le modèle Directing.environmentActions arrayFixé à un tableau vide pour le modèle Directing.

États préalables et notes d'appel

  • Interroger toutes les 2 à 5 secondes.
  • Dans l'état running, vous pouvez appeler les points de terminaison de contrôle pris en charge selon creationModel : le mode standard prend en charge instruct, pause, resume, rewind et end ; le mode script prend en charge update-script, pause, resume, rewind et end.
  • Ce point de terminaison ne retourne pas mode, aspectRatio, playUrl, bgmUrl, ni sessionId ; la configuration du streaming est basée sur la réponse de Enter Travel.
  • clientStreamStatus est le signal de présence de lecture côté client, et rtcStatus est le statut de streaming côté serveur ; ils ne sont pas interchangeables.

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

Lorsque le Travel est running ou paused :