Skip to main content
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>"
}
'
{
  "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://accounts.netvox.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"
  }'

​
Request Body

​
SenderId
string
required
Approved sender ID for the message
​
Message
string
required
Text message content to send
​
MobileNumbers
string
required
Comma-separated mobile numbers (e.g., “1234567890,0987654321”)
​
ApiKey
string
required
Your API key for authentication
​
ClientId
string
required
Your client identifier for authentication
​
Is_Unicode
boolean
Set to true for Unicode messages (default: false)
​
Is_Flash
boolean
Set to true for flash messages (default: false)
​
SchedTime
string
Schedule time in yyyy-MM-dd HH:MM format (optional)
​
GroupId
string
Group ID for sending to a group (optional)

​
Response

​
ErrorCode
number
Error code (0 for success)
​
ErrorDescription
string
Description of the result
​
Data
array
Array of message results
​
Data[].MobileNumber
string
Mobile number that received the message
​
Data[].MessageId
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.