Send SMS (POST)

curl --request POST \
  --url https://api.example.com/api/v2/SendSMS \
  --header 'Content-Type: application/json' \
  --data '
{
  "SenderId": "<string>",
  "Message": "<string>",
  "MobileNumbers": "<string>",
  "ApiKey": "<string>",
  "ClientId": "<string>"
}
'

import requests

url = "https://api.example.com/api/v2/SendSMS"

payload = {
    "SenderId": "<string>",
    "Message": "<string>",
    "MobileNumbers": "<string>",
    "ApiKey": "<string>",
    "ClientId": "<string>"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    SenderId: '<string>',
    Message: '<string>',
    MobileNumbers: '<string>',
    ApiKey: '<string>',
    ClientId: '<string>'
  })
};

fetch('https://api.example.com/api/v2/SendSMS', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "ErrorCode": 123,
  "ErrorDescription": "<string>",
  "Data": [
    {}
  ],
  "Data[].MobileNumber": "<string>",
  "Data[].MessageId": "<string>"
}

Send SMS (POST)

curl --request POST \
  --url https://api.example.com/api/v2/SendSMS \
  --header 'Content-Type: application/json' \
  --data '
{
  "SenderId": "<string>",
  "Message": "<string>",
  "MobileNumbers": "<string>",
  "ApiKey": "<string>",
  "ClientId": "<string>"
}
'

import requests

url = "https://api.example.com/api/v2/SendSMS"

payload = {
    "SenderId": "<string>",
    "Message": "<string>",
    "MobileNumbers": "<string>",
    "ApiKey": "<string>",
    "ClientId": "<string>"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    SenderId: '<string>',
    Message: '<string>',
    MobileNumbers: '<string>',
    ApiKey: '<string>',
    ClientId: '<string>'
  })
};

fetch('https://api.example.com/api/v2/SendSMS', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "ErrorCode": 123,
  "ErrorDescription": "<string>",
  "Data": [
    {}
  ],
  "Data[].MobileNumber": "<string>",
  "Data[].MessageId": "<string>"
}

Send SMS (POST)

Send SMS messages using the POST method with a JSON request body. This method is recommended for sending messages with additional parameters.

curl -X POST "https://app.notify.ng/api/v2/SendSMS" \
  -H "Content-Type: application/json" \
  -d '{
    "SenderId": "YOUR_SENDER_ID",
    "Is_Unicode": false,
    "Is_Flash": false,
    "Message": "Hello from Ruach SMS API!",
    "MobileNumbers": "2341234567890,234123412345",
    "ApiKey": "YOUR_API_KEY",
    "ClientId": "YOUR_CLIENT_ID"
  }'

const response = await fetch('https://app.notify.ng/api/v2/SendSMS', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    SenderId: 'YOUR_SENDER_ID',
    Is_Unicode: false,
    Is_Flash: false,
    SchedTime: '',
    GroupId: '',
    Message: 'Hello from Ruach SMS API!',
    MobileNumbers: '1234567890,0987654321',
    ApiKey: 'YOUR_API_KEY',
    ClientId: 'YOUR_CLIENT_ID'
  })
});

const data = await response.json();
console.log(data);

import requests

url = "https://app.notify.ng/api/v2/SendSMS"
data = {
    "SenderId": "YOUR_SENDER_ID",
    "Is_Unicode": True,
    "Is_Flash": False,
    "SchedTime": "",
    "GroupId": "",
    "Message": "Hello from Ruach SMS API!",
    "MobileNumbers": "1234567890,0987654321",
    "ApiKey": "YOUR_API_KEY",
    "ClientId": "YOUR_CLIENT_ID"
}

response = requests.post(url, json=data)
result = response.json()
print(result)

Request Body

string

required

Approved sender ID for the message

string

required

Text message content to send

string

required

Comma-separated mobile numbers (e.g., “1234567890,0987654321”)

string

required

Your API key for authentication

string

required

Your client identifier for authentication

boolean

Set to true for Unicode messages (default: false)

boolean

Set to true for flash messages (default: false)

string

Schedule time in yyyy-MM-dd HH:MM format (optional)

string

Group ID for sending to a group (optional)

Response

number

Error code (0 for success)

string

Description of the result

array

Array of message results

string

Mobile number that received the message

string

Unique message ID for tracking

Success Response

{
  "ErrorCode": 0,
  "ErrorDescription": "Success",
  "Data": [
    {
      "MobileNumber": "7894561230",
      "MessageId": "3bb944ad-d943-419f-83dc-f979002a8c0b"
    }
  ]
}

Error Response

{
  "ErrorCode": 003,
  "ErrorDescription": "SenderId cannot be blank"
}

Message Types

Standard SMS

{
  "Is_Unicode": true,
  "Is_Flash": false
}

Unicode SMS (for special characters)

{
  "Is_Unicode": true,
  "Is_Flash": false
}

Flash SMS (appears on screen without saving)

{
  "Is_Unicode": true,
  "Is_Flash": true
}

Scheduling Messages

To schedule a message for later delivery:

{
  "SchedTime": "2024-12-25 10:00"
}

Use Cases

Transactional messages: Send OTPs, confirmations, and notifications
Marketing campaigns: Send promotional messages to multiple recipients
Scheduled messaging: Send messages at specific times
Group messaging: Send messages to entire contact groups

For a full UI guide, see Dashboard Walkthroug.

Authentication

Credit Balance

SMS Management

Group Management

Sender ID Management

Template Management

Webhooks

Error Handling

Send SMS (POST)

Send SMS (POST)

Request Body

Response

Success Response

Error Response

Message Types

Standard SMS

Unicode SMS (for special characters)

Flash SMS (appears on screen without saving)

Scheduling Messages

Use Cases

​Send SMS (POST)

​Request Body

​Response

​Success Response

​Error Response

​Message Types

​Standard SMS

​Unicode SMS (for special characters)

​Flash SMS (appears on screen without saving)

​Scheduling Messages

​Use Cases

Send SMS (POST)

Request Body

Response

Success Response

Error Response

Message Types

Standard SMS

Unicode SMS (for special characters)

Flash SMS (appears on screen without saving)

Scheduling Messages

Use Cases