Skip to main content

HappyOyster-Directing-Pause Travel APIリファレンス

実行中のDirecting Travelの一時停止をリクエストします。一時停止完了後、resumeまたはrewindを呼び出すことができます。

スコープ

実行中のDirecting Travelの一時停止をリクエストします。一時停止完了後、resumeまたはrewindを呼び出すことができます。呼び出し前に、以下を確認してください：
  • 認証：プライマリ API キーは必須ではありません。プライマリまたは一時 API キーのいずれかで呼び出せます。取得方法については、認証情報の取得 を参照してください。
  • 前提条件：Travelステータスはrunningである必要があります。Query Travel Statusで確認してください。
  • 呼び出し元：サーバーまたはクライアントのいずれからも呼び出すことができます。

HTTP リクエスト

  • Singapore
  • 米国（バージニア）
POST https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-directing/openapi/v1/travels/pause{WorkspaceId} を実際の ワークスペースID に置き換えます。

リクエストパラメーター

  • Travelの一時停止
curl --location 'https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-directing/openapi/v1/travels/pause' \
    -H "Authorization: Bearer $DASHSCOPE_API_KEY" \
    -H 'Content-Type: application/json' \
    -d '{
    "encryptedTravelId": "{encryptedTravelId}",
    "userAgent": "your-client/1.2.0"
}'
Content-Typestring（必須）リクエストのコンテンツタイプ。このパラメータは application/json に設定する必要があります。
Authorization string （必須）API キー認証です。プライマリ API キーは必須ではなく、プライマリまたは一時 API キーのいずれかで呼び出せます。
  • プライマリ API Key：sk- で始まります（例：sk-xxx）。
  • 一時 API キー：st- で始まり、例は st-xxx です。
リクエストボディ
encryptedTravelId string （必須）一時停止するDirecting暗号化済みTravel IDです。Travelへの入室によって返されます。
userAgent string （任意）SDK またはクライアントのバージョン識別子です。空でない文字列であり、HTTP User-Agent よりも優先されます。

レスポンスパラメーター

  • 一時停止成功
{
    "code": 0,
    "message": null,
    "data": {
        "encryptedTravelId": "trvl_a1b2****",
        "status": "paused"
    }
}
code integerリターンコード。0 は成功を意味し、ゼロ以外の値はエラーコードです。
message stringエラーメッセージ。成功時は null です。
data objectレスポンスデータ。失敗時は null です。

プロパティ

encryptedTravelId string暗号化されたTravel ID。status stringターゲットの一時停止ステータス。pausedを返します。

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

  • 現在のTravelステータスはrunningである必要があります。
  • 入室レスポンス内のversionはstoryV2である必要があります。このモデルでの入室時は常にこの値が返されます。
  • サーバー側での一時停止ステータスの確認は非同期プロセスです。直ちにrewindまたはresumeを呼び出す必要がある場合は、ステータスがpausedになるまでTravel Statusのクエリをポーリングしてください。

エラーコード

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

次のステップ

一時停止後、以下の操作が可能です：