Send Voice Message

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}.

Request

Authorization

Add parameter in header

Api-Key

Example:

Api-Key: ********************

Header Params

Body Params application/jsonRequired

Example

{
    "file_id": 1,
    "recipients": [
        "09120000000"
    ],
    "selectedPhoneBooks": [
        {
            "id": 1,
            "offset": 0,
            "limit": 10
        }
    ],
    "schedule": "2025-08-20 15:30:00" // nullable(chosen time to send)
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.iranpayamak.com/ws/v1/sms/voice/send' \
--header 'Accept: application/json' \
--header 'Api-Key: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "file_id": 1,
    "recipients": [
        "09120000000"
    ],
    "selectedPhoneBooks": [
        {
            "id": 1,
            "offset": 0,
            "limit": 10
        }
    ],
    "schedule": "2025-08-20 15:30:00" // nullable(chosen time to send)
}'

Responses

🟢201SMS request is enqueued successfully.

application/json

Body

Example

{
    "status": "success",
    "data": 0,
    "messages": "string"
}

Modified at 2026-03-19 17:03:15

Send

Download Uploded Voice Message File