転送
転送ルールと転送アドレスを管理します。 例では A2A コードモードを使用します。MCP はexecute ツールを通じて同じコードモードを公開します。
関数
forwarding.activate
forwarding.activate.
| プロパティ | 値 | プロパティ | 値 |
|---|---|---|---|
| 必要な権限 | forwarding.manage | 認証必須 | はい |
| 実行モード | sync | 機能権限 | forwarding.manage |
| リソースタイプ | account | リソース ID フィールド | account_id |
| 公開 API ルート | PATCH /v1/public/accounts/{account_id}/forwarding/{forwarding_id}/active |
引数
引数
| 名前 | 型 | 必須 |
|---|---|---|
account_id | str | はい |
forwarding_id | str | はい |
active | bool | はい |
戻り値
戻り値
| フィールド | 型 | 必須 |
|---|---|---|
active | bool | はい |
created_at | str | はい |
id | str | はい |
scope_id | str | はい |
scope_type | "account" | "workspace" | "domain" | はい |
target_email | str | はい |
updated_at | str | はい |
verification_required | bool | はい |
verification_state | "internal" | "pending" | "verified" | "expired" | はい |
verification_expires_at | str | null | いいえ |
verification_sent_at | str | null | いいえ |
verification_verified_at | str | null | いいえ |
A2A の例
A2A の例
リクエスト:レスポンス:
MCP の例
MCP の例
リクエスト:レスポンス:
forwarding.add
forwarding.add.
| プロパティ | 値 | プロパティ | 値 |
|---|---|---|---|
| 必要な権限 | forwarding.manage | 認証必須 | はい |
| 実行モード | sync | 機能権限 | forwarding.manage |
| リソースタイプ | account | リソース ID フィールド | account_id |
| 公開 API ルート | POST /v1/public/accounts/{account_id}/forwarding |
引数
引数
| 名前 | 型 | 必須 |
|---|---|---|
account_id | str | はい |
target_email | str | はい |
domain | str | null | いいえ |
workspace_id | str | null | いいえ |
戻り値
戻り値
| フィールド | 型 | 必須 |
|---|---|---|
active | bool | はい |
created_at | str | はい |
id | str | はい |
scope_id | str | はい |
scope_type | "account" | "workspace" | "domain" | はい |
target_email | str | はい |
updated_at | str | はい |
verification_required | bool | はい |
verification_state | "internal" | "pending" | "verified" | "expired" | はい |
verification_expires_at | str | null | いいえ |
verification_sent_at | str | null | いいえ |
verification_verified_at | str | null | いいえ |
A2A の例
A2A の例
リクエスト:レスポンス:
MCP の例
MCP の例
リクエスト:レスポンス:
forwarding.delete
forwarding.delete.
| プロパティ | 値 | プロパティ | 値 |
|---|---|---|---|
| 必要な権限 | forwarding.manage | 認証必須 | はい |
| 実行モード | sync | 機能権限 | forwarding.manage |
| リソースタイプ | account | リソース ID フィールド | account_id |
| 公開 API ルート | DELETE /v1/public/accounts/{account_id}/forwarding/{forwarding_id} |
引数
引数
| 名前 | 型 | 必須 |
|---|---|---|
account_id | str | はい |
forwarding_id | str | はい |
戻り値
戻り値
| フィールド | 型 | 必須 |
|---|---|---|
result | {} | はい |
A2A の例
A2A の例
リクエスト:レスポンス:
MCP の例
MCP の例
リクエスト:レスポンス:
forwarding.list
forwarding.list.
| プロパティ | 値 | プロパティ | 値 |
|---|---|---|---|
| 必要な権限 | forwarding.view | 認証必須 | はい |
| 実行モード | sync | 機能権限 | forwarding.view |
| リソースタイプ | account | リソース ID フィールド | account_id |
| 公開 API ルート | GET /v1/public/accounts/{account_id}/forwarding |
引数
引数
| 名前 | 型 | 必須 |
|---|---|---|
account_id | str | はい |
page | int | いいえ |
page_size | int | いいえ |
戻り値
戻り値
| フィールド | 型 | 必須 |
|---|---|---|
items | [{"active": bool, "created_at": str, "id": str, "scope_id": str, "scope_type": "account" | "workspace" | "domain", "target_email": str, "updated_at": str, "verification_required": bool, "verification_state": "internal" | "pending" | "verified" | "expired", "verification_expires_at"?: str | null, "verification_sent_at"?: str | null, "verification_verified_at"?: str | null}] | はい |
page | int | はい |
page_size | int | はい |
total | int | はい |
A2A の例
A2A の例
リクエスト:レスポンス:
MCP の例
MCP の例
リクエスト:レスポンス:
forwarding.update
forwarding.update.
| プロパティ | 値 | プロパティ | 値 |
|---|---|---|---|
| 必要な権限 | forwarding.manage | 認証必須 | はい |
| 実行モード | sync | 機能権限 | forwarding.manage |
| リソースタイプ | account | リソース ID フィールド | account_id |
| 公開 API ルート | PATCH /v1/public/accounts/{account_id}/forwarding/{forwarding_id} |
引数
引数
| 名前 | 型 | 必須 |
|---|---|---|
account_id | str | はい |
forwarding_id | str | はい |
target_email | str | はい |
戻り値
戻り値
| フィールド | 型 | 必須 |
|---|---|---|
active | bool | はい |
created_at | str | はい |
id | str | はい |
scope_id | str | はい |
scope_type | "account" | "workspace" | "domain" | はい |
target_email | str | はい |
updated_at | str | はい |
verification_required | bool | はい |
verification_state | "internal" | "pending" | "verified" | "expired" | はい |
verification_expires_at | str | null | いいえ |
verification_sent_at | str | null | いいえ |
verification_verified_at | str | null | いいえ |
A2A の例
A2A の例
リクエスト:レスポンス:
MCP の例
MCP の例
リクエスト:レスポンス:
forwarding.verification.confirm
forwarding.verification.confirm.
| プロパティ | 値 | プロパティ | 値 |
|---|---|---|---|
| 必要な権限 | forwarding.manage | 認証必須 | はい |
| 実行モード | sync | 機能権限 | forwarding.manage |
| リソースタイプ | account | リソース ID フィールド | account_id |
| 公開 API ルート | POST /v1/public/accounts/{account_id}/forwarding/{forwarding_id}/verification/confirm |
引数
引数
| 名前 | 型 | 必須 |
|---|---|---|
account_id | str | はい |
forwarding_id | str | はい |
code | str | はい |
戻り値
戻り値
| フィールド | 型 | 必須 |
|---|---|---|
verified | bool | はい |
forwarding_id | str | null | いいえ |
A2A の例
A2A の例
リクエスト:レスポンス:
MCP の例
MCP の例
リクエスト:レスポンス:
forwarding.verification.send
forwarding.verification.send.
| プロパティ | 値 | プロパティ | 値 |
|---|---|---|---|
| 必要な権限 | forwarding.manage | 認証必須 | はい |
| 実行モード | sync | 機能権限 | forwarding.manage |
| リソースタイプ | account | リソース ID フィールド | account_id |
| 公開 API ルート | POST /v1/public/accounts/{account_id}/forwarding/{forwarding_id}/verification/send |
引数
引数
| 名前 | 型 | 必須 |
|---|---|---|
account_id | str | はい |
forwarding_id | str | はい |
戻り値
戻り値
| フィールド | 型 | 必須 |
|---|---|---|
cooldown_seconds | int | はい |
sent | bool | はい |
expires_at | str | null | いいえ |
A2A の例
A2A の例
リクエスト:レスポンス:
MCP の例
MCP の例
リクエスト:レスポンス: