Home › Send SMS

Create New LBS Request — FarazSMS SMS web service

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

Purpose: Create a location-based campaign; messages people who are within a chosen area and time window.

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
start_time (integer) — required
end_time (integer) — required
receiver_count (integer) — required
latitude (integer) — required
longitude (integer) — required
radius (integer) — required
address (string) — optional
dispatch_moment (string) — optional
receiver_gender (string) — optional
receiver_age_from (integer) — optional
receiver_age_to (integer) — optional
device (string) — optional

Notes for this endpoint

Creates a new location-based send request (send by geographic location).

Example body

{
  "text": "test text",
  "start_time": 1742773823,
  "end_time": 1742774823,
  "receiver_count": 6000,
  "latitude": 45,
  "longitude": 90,
  "radius": 1000,
  "address": "some address",
  "dispatch_moment": "حضور",
  "receiver_gender": "آقا",
  "receiver_age_from": 12,
  "receiver_age_to": 90,
  "device": "Android"
}

Responses

200

Related endpoints in Send SMS

All FarazSMS web services · llms.txt · OpenAPI