فراز اس ام اس مستندات توسعه‌دهندگان

Home › Reference & Tools

Send Postal Code SMS — FarazSMS SMS web service

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

Purpose: Estimate the cost of a send (e.g. a postal-code send) before you run it.

Auth: header Api-Key (key from the panel, case-sensitive).

Request fields

  • text (string) — required
  • number_format (string) — required
  • line_id (integer) — required
  • schedule (string) — required
  • filters (array) — required

Example body

{
  "filters": [
    {
      "postal_code": "12345",
      "gender_id": 1,
      "age_from": 1305,
      "age_to": 1310,
      "number_prefix": "912",
      "operator": "mci",
      "row_from": 0,
      "row_count": 50
    }
  ],
  "text": "message text",
  "line_id": 12,
  "number_format": "english",
  "schedule": "2026-04-01T10:00:00Z"
}

All FarazSMS web services · llms.txt · OpenAPI