Home › Send SMS

Send Postal Code SMS — FarazSMS SMS web service

POST https://api.iranpayamak.com/ws/v1/sms/postal/send

Authentication

This endpoint requires the Api-Key header — get the key from the FarazSMS panel. The header name is case-sensitive and the key must never travel in a query string.

Request fields

• text (string) — required
• number_format (string) — required
• line_id (integer) — required
• schedule (string) — required — Optional. Omit it or send null to send immediately. A future "YYYY-MM-DD HH:MM:SS" schedules the send — the message is accepted and its cost is reserved at submit time, and it is delivered at that moment, not now. A past date is rejected with a validation error.
• 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"
}

Responses

• 401

Related endpoints in Send SMS

• POST /ws/v1/sms/pattern — Send Pattern-Based SMS
• POST /ws/v1/sms/simple — Send Simple SMS
• POST /ws/v1/sms/keywords — Send SMS with Variables
• POST /ws/v1/lbs — Create New LBS Request
• GET /ws/v1/lbs — Get LBS Requests List
• PUT /ws/v1/lbs/{lbsId} — Edit LBS Request
• GET /ws/v1/lbs/{lbsId} — Show Single LBS Request Details
• PATCH /ws/v1/lbs/{lbsId}/cancel — Cancel LBS Request

All FarazSMS web services · llms.txt · OpenAPI