クライアントはticketを使用して実際のTravelを作成し、RTC参加設定とDirecting機能バージョンを取得します。creationModelはTravelが呼び出せる制御インターフェースを決定します。
スコープ
クライアントはticketを使用して実際のTravelを作成し、RTC参加設定を取得します。呼び出し前に、以下を確認してください：
- 認証：プライマリ API Key は必須ではありません。
ticketが入室検証を完了します。取得方法については、認証情報の取得 を参照してください。 - 前提条件：
ticketは Travel 資格情報の取得 から取得したものであり、未期限切れかつ未使用で、World のステータスがreadyである必要があります。 - 呼び出し元：クライアントから呼び出します。
HTTP リクエスト
- Singapore
- 米国（バージニア）
POST https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-directing/openapi/v1/travels/enter-travel{WorkspaceId} を実際の ワークスペースID に置き換えます。リクエストパラメーター |
|
Content-Typestring（必須）リクエストのコンテンツタイプ。このパラメータは application/json に設定する必要があります。 | |
Authorization string （必須）API キー認証です。プライマリ API キーは必須ではなく、プライマリまたは一時 API キーのいずれかで呼び出せます。
| |
リクエストボディ | |
ticket string （必須）Travel 資格情報の取得 から取得した、未期限切れかつ未使用の単発資格情報です。同じ ticket を再利用すると 401011 が返されます。Directingの入室Travelは maxExperienceTimeSecを消費しないため、これを渡さないでください。このフィールドはAdventureでのみ有効です。無効なティアが渡された場合、モデルルーティングの前に400000が返されます。成功時のレスポンスは引き続きnullです。 |
レスポンスパラメーター | Entered successfully |
code integerリターンコード。0 は成功を意味し、ゼロ以外の値はエラーコードです。 | |
message stringエラーメッセージ。成功時は null です。 | |
data objectレスポンスデータ。失敗時は null です。
プロパティ encryptedTravelId string新しく作成された暗号化済みTravel IDです。後続のTravel Statusのクエリ、巻き戻し、一時停止、再開、終了、およびアーティファクトのクエリに使用されます。encryptedWorldId stringこの Travel に対応する暗号化 World ID です。mode integerDirectingの場合は常に2です。creationModel stringsimpleまたはscriptlist。Travelが呼び出せる制御インターフェースを決定します：
nullまだ利用できません。null に固定されています。firstFrame stringWorld の初回フレーム URL です。rtcConfig objectRTC 参加設定です。利用可能なストリーミングチャンネルがない場合は null となり、その場合クライアントはそれに基づいて再生を開始できません。
stringDirectingの入室バージョンであり、storyV2に固定されています。aspectRatio nullDirectingモデルではnullに固定されています。noStreamAutoEndTimeoutSec integerストリームなし自動終了タイムアウト（秒単位）、デフォルトは 30 です。実際のレスポンスが優先されます。入室後この時間内に rtcStatus がストリーミング状態にならない場合、failCode=TRAVEL_NO_STREAM_AUTO_END を指定して End Travel を呼び出してください。maxExperienceTimeSec nullDirectingモデルではnullに固定されています。 |
前提条件となるステータスと呼び出しに関する注意事項
ticketに対応する World はreadyである必要があり、チケットは未期限切れかつ未使用である必要があります。maxExperienceTimeSecを渡さないでください。Directingはこのフィールドによって体験時間を制限しません。- 呼び出しが成功すると Travel が作成されます。同じ
ticketを再利用すると401011が返されます。 creationModel=scriptlistの場合、instructを呼び出さず、代わりにフルスクリプト更新を使用してください。rtcConfig=nullは、現在利用可能なストリーミングチャンネルがないことを意味し、クライアントはそれに基づいて再生を開始できません。