ارسال رمز یکبار مصرف صوتی (VOTP)

این API به شما امکان ارسال پیام VOTP (رمز یکبار مصرف صوتی) را می‌دهد.

📍 لینک دسترسی

POST {base_url}/api/send

🧾 هدرها

کلید	مقدار
Authorization	توکن یا کلید دسترسی
Content-Type	application/json

📤 بدنه درخواست

{
  "sending_type": "votp",
  "message": "45852",
  "params": {
    "recipients": [
      "+989120000000"
    ]
  }
}

📝 پارامترها

پارامتر	نوع	ضروری	توضیحات
sending_type	string	بله	نوع ارسال، باید "votp" باشد
message	string	بله	محتوای پیام برای ارسال، یک رمز یکبار مصرف (OTP)، مانند "45852". حتما باید عدد و کمتر از 15 رقم باشد
params	object	بله	شی شامل شماره موبایل مورد نظر جهت دریتفت تماس. فقط یک گیرنده مجاز است.
recipients	array	بله	لیست شماره تلفن گیرنده در فرمت E.164 (مثال: +989120000000)، فقط یک گیرنده برای VOTP مجاز است

📝 نکات

• پیام VOTP به صورت صوتی خوانده می‌شود.
• آرایه recipients باید شامل شماره تلفن معتبر در فرمت E.164 باشد.
• فقط یک گیرنده برای هر درخواست VOTP مجاز است.
• پیام معمولاً شامل ارقام است که به صورت صوتی خوانده می‌شوند.

✅ پاسخ موفق

{
  "data": {
    "message_outbox_ids": [
      1123544244
    ]
  },
  "meta": {
    "status": true,
    "message": "انجام شد",
    "message_parameters": [],
    "message_code": "200-1"
  }
}

❌ پاسخ خطا — درخواست نامعتبر (422)

{
  "data": null,
  "meta": {
    "status": false,
    "message": "تکمیل گزینه پیام الزامی است",
    "message_parameters": [],
    "message_code": "400-2",
    "errors": {
      "message": [
        "تکمیل گزینه پیام الزامی است"
      ]
    }
  }
}

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

curl --location '{base_url}/api/send' \
--header 'Content-Type: application/json' \
--header 'Authorization: API TOKEN' \
--data '{
    "sending_type": "votp",
    "message": "45852",
    "params": {
        "recipients": [
            "+989120000000"
        ]
    }
}'