خانه › ارسال پیامک

ارسال پیام صوتی — وب سرویس پیامک فراز اس ام اس

POST https://api.iranpayamak.com/ws/v1/sms/voice/send

کاربرد: ارسال تماس صوتی (پیام ضبط‌شده) به گیرنده‌ها؛ ابتدا باید فایل صوتی آپلود شده باشد.

Send a Voice message toward many recipients. You must use at least one of the attrebute {recipients} or {selectedPhoneBooks}.

احراز هویت

این سرویس به هدر Api-Key نیاز دارد — کلید را از پنل فراز اس ام اس بگیرید. نام هدر حساس به حروف بزرگ و کوچک است و کلید نباید در query string برود.

فیلدهای درخواست

file_id (integer) — الزامی
recipients (array) — اختیاری
selectedPhoneBooks (array) — اختیاری
schedule (string) — اختیاری — Optional. Omit it or send null to send immediately. A future "YYYY-MM-DD HH:MM:SS" schedules the send — the message is accepted and its cost is reserved at submit time, and it is delivered at that moment, not now. A past date is rejected with a validation error.

نکات مهم این سرویس

پیش‌نیاز: اول فایل صوتی را با «آپلود فایل صوتی» بفرست و file_id بگیر.
recipients یا selectedPhoneBooks را مشخص کن.

نمونه بدنه

{
  "file_id": 1,
  "recipients": [
    "09120000000"
  ],
  "selectedPhoneBooks": [
    {
      "id": 1,
      "offset": 0,
      "limit": 10
    }
  ],
  "schedule": "2025-08-20 15:30:00"
}

پاسخ‌ها

201 — SMS request is enqueued successfully.

سرویس‌های مرتبط در دستهٔ «ارسال پیامک»

همه‌ی وب‌سرویس‌های فراز اس ام اس · llms.txt · OpenAPI