Home › Send SMS

Send Voice Message — FarazSMS SMS web service

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

Purpose: Send a voice call (recorded message) to recipients; the audio must be uploaded first.

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

Authentication

This endpoint requires the Api-Key header — get the key from the FarazSMS panel. The header name is case-sensitive and the key must never travel in a query string.

Request fields

• file_id (integer) — required
• recipients (array) — optional
• selectedPhoneBooks (array) — optional
• schedule (string) — optional — 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.

Notes for this endpoint

• Prerequisite: first upload the audio via Upload Voice File and get a file_id.
• Provide recipients or selectedPhoneBooks.

Example body

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

Responses

• 201 — SMS request is enqueued successfully.

Related endpoints in Send SMS

• POST /ws/v1/sms/pattern — Send Pattern-Based SMS
• POST /ws/v1/sms/simple — Send Simple SMS
• POST /ws/v1/sms/keywords — Send SMS with Variables
• POST /ws/v1/lbs — Create New LBS Request
• GET /ws/v1/lbs — Get LBS Requests List
• PUT /ws/v1/lbs/{lbsId} — Edit LBS Request
• GET /ws/v1/lbs/{lbsId} — Show Single LBS Request Details
• PATCH /ws/v1/lbs/{lbsId}/cancel — Cancel LBS Request

All FarazSMS web services · llms.txt · OpenAPI