Le client utilise le ticket pour créer un voyage réel et obtenir la configuration de connexion RTC ainsi que la version de capacité de mise en scène. creationModel détermine les interfaces de contrôle que le voyage peut appeler.
Scope
Le client utilise le ticket pour créer un voyage réel et obtenir la configuration de connexion RTC. Avant d'effectuer l'appel, confirmer les points suivants :
- Authentification : La clé API Key principale n'est pas requise ; le
ticketcomplète la validation d'entrée en salle. Pour savoir comment l'obtenir, voir Obtenir les identifiants d'authentification. - Prérequis : Le
ticketest obtenu via Obtenir l'identifiant de Travel, n'est ni expiré ni utilisé, et l'état de son World estready. - Appelant : Appelé par votre client.
Requête HTTP
- Singapore
- États-Unis (Virginie)
POST https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-directing/openapi/v1/travels/enter-travelRemplacez {WorkspaceId} par votre véritable ID d'espace de travail.Paramètres de la requête |
|
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.
| |
Corps de la requête | |
ticket string (Obligatoire)Un identifiant à usage unique, non expiré et non utilisé, obtenu via Obtenir l'identifiant de Travel. Réutiliser le même ticket retourne 401011.L'entrée en voyage de mise en scène ne consomme pas maxExperienceTimeSec ; ne pas le transmettre. Ce champ ne prend effet que pour l'Aventure ; si un niveau invalide est transmis, 400000 est retourné avant le routage du modèle. La réponse réussie reste null. |
Paramètres de réponse | Entered successfully |
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 stringLe nouvel ID de voyage chiffré créé. Utilisé pour les requêtes ultérieures de Interroger le statut du voyage, rembobinage, pause, reprise, fin et artefacts.encryptedWorldId stringL'ID de World chiffré auquel correspond ce Travel.mode integerToujours 2 pour la mise en scène.creationModel stringsimple ou scriptlist ; détermine les interfaces de contrôle que le voyage peut appeler :
nullPas encore disponible ; fixé à null.firstFrame stringURL de la première image du World.rtcConfig objectConfiguration de connexion RTC ; null lorsqu'il n'y a pas de canal de streaming disponible, auquel cas le client ne peut pas démarrer la lecture sur cette base.
stringLa version d'entrée en salle de mise en scène, fixée à storyV2.aspectRatio nullFixé à null pour le modèle de mise en scène.noStreamAutoEndTimeoutSec integerDélai d'attente de fin automatique sans flux en secondes, par défaut 30 ; la réponse réelle prévaut. Si rtcStatus n'entre pas dans l'état de streaming dans ce délai après l'entrée en salle, appelez Terminer le Travel avec failCode=TRAVEL_NO_STREAM_AUTO_END.maxExperienceTimeSec nullFixé à null pour le modèle de mise en scène. |
États préalables et notes d'appel
- Le World correspondant au
ticketdoit êtreready, et le ticket ne doit être ni expiré ni utilisé. - Ne pas transmettre
maxExperienceTimeSec. La mise en scène ne limite pas le temps d'expérience via ce champ. - Un appel réussi crée le Travel ; réutiliser le même
ticketretourne401011. - Lorsque
creationModel=scriptlist, ne pas appelerinstruct; utiliser plutôt Mise à jour complète du script. rtcConfig=nullsignifie qu'il n'y a actuellement aucun canal de streaming disponible, et le client ne peut pas démarrer la lecture sur cette base.
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
Après être entré dans la salle avec succès :
- Interroger le statut du voyage : interroger toutes les 2–5 secondes, et appeler les interfaces de contrôle disponibles selon
creationModel. - Mode standard : Envoyer une instruction de processus.
- Mode script : Mise à jour complète du script.
- Commun : Pause / Reprise / Rembobinage / Fin.