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

ارسال کد احراز هویت (OTP) از طریق پیامک

📡 ارسال OTP با پیامک بین‌الملل

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


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

https://gateway.ferzz.ir/

🔐 احراز هویت

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

"token": "Your access token"

🚀 Endpoint

MethodEndpoint
POST/send

📝 Headers

KeyValue
Content-Typeapplication/json

📦 Request Body

{
"destination": "989123456789",
"token": "Your access token",
"action": "sms",
"payload": {
"code": "05043"
}
}

توضیحات فیلدها

فیلدنوعاجباریتوضیح
destinationstringشماره موبایل کاربر با کد کشور
codestringکد احراز هویت کاربر
tokenstringکلید دسترسی سرویس
actionstringنوع ارسال کد

✅ پاسخ موفق (Success Response)

{
"message": "پیام با موفقیت انجام شد.",
"status": 200,
"track_id": "bcfb18ef-7846-4d1a-beb2-9e412c11541f",
"error": null
}

توضیحات پاسخ موفق

فیلدنوعاجباریتوضیح
messagestringمتن نتیجه
statusnumberکد نتیجه
track_idstringکد پیگیری درخواست
errorstringمتن و کد، در صورت خطا

❌ پاسخ خطا (Error Responses)

{
"message": "کلید دسترسی وجود ندارد.",
"status": 401,
"track_id": "",
"error": {
"code": "S02T01",
"detail": "Token is missing."
}
}

توضیحات خطاها

CodeDetail
S02T01Token is missing.
S02T02Token is not usable.
S02D01Token is missing.
S02D02Phone number format is invalid.
S02D03Code is not valid.
S02N01Network error.

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

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