Send SMS with Variables

POST

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

Send a message containing variable keywords. The keywords (attributes) must be wrapped inside % signs within the text (E.g: Hello %first_name%)

Request

Authorization

Add parameter in header

Api-Key

Example:

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

Body Params application/json

Example

{
    "text": "test %var1% text",
    "line_number": "50002178584000",
    "recipients": [
        {
            "mobile": "09120000000",
            "var1": "value1"
        },
        {
            "mobile": "09130000000",
            "var1": "value2"
        }
    ], // array of recipient phone numbers + vars
    "number_format": "english",
    // "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/keywords' \
--header 'Api-Key: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "text": "test %var1% text",
    "line_number": "50002178584000",
    "recipients": [
        {
            "mobile": "09120000000",
            "var1": "value1"
        },
        {
            "mobile": "09130000000",
            "var1": "value2"
        }
    ], // array of recipient phone numbers + vars
    "number_format": "english",
    // "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 2025-12-18 05:58:07

Send Simple SMS from Excel

Send SMS with Variables from Excel