Send Pattern-Based SMS

POST

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

Send a pattern-based message, the pattern UID must be creadted and get from user panel.

Request

Authorization

Add parameter in header

Api-Key

Example:

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

Header Params

Body Params application/json

Example

{
    "code": "SJ3FgPrE0C",
    "attributes": {
        "var1": "1",
        "var2": "2"
    },
    "recipient": "09120000000",
    "line_number": "50002178584000",
    "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/pattern' \
--header 'Accept: application/json' \
--header 'Api-Key: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "code": "SJ3FgPrE0C",
    "attributes": {
        "var1": "1",
        "var2": "2"
    },
    "recipient": "09120000000",
    "line_number": "50002178584000",
    "number_format": "english",
    //"schedule": "2025-08-20 15:30:00", // nullable(chosen time to send)
}'

Responses

🟢201Pattern message sent successfully.

application/json

Body

Example

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

Modified at 2025-11-29 16:39:14

Send Peer-to-Peer SMS from Excel

Get Phonebooks