Home › Send SMS

Send Sample SMS — FarazSMS SMS web service

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

Purpose: Send a sample only to yourself, to test the text and sender line before a bulk campaign.

Send a sample of message to the account owner

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
• number_format (string) — optional

Notes for this endpoint

• A sample SMS goes only to the account owner — to test your text before a mass send.
• Good for verifying the message body cheaply.

Example body

{
  "text": "test text",
  "line_number": "50002178584000",
  "number_format": "english"
}

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