Alibaba Cloud Model Studio:HappyOyster-Adventure-Enter Travel API リファレンス

クライアントは ticket を使用して実際の Travel を作成し、RTC 参加設定と Adventure 機能バージョンを取得します。maxExperienceTimeSec は Adventure モデルでのみ有効です。

スコープ

クライアントは ticket を使用して実際の Travel を作成し、RTC 参加設定を取得します。maxExperienceTimeSec は Adventure モデルでのみ有効です。呼び出し前に、以下を確認してください。

• 認証：プライマリ API Key は必須ではありません。ticket が入室検証を完了します。取得方法については、認証情報の取得 を参照してください。
• 前提条件：ticket は Travel 資格情報の取得 から取得したものであり、未期限切れかつ未使用で、World のステータスが ready である必要があります。
• 呼び出し元：クライアントから呼び出します。

HTTP リクエスト

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
}'

{
    "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
    }
}

前提条件となるステータスと呼び出しに関する注意事項

• ticket に対応する World は ready である必要があり、チケットは未期限切れかつ未使用である必要があります。
• 呼び出しが成功すると Travel が作成されます。同じ ticket を再利用すると 401011 が返されます。
• version は wanderV2 として処理する必要があります。他のモデルのインタラクションプロトコルを使用して制御データを送信しないでください。
• maxExperienceTimeSec に達すると、サーバーは体験を終了します。クライアントは、その後届く終端状態を処理する必要があります。
• Adventure の方向、視点、およびアクションの制御は、サーバー側の HTTP Open API ではありません。クライアントは対応するプラットフォーム SDK の sendCommand を使用する必要があり、SDK はこれを RTC DataChannel を介して送信します。
• rtcConfig=null は、現在利用可能なストリーミングチャンネルがないことを意味し、クライアントはそれに基づいて再生を開始できません。

エラーコード

モデルの呼び出しに失敗してエラーが返された場合は、HappyOyster エラーコードを参照して解決してください。

次のステップ

入室成功後：

• Travel ステータスの照会：2〜5 秒ごとにポーリングして、利用可能なアクションプールを読み取ります。
• Travel が running になった後、クライアントは SDK の sendCommand を介して方向、視点、およびアクションの制御を送信します。
• Travel の終了：セッションを終了し、成果物を処理します。