Référence de l'API HappyOyster-Acting-Enter Travel - Alibaba Cloud Model Studio

Le client utilise le ticket pour créer un Travel réel et obtenir la configuration de connexion RTC, la version de capacité Acting et le rapport d'aspect du lecteur. Un appel réussi crée le Travel.

Scope

Le client utilise le ticket pour créer un Travel réel et obtenir la configuration de connexion RTC, la version de capacité Acting et le rapport d'aspect du lecteur. 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

POST https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-acting/openapi/v1/travels/enter-travel

Remplacez {WorkspaceId} par votre véritable ID d'espace de travail.

États-Unis (Virginie)

POST https://{WorkspaceId}.us-east-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-acting/openapi/v1/travels/enter-travel

Remplacez {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-acting/openapi/v1/travels/enter-travel' \ -H "Authorization: Bearer $DASHSCOPE_API_KEY" \ -H 'Content-Type: application/json' \ -d '{ "ticket": "{ticket}" }'`
Content-Type`string`(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`.

RemarqueActing ne consomme pas maxExperienceTimeSec ; ne le transmettez pas. Si un niveau invalide est tout de même transmis, 400000 est retourné avant le routage du modèle.

Paramètres de réponse

Entrée réussie

{
    "code": 0,
    "message": null,
    "data": {
        "encryptedTravelId": "trvl_a1b2****",
        "encryptedWorldId": "enc_a1b2****",
        "mode": 3,
        "creationModel": "simple",
        "playUrl": null,
        "firstFrame": "https://cdn.happyoyster.com/frames/acting_world_xyz789.jpg",
        "rtcConfig": {
            "channelId": "stream_abc123",
            "appId": "18bca2e3218c46aebf8ff3a32fb12311",
            "token": "007eJxTYOh...",
            "userId": "user_1"
        },
        "version": "actingV2",
        "aspectRatio": "9:16",
        "noStreamAutoEndTimeoutSec": 30,
        "maxExperienceTimeSec": null
    }
}

code integer

Code de retour. 0 indique un succès ; une valeur non nulle correspond à un code d'erreur.

message string

Message d'erreur. null en cas de succès.

data object

Données de réponse. null en cas d'échec.

Propriétés

encryptedTravelId string

L'ID de Travel chiffré nouvellement créé. Utilisé pour les requêtes ultérieures d'Interrogation de l'état du Travel, de pause, de reprise, de fin et d'artefacts.

encryptedWorldId string

L'ID de World chiffré auquel correspond ce Travel.

mode integer

Toujours 3 pour Acting.

creationModel string

Toujours simple pour Acting.

playUrl null

Pas encore disponible ; fixé à null.

firstFrame string

URL de la première image du World.

rtcConfig object

Configuration 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 string

La version d'entrée en salle Acting, fixée à actingV2. Les interfaces de contrôle doivent être appelées conformément à cette version.

aspectRatio string

Rapport d'aspect. Le client doit définir l'orientation du lecteur en conséquence avant de récupérer le flux :

9:16 (portrait)
16:9 (paysage)

noStreamAutoEndTimeoutSec integer

Dé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 null

Acting n'utilise pas la durée maximale d'expérience ; fixé à null.

É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.
Lorsque la fonctionnalité ou la spécification Acting n'est pas activée, 403007 est retourné et aucun Travel n'est créé.
version doit être traité comme actingV2 ; n'appelez pas les interfaces de contrôle selon une autre version de capacité.
Le client doit lire aspectRatio avant d'établir la récupération du flux ou le conteneur de rendu : utiliser un conteneur portrait pour 9:16 et un conteneur paysage pour 16:9.
Ne transmettez pas maxExperienceTimeSec. Acting ne se termine pas automatiquement selon ce champ, et le client ne doit pas l'utiliser pour implémenter un compte à rebours.
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 l'état du Travel : interroger toutes les 2–5 secondes ; vous pouvez envoyer des instructions lorsque le Travel est running ou paused.
Envoyer une instruction de processus : piloter la performance de jeu de rôle ultérieure.
Mettre en pause le Travel / Reprendre le Travel : contrôler le rythme d'exécution selon les besoins.
Terminer le Travel : à la fin, il passe à completed et le traitement des artefacts commence.