Skip to main content

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

Interroger le cycle de vie de l'Adventure Travel, le statut de streaming côté serveur et le pool d'actions du monde actuel ; vous pouvez également signaler le heartbeat de pull-stream ou de lecture du client en même temps.

Scope

Interroger le cycle de vie de l'Adventure Travel, le statut de streaming côté serveur et le pool d'actions du monde actuel ; 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
  • Chine (Pékin)
  • États-Unis (Virginie)
GET https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-adventure/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-adventure/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 Travel chiffré de l'Adventure. Retourné par Enter Travel.
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 ne signifie pas que l'Adventure Travel prend en charge la 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": null,
        "chapters": null,
        "characterActions": [
            "dash",
            "jump",
            "crouch",
            "attack"
        ],
        "environmentActions": [
            "ride_motorcycle",
            "enter_exit_car"
        ]
    }
}
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 le contrôler en temps réel via le SDK sendCommand
  • failed : le Travel a échoué
  • completed : le Travel est terminé ; les artefacts peuvent être interrogés
Les capacités du produit Adventure n'ont pas d'état paused ; ne construisez pas de machine à états autour de la pause / reprise.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 null | arrayAdventure ne prend pas en charge HTTP instruct, et les actions d'exploration ne sont pas répercutées dans ce champ ; généralement null ou [], et peut être ignoré.chapters arrayLa liste des chapitres ; null lorsqu'aucune donnée de chapitre n'a été générée.characterActions arrayIDs d'action disponibles pour le personnage / sujet actuel ; [] lorsqu'il n'y a aucune recommandation. Généralement, 2 à 4 sont retournés. Actions courantes :
  • dash : faire un dash vers l'avant
  • jump : sauter
  • crouch : s'accroupir / se coucher
  • attack : attaquer
environmentActions arrayIDs d'action d'interaction environnementale disponibles pour la scène actuelle ; [] lorsqu'il n'y a aucune recommandation. Le serveur sélectionne 0 à 3 dans un pool d'actions fixe par scène et peut retourner un tableau vide. Actions courantes :
  • ride_horse : monter à cheval
  • ride_bicycle : faire du vélo
  • ride_motorcycle : conduire une moto
  • enter_exit_car : entrer dans / sortir d'une voiture
  • open_close_door : ouvrir / fermer une porte
  • take_cover : se mettre à couvert
  • car_light : allumer les phares de la voiture ; peut apparaître uniquement lorsque enter_exit_car est également retourné
  • car_horn : klaxonner ; peut apparaître uniquement lorsque enter_exit_car est également retourné

États préalables et notes d'appel

  • Interroger toutes les 2 à 5 secondes.
  • Les capacités du produit Adventure n'ont pas d'état paused ; ne construisez pas de machine à états autour de la pause / reprise.
  • characterActions et environmentActions sont des indications d'actions disponibles ; le contrôle réel est toujours envoyé via le SDK sendCommand.
  • Ce point de terminaison ne retourne pas mode, 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.
  • Adventure ne prend pas en charge HTTP instruct, pause, resume, rewind, ou update-script ; n'intégrez pas les chemins suivants comme capacités HTTP disponibles : /travels/instruct, /travels/pause, /travels/resume, /travels/rewind, /travels/update-script.

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 Travel passe à running :
  • Le client envoie les commandes de direction, de point de vue et d'action via le SDK sendCommand (vous pouvez d'abord consulter le pool d'actions retourné par ce point de terminaison).
  • Terminer le Travel : terminer la session et traiter les artefacts.