Send Bulk SMS

Developing

POST

https://api.iranpayamak.com/ws/v1/sms/bulk/send

Request

Authorization

Add parameter in header

Api-Key

Example:

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

Header Params

Body Params application/jsonRequired

Example

{
  "filters": [
    {
      "province_id": 30,
      "county_id": 343,
      "city_id": 993,
      "postal_code": "",
      "gender_id": 2,
      "operator": 3,
      "age_from": "",
      "age_to": "",
      "number_prefix": "911",
      "row_from": 0,
      "row_count": 2
    }
  ],
  "text": "پیام تستی از وبسرویس",
  "line_number": "2191307530",
  "number_format": "persian",
  "schedule": "",
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location 'https://api.iranpayamak.com/ws/v1/sms/bulk/send' \
--header 'Accept: application/json' \
--header 'Accept;' \
--header 'Api-Key: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
  "filters": [
    {
      "province_id": 30,
      "county_id": 343,
      "city_id": 993,
      "postal_code": "",
      "gender_id": 2,
      "operator": 3,
      "age_from": "",
      "age_to": "",
      "number_prefix": "911",
      "row_from": 0,
      "row_count": 2
    }
  ],
  "text": "پیام تستی از وبسرویس",
  "line_number": "2191307530",
  "number_format": "persian",
  "schedule": "",
}'

Responses

🟢200Success

application/json

Bodyapplication/json

Example

{}

Modified at 2026-07-17 19:31:04

Get Receiver Count

Send Sample SMS