【モバイル Synthetic テスト】利用規約ステータス¶
GET /api/v1/dialing_task/mobile/terms
概要¶
モバイル Synthetic テストの利用規約に対するワークスペースの確認状態を照会します。
呼び出し前の準備と使用手順¶
OpenAPI の ID では照会が可能です。accepted は有効なサーバー側確認レコードを示すものであり、プラットフォームのスイッチ状態ではありません。canAccept は API Key に対して常に false です。有効なレコードがない場合は accepted=false/acceptance=null となります。旧共通設定や重複・破損したレコードは同意とは見なしません。
本リクエストは規約に同意せず、タスクも作成せず、モバイルプラットフォームの初期化も行いません。また、モバイル Synthetic テストのスイッチがオフの場合でも直接禁止されることはありません。製品にログインしたうえで、ワークスペースの Owner/管理者が規約を読み確認してから、accepted=true を照会する必要があります。Key に管理者ロールを付与したことを、ログインユーザーの確認行為と見なすことはできません。
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証情報。 例: <DF-API-KEY>取得・入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。 |
パラメータ補足説明¶
ワークスペースは認証コンテキストから取得します。accepted/canAccept/acceptance のみを返します。未確認の場合 acceptance=null、確認レコードには acceptedBy とサーバー側の Unix 秒 acceptedAt のみが含まれます。API Key は自身のワークスペースのみを照会でき、確認はできません。規約のアドレス、言語、製品バージョンの設定はありません。
リクエスト例¶
curl --get 'https://openapi.guance.com/api/v1/dialing_task/mobile/terms' \
-H 'DF-API-KEY: <DF-API-KEY>'
レスポンス¶
HTTP200 JSON。本 route は declaration を明示的にスキップするため、content に該当フィールドはありません。
| フィールド | 型 | 説明 |
|---|---|---|
| content.accepted | boolean | 現在のワークスペースに、サーバー側で検証済みの有効な確認が存在するか。 |
| content.canAccept | boolean | 現在の ID が確認できるか。OpenAPI の ID は固定で false となり、API Key のロールによってログインメンバーの ID を偽装することはできません。 |
| content.acceptance | object または null | 確認レコード。未確認・重複・破損した履歴レコードの場合は null。 |
| content.acceptance.acceptedBy | string | 実際に確認したログインメンバーの acnt_ UUID であり、本 API Key ではありません。 |
| content.acceptance.acceptedAt | integer | サーバー側の確認 Unix 秒。 |
{
"code": 200,
"content": {
"accepted": false,
"canAccept": false,
"acceptance": null
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
エラーレスポンス¶
認証、レート制限、および共通リクエストのエラーについては共通エラー定義を参照してください。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたはレスポンスの説明 | 対処方法 |
|---|---|---|---|---|
| 403 | ft.Forbidden | 現在の呼び出し ID が規約の照会を許可されていない(OpenAPI の正常な ID は満たします) | 操作権限がありません | 対象ワークスペースの有効な OpenAPI Key を使用し、他の共有された認証情報や非メンバーの認証情報を使用しないでください。 |
| 401 | ft.WKSPNotExistOrReleased | 現在のワークスペースが存在しない/解放済み | ワークスペースが存在しません/または解放済みです | 有効なワークスペースを確認してください。 |
| 500 | ft.InternalServerError | ストレージの読み取り、過去の設定、またはローカル静的マッピングのフォーマット異常 | 内部エラー | 具体的なタスク/テンプレートまたはフィルターまで絞り込み、継続的に失敗する場合は traceId を保持して読み取り段階を確認してください。 |