الانتقال إلى المحتوى الرئيسي

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_idstrنعم
forwarding_idstrنعم
activeboolنعم
الحقلالنوعمطلوب
activeboolنعم
created_atstrنعم
idstrنعم
scope_idstrنعم
scope_type"account" | "workspace" | "domain"نعم
target_emailstrنعم
updated_atstrنعم
verification_requiredboolنعم
verification_state"internal" | "pending" | "verified" | "expired"نعم
verification_expires_atstr | nullلا
verification_sent_atstr | nullلا
verification_verified_atstr | 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_idstrنعم
target_emailstrنعم
domainstr | nullلا
workspace_idstr | nullلا
الحقلالنوعمطلوب
activeboolنعم
created_atstrنعم
idstrنعم
scope_idstrنعم
scope_type"account" | "workspace" | "domain"نعم
target_emailstrنعم
updated_atstrنعم
verification_requiredboolنعم
verification_state"internal" | "pending" | "verified" | "expired"نعم
verification_expires_atstr | nullلا
verification_sent_atstr | nullلا
verification_verified_atstr | 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_idstrنعم
forwarding_idstrنعم
الحقلالنوعمطلوب
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_idstrنعم
pageintلا
page_sizeintلا
الحقلالنوعمطلوب
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}]نعم
pageintنعم
page_sizeintنعم
totalintنعم
الطلب:
{
  "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_idstrنعم
forwarding_idstrنعم
target_emailstrنعم
الحقلالنوعمطلوب
activeboolنعم
created_atstrنعم
idstrنعم
scope_idstrنعم
scope_type"account" | "workspace" | "domain"نعم
target_emailstrنعم
updated_atstrنعم
verification_requiredboolنعم
verification_state"internal" | "pending" | "verified" | "expired"نعم
verification_expires_atstr | nullلا
verification_sent_atstr | nullلا
verification_verified_atstr | 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_idstrنعم
forwarding_idstrنعم
codestrنعم
الحقلالنوعمطلوب
verifiedboolنعم
forwarding_idstr | 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_idstrنعم
forwarding_idstrنعم
الحقلالنوعمطلوب
cooldown_secondsintنعم
sentboolنعم
expires_atstr | 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
  }
}