Home › Patterns

Create New Pattern — FarazSMS SMS web service

POST https://api.iranpayamak.com/ws/v1/patterns

Purpose: Create a new pattern (template) with variables; the prerequisite of pattern send. Needs approval after creation.

Create a new pattern with API

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

Request fields

• text (string) — required
• description (string) — required — nullable
• share (integer) — required — boolean
• website (string) — required
• category (integer) — required — 1 = otp, 2 = club, 3 = order, 255 = others
• vars (array) — required

Example body

{
  "text": "test text %var%, %var2%",
  "description": "test desc",
  "share": 1,
  "website": "example.com",
  "category": 1,
  "vars": [
    {
      "var": "var",
      "length": 12,
      "type": "int"
    },
    {
      "var": "var2",
      "length": 12,
      "type": "int"
    }
  ]
}

All FarazSMS web services · llms.txt · OpenAPI