Skip to main content
GET
/
api
/
v2
/
SendSMS
{
  "ErrorCode": 123,
  "ErrorDescription": "<string>",
  "Data": [
    {}
  ],
  "Data[].MobileNumber": "<string>",
  "Data[].MessageId": "<string>"
}

Send SMS (GET)

Send SMS messages using the GET method with URL parameters. This method is useful for simple integrations and testing.
curl -X GET "https://accounts.netvox.ng/api/v2/SendSMS?ApiKey=YOUR_API_KEY&ClientId=YOUR_CLIENT_ID&SenderId=YOUR_SENDER_ID&Message=Hello%20World&MobileNumber=1234567890&Is_Unicode=false&Is_Flash=false"

Parameters

ApiKey
string
required
Your API key for authentication
ClientId
string
required
Your client identifier for authentication
SenderId
string
required
Approved sender ID for the message
Message
string
required
Text message content to send (URL encoded)
MobileNumber
string
required
Mobile number or comma-separated numbers (e.g., “1234567890,0987654321”)
Is_Unicode
boolean
Set to true for Unicode messages (default: false)
Is_Flash
boolean
Set to true for flash messages (default: false)
scheduleTime
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"
}

URL Encoding

When using GET method, ensure proper URL encoding:

JavaScript Example

const message = "Hello World!";
const encodedMessage = encodeURIComponent(message);
// Result: "Hello%20World%21"

Python Example

import urllib.parse

message = "Hello World!"
encoded_message = urllib.parse.quote(message)
# Result: "Hello%20World%21"

Multiple Recipients

Send to multiple numbers using comma separation:
MobileNumber=1234567890,0987654321,5555555555

Message Types

Standard SMS

Is_Unicode=false&Is_Flash=false

Unicode SMS (for special characters)

Is_Unicode=true&Is_Flash=false

Flash SMS (appears on screen without saving)

Is_Unicode=false&Is_Flash=true

Scheduling Messages

To schedule a message for later delivery:
scheduleTime=2024-12-25%2010:00

Use Cases

  • Simple integrations: Quick and easy SMS sending
  • Testing: Test SMS functionality with minimal setup
  • Webhooks: Trigger SMS from webhook endpoints
  • URL-based triggers: Send SMS from URL parameters