Send Simple SMS from Phonebook

POST

https://api.iranpayamak.com/ws/v1/sms/simple

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

{
    "text": "test message",
    "selectedPhoneBooks": [
        {
            "id": 1,
            "offset": 0,
            "limit": 10
        }
    ],
    "line_number": "98123123",
    "number_format": "english",
    "schedule": "2026-03-20T10:00:00Z" // 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/simple' \
--header 'Accept: application/json' \
--header 'Api-Key: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "text": "test message",
    "selectedPhoneBooks": [
        {
            "id": 1,
            "offset": 0,
            "limit": 10
        }
    ],
    "line_number": "98123123",
    "number_format": "english",
    "schedule": "2026-03-20T10:00:00Z" // 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:51:05

Send Simple SMS from Excel

Send SMS with Variables