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'
encryptedTravelIdrenvoyé 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 |
|
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.
| |
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 :
| |
clientStreamStatusTimeMs long (Facultatif)L'horodatage en millisecondes du changement d'état du client. Utilisé conjointement avec clientStreamStatus. |
Paramètres de réponse |
|
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 :
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 :
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 :
|
É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. characterActionsetenvironmentActionssont des indications d'actions disponibles ; le contrôle réel est toujours envoyé via le SDKsendCommand.- Ce point de terminaison ne retourne pas
mode,playUrl,bgmUrl, nisessionId; la configuration du streaming est basée sur la réponse de Enter Travel. clientStreamStatusest le signal de présence de lecture côté client, etrtcStatusest le statut de streaming côté serveur ; ils ne sont pas interchangeables.- Adventure ne prend pas en charge HTTP
instruct,pause,resume,rewind, ouupdate-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.