پرش به مطلب اصلی

راهنمای درخواست برقراری تک‌زنگ (Call API)

برای برقراری تماس از طریق سرویس فلش‌کال، نیاز است که درخواستی از نوع POST به آدرس URL مشخص شده زده شود. بدنه این درخواست باید به صورتی که در ادامه مشاهده خواهید کرد باشد و ضمنا توضیحات بدنه پاسخی که از طرف ما داده می‌شود هم جلوتر شرح داده خواهد شد.


🌐 آدرس درخواست - Base URL

https://gateway.ferzz.ir/

🔐 احراز هویت

برای استفاده از API باید token مخصوص سرویس خود را در بدنه درخواست ارسال کنید:

"token": "Your access token"

🚀 Endpoint: ارسال درخواست تماس (ارسال کد)

POST /send

درخواستی برای برقراری تماس به شماره کاربر با کد ارسالی حداکثر 5 رقمی.

Headers

KeyValue
Content-Typeapplication/json

Request Body

{
"destination": "989123456789",
"token": "Your access token",
"action": "flashcall",
"payload": {
"code": "05043"
}
}
فیلدنوعاجباریتوضیح
destinationstringشماره موبایل کاربر با کد کشور
codestringکد احراز هویت کاربر (باید 4 یا 5 رقمی باشد)
tokenstringکلید دسترسی سرویس
actionstringشناسه مورد نیاز برای تک زنگ

Success Response

{
"message": "درخواست با موفقیت ارسال شد.",
"status": 200,
"track_id": "cdd18c14-5ef8-407a-b2b0-d08877a718a7"
}
فیلدنوعاجباریتوضیح
messagestringمتن نتیجه
statusstringکد نتیجه درخواست
track_idstringکد پیگیری درخواست

Error Responses

StatusMessage (EN)Message (FA)Example Codes
400Invalid inputورودی نامعتبرD01, D02, D03, D04, D05, D06, D07
403Access denied / Token unusableدسترسی غیرمجاز / توکن قابل استفاده نیستT02, T03, P01
404Token not foundتوکن یافت نشدT01
409Token quota exhaustedسهمیه توکن به پایان رسیدهT05
422Message could not be sentارسال پیام با خطا مواجه شدN01, N02, N03
429Too many requestsدرخواست‌های بیش‌ازحد(Rate limiter, custom)
500Internal server errorخطای داخلی سرورP02, P03

🧪 نمونه درخواست با curl

curl -X POST https://gateway.ferzz.ir/send \
-H "Content-Type: application/json" \
-d '{
"destination": "989123456789",
"token": "YOUR_ACCESS_TOKEN",
"action": "flashcall",
"payload": {
"code": "12345"
}
}'