Send Postal Code SMS

POST

https://api.iranpayamak.com/ws/v1/sms/calculate-cost

Request

Authorization

Add parameter in header

Api-Key

Example:

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

Header Params

Body Params application/jsonRequired

Example

{
    "filters": [
        {
            "postal_code": "12345", // first [3,4,5] digit of postal code
            "gender_id": 1,
            "age_from": 1305,
            "age_to": 1310,
            "number_prefix": "912", // nullable
            "operator": "mci", // mci,irancell,other
            "row_from": 0,
            "row_count": 50
        }
    ],
    "text": "message text",
    "line_id": 12,
    "number_format": "english",
    "schedule": "2026-04-01T10:00:00Z"
}

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/calculate-cost' \
--header 'Accept: application/json' \
--header 'Api-Key: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "filters": [
        {
            "postal_code": "12345", // first [3,4,5] digit of postal code
            "gender_id": 1,
            "age_from": 1305,
            "age_to": 1310,
            "number_prefix": "912", // nullable
            "operator": "mci", // mci,irancell,other
            "row_from": 0,
            "row_count": 50
        }
    ],
    "text": "message text",
    "line_id": 12,
    "number_format": "english",
    "schedule": "2026-04-01T10:00:00Z"
}'

Responses

🟠401

application/json

Body

Example

{
    "status": "string",
    "message": "string",
    "data": null
}

Modified at 2026-03-19 17:41:57

Get Receiver Counts

Send Simple SMS