Home › Send SMS

Send Pattern-Based SMS — FarazSMS SMS web service

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

Purpose: Send a templated message (OTP, verification codes, transaction alerts). Fastest path and never queued — use this for one-time codes.

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

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

Request fields

• code (string) — required
• attributes (array) — optional
• schedule (string) — optional — Maybe it must be null for patterns
• line_number (string) — required
• number_format (string) — required — english | persian
• recipient (string) — required — Like: 09120000000

Example body

{
  "code": "SJ3FgPrE0C",
  "attributes": {
    "var1": "1",
    "var2": "2"
  },
  "recipient": "09120000000",
  "line_number": "50002178584000",
  "number_format": "english"
}

All FarazSMS web services · llms.txt · OpenAPI