Home › Send SMS

Send SMS with Variables — FarazSMS SMS web service

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

Purpose: Bulk personalized send; variables (e.g. the contact's name) sit inside `%...%` in the text.

Send a message containing variable keywords. The keywords (attributes) must be wrapped inside % signs within the text (E.g: Hello %first_name%)

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
line_number (string) — required
recipients (array) — required
number_format (string) — optional

Notes for this endpoint

Wrap variables in % inside the text (e.g. Hi %first_name%).
Values come from contact/phonebook attributes.
No +98; set number_format correctly.

Example body

{
  "text": "test %var1% text",
  "line_number": "50002178584000",
  "recipients": [
    {
      "mobile": "09120000000",
      "var1": "value1"
    },
    {
      "mobile": "09130000000",
      "var1": "value2"
    }
  ],
  "number_format": "english"
}

Responses

201 — SMS request is enqueued successfully.

Related endpoints in Send SMS

All FarazSMS web services · llms.txt · OpenAPI