Home › Send SMS

Send to Number Bank — FarazSMS SMS web service

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

Purpose: Targeted send to a Number Bank (ready-made numbers by trade/region) without owning a phonebook.

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

Notes for this endpoint

• Targeted send to a Number Bank. Get the bank list from the “Available Banks” service.
• recipients is optional depending on the bank filter.

Example body

{
  "text": "test message",
  "recipients": [
    {
      "bank_id": 1,
      "limit": 50,
      "offset": 0
    },
    {
      "bank_id": 5,
      "limit": 100,
      "offset": 50
    }
  ],
  "line_number": "98123123",
  "number_format": "english",
  "schedule": "2026-03-20T10:00:00Z"
}

Responses

• 201 — SMS request is enqueued successfully.

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