Documentation Index
Fetch the complete documentation index at: https://docs.hybridbox.io/llms.txt
Use this file to discover all available pages before exploring further.
إعادة التوجيه
إدارة قواعد إعادة التوجيه وعناوين إعادة التوجيه.
تستخدم الأمثلة وضع الكود في A2A. يتيح MCP وضع الكود نفسه عبر أداة execute.
الوظائف
forwarding.activate
forwarding.activate(account_id: str, forwarding_id: str, active: bool) -> ForwardingRule
إعادة التوجيه: forwarding.activate.
| الخاصية | القيمة | الخاصية | القيمة |
|---|
| الإذن المطلوب | forwarding.manage | المصادقة مطلوبة | نعم |
| وضع التنفيذ | sync | الصلاحية | forwarding.manage |
| نوع المورد | account | حقل معرف المورد | 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 | لا |
الطلب:{
"request_id": "example",
"session_id": "session_123",
"code": "forwarding.activate(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", forwarding_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", active=true)"
}
الاستجابة:{
"request_id": "example",
"status": "completed",
"result": {
"last_value": true
},
"responses": [
{
"index": 0,
"function": "forwarding.activate",
"status": "completed",
"result": true
}
],
"complexity_score": 1
}
الطلب:{
"jsonrpc": "2.0",
"id": "example",
"method": "tools/call",
"params": {
"name": "hybridbox_execute",
"arguments": {
"code": "forwarding.activate(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", forwarding_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", active=true)"
}
}
}
الاستجابة:{
"jsonrpc": "2.0",
"id": "example",
"result": {
"content": [
{
"type": "text",
"text": "{\n \"request_id\": \"example\",\n \"status\": \"completed\",\n \"result\": {\n \"last_value\": true\n },\n \"responses\": [\n {\n \"index\": 0,\n \"function\": \"forwarding.activate\",\n \"status\": \"completed\",\n \"result\": true\n }\n ],\n \"complexity_score\": 1\n}"
}
],
"isError": false
}
}
forwarding.add
forwarding.add(account_id: str, target_email: str, domain?: str | null, workspace_id?: str | null) -> ForwardingRule
إعادة التوجيه: forwarding.add.
| الخاصية | القيمة | الخاصية | القيمة |
|---|
| الإذن المطلوب | forwarding.manage | المصادقة مطلوبة | نعم |
| وضع التنفيذ | sync | الصلاحية | forwarding.manage |
| نوع المورد | account | حقل معرف المورد | 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 | لا |
الطلب:{
"request_id": "example",
"session_id": "session_123",
"code": "forwarding.add(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", target_email=\"user@example.com\", domain=\"example.com\", workspace_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\")"
}
الاستجابة:{
"request_id": "example",
"status": "completed",
"result": {
"last_value": true
},
"responses": [
{
"index": 0,
"function": "forwarding.add",
"status": "completed",
"result": true
}
],
"complexity_score": 1
}
الطلب:{
"jsonrpc": "2.0",
"id": "example",
"method": "tools/call",
"params": {
"name": "hybridbox_execute",
"arguments": {
"code": "forwarding.add(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", target_email=\"user@example.com\", domain=\"example.com\", workspace_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\")"
}
}
}
الاستجابة:{
"jsonrpc": "2.0",
"id": "example",
"result": {
"content": [
{
"type": "text",
"text": "{\n \"request_id\": \"example\",\n \"status\": \"completed\",\n \"result\": {\n \"last_value\": true\n },\n \"responses\": [\n {\n \"index\": 0,\n \"function\": \"forwarding.add\",\n \"status\": \"completed\",\n \"result\": true\n }\n ],\n \"complexity_score\": 1\n}"
}
],
"isError": false
}
}
forwarding.delete
forwarding.delete(account_id: str, forwarding_id: str) -> {}
إعادة التوجيه: forwarding.delete.
| الخاصية | القيمة | الخاصية | القيمة |
|---|
| الإذن المطلوب | forwarding.manage | المصادقة مطلوبة | نعم |
| وضع التنفيذ | sync | الصلاحية | forwarding.manage |
| نوع المورد | account | حقل معرف المورد | account_id |
| مسار API العام | DELETE /v1/public/accounts/{account_id}/forwarding/{forwarding_id} | | |
| الاسم | النوع | مطلوب |
|---|
account_id | str | نعم |
forwarding_id | str | نعم |
| الحقل | النوع | مطلوب |
|---|
result | {} | نعم |
الطلب:{
"request_id": "example",
"session_id": "session_123",
"code": "forwarding.delete(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", forwarding_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\")"
}
الاستجابة:{
"request_id": "example",
"status": "completed",
"result": {
"last_value": {}
},
"responses": [
{
"index": 0,
"function": "forwarding.delete",
"status": "completed",
"result": {}
}
],
"complexity_score": 1
}
الطلب:{
"jsonrpc": "2.0",
"id": "example",
"method": "tools/call",
"params": {
"name": "hybridbox_execute",
"arguments": {
"code": "forwarding.delete(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", forwarding_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\")"
}
}
}
الاستجابة:{
"jsonrpc": "2.0",
"id": "example",
"result": {
"content": [
{
"type": "text",
"text": "{\n \"request_id\": \"example\",\n \"status\": \"completed\",\n \"result\": {\n \"last_value\": {}\n },\n \"responses\": [\n {\n \"index\": 0,\n \"function\": \"forwarding.delete\",\n \"status\": \"completed\",\n \"result\": {}\n }\n ],\n \"complexity_score\": 1\n}"
}
],
"isError": false
}
}
forwarding.list
forwarding.list(account_id: str, page?: int, page_size?: int) -> Page[ForwardingRule]
إعادة التوجيه: forwarding.list.
| الخاصية | القيمة | الخاصية | القيمة |
|---|
| الإذن المطلوب | forwarding.view | المصادقة مطلوبة | نعم |
| وضع التنفيذ | sync | الصلاحية | forwarding.view |
| نوع المورد | account | حقل معرف المورد | 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 | نعم |
الطلب:{
"request_id": "example",
"session_id": "session_123",
"code": "forwarding.list(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", page=123, page_size=123)"
}
الاستجابة:{
"request_id": "example",
"status": "completed",
"result": {
"last_value": true
},
"responses": [
{
"index": 0,
"function": "forwarding.list",
"status": "completed",
"result": true
}
],
"complexity_score": 1
}
الطلب:{
"jsonrpc": "2.0",
"id": "example",
"method": "tools/call",
"params": {
"name": "hybridbox_execute",
"arguments": {
"code": "forwarding.list(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", page=123, page_size=123)"
}
}
}
الاستجابة:{
"jsonrpc": "2.0",
"id": "example",
"result": {
"content": [
{
"type": "text",
"text": "{\n \"request_id\": \"example\",\n \"status\": \"completed\",\n \"result\": {\n \"last_value\": true\n },\n \"responses\": [\n {\n \"index\": 0,\n \"function\": \"forwarding.list\",\n \"status\": \"completed\",\n \"result\": true\n }\n ],\n \"complexity_score\": 1\n}"
}
],
"isError": false
}
}
forwarding.update
forwarding.update(account_id: str, forwarding_id: str, target_email: str) -> ForwardingRule
إعادة التوجيه: forwarding.update.
| الخاصية | القيمة | الخاصية | القيمة |
|---|
| الإذن المطلوب | forwarding.manage | المصادقة مطلوبة | نعم |
| وضع التنفيذ | sync | الصلاحية | forwarding.manage |
| نوع المورد | account | حقل معرف المورد | 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 | لا |
الطلب:{
"request_id": "example",
"session_id": "session_123",
"code": "forwarding.update(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", forwarding_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", target_email=\"user@example.com\")"
}
الاستجابة:{
"request_id": "example",
"status": "completed",
"result": {
"last_value": true
},
"responses": [
{
"index": 0,
"function": "forwarding.update",
"status": "completed",
"result": true
}
],
"complexity_score": 1
}
الطلب:{
"jsonrpc": "2.0",
"id": "example",
"method": "tools/call",
"params": {
"name": "hybridbox_execute",
"arguments": {
"code": "forwarding.update(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", forwarding_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", target_email=\"user@example.com\")"
}
}
}
الاستجابة:{
"jsonrpc": "2.0",
"id": "example",
"result": {
"content": [
{
"type": "text",
"text": "{\n \"request_id\": \"example\",\n \"status\": \"completed\",\n \"result\": {\n \"last_value\": true\n },\n \"responses\": [\n {\n \"index\": 0,\n \"function\": \"forwarding.update\",\n \"status\": \"completed\",\n \"result\": true\n }\n ],\n \"complexity_score\": 1\n}"
}
],
"isError": false
}
}
forwarding.verification.confirm
forwarding.verification.confirm(account_id: str, forwarding_id: str, code: str) -> ForwardingRule
إعادة التوجيه: forwarding.verification.confirm.
| الخاصية | القيمة | الخاصية | القيمة |
|---|
| الإذن المطلوب | forwarding.manage | المصادقة مطلوبة | نعم |
| وضع التنفيذ | sync | الصلاحية | forwarding.manage |
| نوع المورد | account | حقل معرف المورد | 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 | لا |
الطلب:{
"request_id": "example",
"session_id": "session_123",
"code": "forwarding.verification.confirm(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", forwarding_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", code=\"<string>\")"
}
الاستجابة:{
"request_id": "example",
"status": "completed",
"result": {
"last_value": true
},
"responses": [
{
"index": 0,
"function": "forwarding.verification.confirm",
"status": "completed",
"result": true
}
],
"complexity_score": 1
}
الطلب:{
"jsonrpc": "2.0",
"id": "example",
"method": "tools/call",
"params": {
"name": "hybridbox_execute",
"arguments": {
"code": "forwarding.verification.confirm(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", forwarding_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", code=\"<string>\")"
}
}
}
الاستجابة:{
"jsonrpc": "2.0",
"id": "example",
"result": {
"content": [
{
"type": "text",
"text": "{\n \"request_id\": \"example\",\n \"status\": \"completed\",\n \"result\": {\n \"last_value\": true\n },\n \"responses\": [\n {\n \"index\": 0,\n \"function\": \"forwarding.verification.confirm\",\n \"status\": \"completed\",\n \"result\": true\n }\n ],\n \"complexity_score\": 1\n}"
}
],
"isError": false
}
}
forwarding.verification.send
forwarding.verification.send(account_id: str, forwarding_id: str) -> ForwardingRule
إعادة التوجيه: forwarding.verification.send.
| الخاصية | القيمة | الخاصية | القيمة |
|---|
| الإذن المطلوب | forwarding.manage | المصادقة مطلوبة | نعم |
| وضع التنفيذ | sync | الصلاحية | forwarding.manage |
| نوع المورد | account | حقل معرف المورد | 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 | لا |
الطلب:{
"request_id": "example",
"session_id": "session_123",
"code": "forwarding.verification.send(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", forwarding_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\")"
}
الاستجابة:{
"request_id": "example",
"status": "completed",
"result": {
"last_value": 123
},
"responses": [
{
"index": 0,
"function": "forwarding.verification.send",
"status": "completed",
"result": 123
}
],
"complexity_score": 1
}
الطلب:{
"jsonrpc": "2.0",
"id": "example",
"method": "tools/call",
"params": {
"name": "hybridbox_execute",
"arguments": {
"code": "forwarding.verification.send(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", forwarding_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\")"
}
}
}
الاستجابة:{
"jsonrpc": "2.0",
"id": "example",
"result": {
"content": [
{
"type": "text",
"text": "{\n \"request_id\": \"example\",\n \"status\": \"completed\",\n \"result\": {\n \"last_value\": 123\n },\n \"responses\": [\n {\n \"index\": 0,\n \"function\": \"forwarding.verification.send\",\n \"status\": \"completed\",\n \"result\": 123\n }\n ],\n \"complexity_score\": 1\n}"
}
],
"isError": false
}
}