FarazSMS Public APIs
  1. Send
FarazSMS Public APIs
  • Account
    • Profile
      GET
    • Account Balance
      GET
    • update
      POST
    • Charge wallet
      POST
    • Register
      POST
  • Send
    • Send Sample SMS
      POST
    • Send Simple SMS
      POST
    • Send Simple SMS from Excel
      POST
    • Send SMS with Variables
      POST
    • Send SMS with Variables from Excel
      POST
    • Send Peer-to-Peer SMS
      POST
    • Send Peer-to-Peer SMS from Excel
      POST
    • Send Pattern-Based SMS
      POST
  • Phonebook
    • Get Phonebooks
      GET
    • Create New Phonebook
      POST
    • Get Phonebook Attributes
      GET
    • Create New Phonebook Attribute
      POST
    • Get Phonebook Contacts
      GET
  • Pattern
    • Create New Pattern
      POST
    • Get Pattern Details
      GET
    • Edit Pattern
      PUT
    • Get List of User's Patterns
      GET
  • Get Paged Inbox Messages
    GET
  1. Send

Send Sample SMS

POST
/ws/v1/sms/sample
Send a sample of message to the account owner

Request

Authorization
Add parameter in header
Api-Key
Example:
Api-Key: ********************
Header Params

Body Params application/json

Example
{
    "text": "test text",
    "line_number": "50002191307530",
    "number_format": "english",
    //"schedule": "2025-08-20 15:30:00", // nullable(chosen time to send)
}

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/ws/v1/sms/sample' \
--header 'Accept: application/json' \
--header 'Api-Key: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "text": "test text",
    "line_number": "50002191307530",
    "number_format": "english",
    //"schedule": "2025-08-20 15:30:00", // nullable(chosen time to send)
}'

Responses

🟢201SMS request is enqueued successfully.
application/json
Body

Example
{
    "status": "success",
    "data": 0,
    "messages": "string"
}
Modified at 2025-10-05 19:57:52
Previous
Send
Next
Send Simple SMS
Built with