{ "openapi": "3.1.0", "info": { "title": "تلفن ابری همکاران — AI Agent API", "description": "تلفن ابری همکاران، پلتفرم مرکز تماس ابری (Cloud PBX) برای کسب‌وکارها؛ شامل تلفن گویا، صف تماس، داخلی سازمانی، ضبط مکالمات، گزارش تماس، فکس اینترنتی، صندوق صوتی، اتصال به CRM، وب‌هوک و API.\n\nاین API عمومی برای دستیارهای هوش مصنوعی طراحی شده و فقط اطلاعات عمومی ارائه می‌دهد و سرنخ فروش می‌پذیرد. هیچ دسترسی به داده‌های خصوصی مشتری وجود ندارد.", "version": "1.0.0", "contact": { "name": "تلفن ابری همکاران", "email": "info@hamkaran.cloud", "url": "https://hamkaran.cloud" }, "license": { "name": "Public", "url": "https://hamkaran.cloud/openapi.json" } }, "servers": [ { "url": "https://hamkaran.cloud/wp-json/hamkaran-ai/v1/", "description": "WordPress REST API" } ], "externalDocs": { "description": "Portal توسعه‌دهنده", "url": "https://developers.hamkaran.cloud" }, "tags": [ { "name": "services", "description": "خدمات و قابلیت‌ها" }, { "name": "pricing", "description": "پلن‌ها و محاسبه هزینه" }, { "name": "content", "description": "مقالات، مستندات، FAQ" }, { "name": "business", "description": "معرفی کسب‌وکار و تماس" }, { "name": "leads", "description": "ثبت سرنخ (demo/consultation/sales)" } ], "paths": { "/manifest": { "get": { "tags": [ "manifest" ], "summary": "دریافت فهرست کامل ابزارها و متادیتای API.", "operationId": "manifest", "description": "دریافت فهرست کامل ابزارها و متادیتای API.", "responses": { "200": { "description": "پاسخ موفق.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "پارامتر نامعتبر.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } }, "404": { "description": "یافت نشد.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } }, "429": { "description": "rate limit.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } }, "500": { "description": "خطای داخلی.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } }, "/services": { "get": { "tags": [ "services" ], "summary": "فهرست خدمات اصلی.", "operationId": "services", "description": "فهرست خدمات اصلی.", "responses": { "200": { "description": "پاسخ موفق.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "پارامتر نامعتبر.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } }, "404": { "description": "یافت نشد.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } }, "429": { "description": "rate limit.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } }, "500": { "description": "خطای داخلی.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } }, "/services/{slug}": { "get": { "tags": [ "services" ], "summary": "جزئیات یک خدمت.", "operationId": "service_detail", "description": "جزئیات یک خدمت.", "responses": { "200": { "description": "پاسخ موفق.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "پارامتر نامعتبر.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } }, "404": { "description": "یافت نشد.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } }, "429": { "description": "rate limit.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } }, "500": { "description": "خطای داخلی.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } }, "parameters": [ { "name": "slug", "in": "path", "required": true, "schema": { "type": "string" }, "description": "شناسه خدمت." } ] } }, "/features": { "get": { "tags": [ "services" ], "summary": "فهرست قابلیت‌ها.", "operationId": "features", "description": "فهرست قابلیت‌ها.", "responses": { "200": { "description": "پاسخ موفق.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "پارامتر نامعتبر.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } }, "404": { "description": "یافت نشد.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } }, "429": { "description": "rate limit.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } }, "500": { "description": "خطای داخلی.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } }, "/plans": { "get": { "tags": [ "pricing" ], "summary": "فهرست پلن‌ها با قیمت زنده.", "operationId": "plans", "description": "فهرست پلن‌ها با قیمت زنده.", "responses": { "200": { "description": "پاسخ موفق.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "پارامتر نامعتبر.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } }, "404": { "description": "یافت نشد.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } }, "429": { "description": "rate limit.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } }, "500": { "description": "خطای داخلی.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } }, "/plans/compare": { "get": { "tags": [ "pricing" ], "summary": "ماتریس مقایسه پلن‌ها.", "operationId": "plans_compare", "description": "ماتریس مقایسه پلن‌ها.", "responses": { "200": { "description": "پاسخ موفق.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "پارامتر نامعتبر.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } }, "404": { "description": "یافت نشد.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } }, "429": { "description": "rate limit.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } }, "500": { "description": "خطای داخلی.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } }, "/pricing/calculate": { "get": { "tags": [ "pricing" ], "summary": "محاسبه برآورد هزینه.", "operationId": "pricing_calculate", "description": "محاسبه برآورد هزینه.", "responses": { "200": { "description": "پاسخ موفق.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "پارامتر نامعتبر.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } }, "404": { "description": "یافت نشد.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } }, "429": { "description": "rate limit.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } }, "500": { "description": "خطای داخلی.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } }, "parameters": [ { "name": "plan", "in": "query", "required": true, "schema": { "type": "string" }, "description": "کد پلن." }, { "name": "extensions", "in": "query", "required": true, "schema": { "type": "integer", "minimum": 1 }, "description": "تعداد داخلی." }, { "name": "period", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "monthly", "quarterly", "semiannual", "annual" ] } }, { "name": "addons", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } } ] } }, "/articles/search": { "get": { "tags": [ "content" ], "summary": "جست‌وجوی مقالات/مستندات.", "operationId": "articles_search", "description": "جست‌وجوی مقالات/مستندات.", "responses": { "200": { "description": "پاسخ موفق.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "پارامتر نامعتبر.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } }, "404": { "description": "یافت نشد.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } }, "429": { "description": "rate limit.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } }, "500": { "description": "خطای داخلی.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } }, "parameters": [ { "name": "q", "in": "query", "required": true, "schema": { "type": "string" }, "description": "عبارت جست‌وجو." }, { "name": "type", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "post", "page" ] }, "description": "نوع محتوا (پیش‌فرض post)." }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1 } } ] } }, "/docs": { "get": { "tags": [ "content" ], "summary": "فهرست مستندات فنی.", "operationId": "docs", "description": "فهرست مستندات فنی.", "responses": { "200": { "description": "پاسخ موفق.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "پارامتر نامعتبر.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } }, "404": { "description": "یافت نشد.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } }, "429": { "description": "rate limit.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } }, "500": { "description": "خطای داخلی.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } }, "/faq": { "get": { "tags": [ "content" ], "summary": "سؤالات متداول.", "operationId": "faq", "description": "سؤالات متداول.", "responses": { "200": { "description": "پاسخ موفق.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "پارامتر نامعتبر.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } }, "404": { "description": "یافت نشد.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } }, "429": { "description": "rate limit.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } }, "500": { "description": "خطای داخلی.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } }, "/api-info": { "get": { "tags": [ "content" ], "summary": "اطلاعات API و Webhook.", "operationId": "api_info", "description": "اطلاعات API و Webhook.", "responses": { "200": { "description": "پاسخ موفق.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "پارامتر نامعتبر.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } }, "404": { "description": "یافت نشد.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } }, "429": { "description": "rate limit.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } }, "500": { "description": "خطای داخلی.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } }, "/contact": { "get": { "tags": [ "business" ], "summary": "اطلاعات تماس.", "operationId": "contact", "description": "اطلاعات تماس.", "responses": { "200": { "description": "پاسخ موفق.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "پارامتر نامعتبر.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } }, "404": { "description": "یافت نشد.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } }, "429": { "description": "rate limit.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } }, "500": { "description": "خطای داخلی.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } }, "/business": { "get": { "tags": [ "business" ], "summary": "معرفی کامل کسب‌وکار.", "operationId": "business", "description": "معرفی کامل کسب‌وکار.", "responses": { "200": { "description": "پاسخ موفق.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "پارامتر نامعتبر.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } }, "404": { "description": "یافت نشد.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } }, "429": { "description": "rate limit.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } }, "500": { "description": "خطای داخلی.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } }, "/phone-numbers": { "get": { "tags": [ "services" ], "summary": "فهرست اپراتورهای ارائه‌دهنده خطوط PSTN و معرفی صفحه انتخاب شماره.", "operationId": "phone_operators", "description": "فهرست اپراتورهای ارائه‌دهنده خطوط PSTN و معرفی صفحه انتخاب شماره.", "responses": { "200": { "description": "پاسخ موفق.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "پارامتر نامعتبر.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } }, "404": { "description": "یافت نشد.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } }, "429": { "description": "rate limit.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } }, "500": { "description": "خطای داخلی.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } }, "/leads/demo": { "post": { "tags": [ "leads" ], "summary": "ثبت درخواست demo. شامل rate limit، honeypot و اعتبارسنجی موبایل.", "operationId": "lead_demo", "description": "ثبت درخواست demo. شامل rate limit، honeypot و اعتبارسنجی موبایل.", "responses": { "200": { "description": "پاسخ موفق.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "پارامتر نامعتبر.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } }, "404": { "description": "یافت نشد.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } }, "429": { "description": "rate limit.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } }, "500": { "description": "خطای داخلی.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "name", "mobile" ], "properties": { "name": { "type": "string", "minLength": 2, "maxLength": 100 }, "mobile": { "type": "string", "pattern": "^09[0-9]{9}$", "description": "موبایل ایرانی." }, "company": { "type": "string", "maxLength": 200 }, "notes": { "type": "string", "maxLength": 1000 }, "use_case": { "type": "string", "maxLength": 300 }, "source": { "type": "string", "maxLength": 100 }, "hp": { "type": "string", "description": "honeypot — باید خالی باشد." } } } } } } } }, "/leads/consultation": { "post": { "tags": [ "leads" ], "summary": "ثبت درخواست consultation. شامل rate limit، honeypot و اعتبارسنجی موبایل.", "operationId": "lead_consultation", "description": "ثبت درخواست consultation. شامل rate limit، honeypot و اعتبارسنجی موبایل.", "responses": { "200": { "description": "پاسخ موفق.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "پارامتر نامعتبر.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } }, "404": { "description": "یافت نشد.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } }, "429": { "description": "rate limit.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } }, "500": { "description": "خطای داخلی.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "name", "mobile" ], "properties": { "name": { "type": "string", "minLength": 2, "maxLength": 100 }, "mobile": { "type": "string", "pattern": "^09[0-9]{9}$", "description": "موبایل ایرانی." }, "company": { "type": "string", "maxLength": 200 }, "notes": { "type": "string", "maxLength": 1000 }, "use_case": { "type": "string", "maxLength": 300 }, "source": { "type": "string", "maxLength": 100 }, "hp": { "type": "string", "description": "honeypot — باید خالی باشد." } } } } } } } }, "/leads/sales": { "post": { "tags": [ "leads" ], "summary": "ثبت درخواست sales. شامل rate limit، honeypot و اعتبارسنجی موبایل.", "operationId": "lead_sales", "description": "ثبت درخواست sales. شامل rate limit، honeypot و اعتبارسنجی موبایل.", "responses": { "200": { "description": "پاسخ موفق.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "پارامتر نامعتبر.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } }, "404": { "description": "یافت نشد.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } }, "429": { "description": "rate limit.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } }, "500": { "description": "خطای داخلی.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "name", "mobile" ], "properties": { "name": { "type": "string", "minLength": 2, "maxLength": 100 }, "mobile": { "type": "string", "pattern": "^09[0-9]{9}$", "description": "موبایل ایرانی." }, "company": { "type": "string", "maxLength": 200 }, "notes": { "type": "string", "maxLength": 1000 }, "use_case": { "type": "string", "maxLength": 300 }, "source": { "type": "string", "maxLength": 100 }, "hp": { "type": "string", "description": "honeypot — باید خالی باشد." } } } } } } } } }, "components": { "securitySchemes": {} } }