Skip to main content

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

Le client utilise le ticket pour créer un Travel réel et obtenir la configuration de connexion RTC ainsi que la version de la capacité Adventure. maxExperienceTimeSec prend effet uniquement dans le modèle Adventure.

Scope

Le client utilise le ticket pour créer un Travel réel et obtenir la configuration de connexion RTC. maxExperienceTimeSec prend effet uniquement dans le modèle Adventure. Avant d'appeler, confirmez les points suivants :
  • Authentification : La clé API Key principale n'est pas requise ; le ticket complète la validation d'entrée en salle. Pour savoir comment l'obtenir, voir Obtenir les identifiants d'authentification.
  • Prérequis : Le ticket est obtenu via Obtenir l'identifiant de Travel, n'est ni expiré ni utilisé, et l'état de son World est ready.
  • Appelant : Appelé par votre client.

Requête HTTP

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

Paramètres de la requête

  • Entrer dans le travel (client)
curl --location 'https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-adventure/openapi/v1/travels/enter-travel' \
    -H "Authorization: Bearer $DASHSCOPE_API_KEY" \
    -H 'Content-Type: application/json' \
    -d '{
    "ticket": "{ticket}",
    "maxExperienceTimeSec": 90
}'
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
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.
maxExperienceTimeSec integer (Facultatif)Durée maximale de l'expérience, en secondes, doit être un entier JSON. La valeur par défaut est 60. Valeurs autorisées :
  • 60
  • 90
  • 120
Les chaînes et autres valeurs numériques ne sont pas acceptées (par exemple, "60" n'est pas valide) ; un niveau invalide retourne 400000. Le serveur termine automatiquement le Travel une fois cette durée atteinte.

Paramètres de réponse

  • Entrée réussie
{
    "code": 0,
    "message": null,
    "data": {
        "encryptedTravelId": "trvl_a1b2****",
        "encryptedWorldId": "enc_a1b2****",
        "mode": 1,
        "creationModel": "simple",
        "playUrl": null,
        "firstFrame": "https://cdn.happyoyster.com/frames/world_xyz789.jpg",
        "rtcConfig": {
            "channelId": "stream_abc123",
            "appId": "18bca2e3218c46aebf8ff3a32fb12311",
            "token": "007eJxTYOh...",
            "userId": "user_1"
        },
        "version": "wanderV2",
        "aspectRatio": null,
        "noStreamAutoEndTimeoutSec": 30,
        "maxExperienceTimeSec": 90
    }
}
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 stringL'ID chiffré du Travel nouvellement créé. Utilisé pour les interrogations ultérieures de Statut du Travel, de fin et d'artefacts.encryptedWorldId stringL'ID de World chiffré auquel correspond ce Travel.mode integerToujours 1 pour Adventure.creationModel stringToujours simple pour Adventure.playUrl 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.
  • channelId : ID de canal RTC
  • appId : ID d'application RTC attribué par la plateforme
  • token : Jeton de connexion RTC
  • userId : ID utilisateur de connexion RTC, fixé à user_1
version stringLa version d'entrée en salle Adventure, fixée à wanderV2. Les données de contrôle doivent être envoyées via le SDK sendCommand conformément à cette version.aspectRatio nullFixé à null pour Adventure ; le rapport d'aspect du lecteur n'est pas lu depuis ce champ et suit le rapport de la première image.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 integerLa durée d'expérience effectivement adoptée par le serveur ; elle peut uniquement être 60 / 90 / 120. Le serveur termine automatiquement le Travel une fois cette durée atteinte.

États préalables et notes d'appel

  • Le World correspondant au ticket doit être ready, et le ticket ne doit être ni expiré ni utilisé.
  • Un appel réussi crée le Travel ; réutiliser le même ticket retourne 401011.
  • version doit être traité comme wanderV2 ; n'envoyez pas de données de contrôle en utilisant le protocole d'interaction d'un autre modèle.
  • Le serveur termine l'expérience une fois maxExperienceTimeSec atteint ; le client doit gérer l'état terminal qui arrive ensuite.
  • Les contrôles de direction, de point de vue et d'action d'Adventure ne sont pas des Open API HTTP côté serveur ; le client doit utiliser le sendCommand du SDK de la plateforme correspondante, que le SDK envoie via le DataChannel RTC.
  • rtcConfig=null signifie 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 Travel : interroger toutes les 2–5 secondes pour lire le pool d'actions disponibles.
  • Une fois que le Travel devient running, le client envoie les contrôles de direction, de point de vue et d'action via le SDK sendCommand.
  • Terminer le Travel : terminer la session et traiter les artefacts.