Skip to main content
Get Sent Messages
curl --request GET \
  --url https://api.example.com/api/v2/SMS
{
  "ErrorCode": 123,
  "ErrorDescription": "<string>",
  "Data": {},
  "Data.messages": [
    {}
  ],
  "Data.messages[].MobileNumber": "<string>",
  "Data.messages[].SenderId": "<string>",
  "Data.messages[].Message": "<string>",
  "Data.messages[].SubmitDate": "<string>",
  "Data.messages[].MessageId": "<string>",
  "Data.messages[].DoneDate": "<string>",
  "Data.messages[].Status": "<string>",
  "Data.total": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.ruach.ng/llms.txt

Use this file to discover all available pages before exploring further.

​
Get Sent Messages

Retrieve a paginated list of sent SMS messages with optional date filtering. 
curl -X GET "https://accounts.netvox.ng/api/v2/SMS?ApiKey=YOUR_API_KEY&ClientId=YOUR_CLIENT_ID&start=0&length=10&fromdate=2024-01-01&enddate=2024-12-31" \
  -H "Content-Type: application/json"

​
Parameters

​
ApiKey
string
required
Your API key for authentication
​
ClientId
string
required
Your client identifier for authentication
​
start
number
required
Starting index for pagination (0-based)
​
length
number
required
Number of messages to retrieve per page
​
fromdate
string
Start date filter in yyyy-mm-dd format
​
enddate
string
End date filter in yyyy-mm-dd format

​
Response

​
ErrorCode
number
Error code (0 for success)
​
ErrorDescription
string
Description of the result
​
Data
object
Response data object
​
Data.messages
array
Array of message objects
​
Data.messages[].MobileNumber
string
Mobile number that received the message
​
Data.messages[].SenderId
string
Sender ID used for the message
​
Data.messages[].Message
string
Message content
​
Data.messages[].SubmitDate
string
Date and time when message was submitted
​
Data.messages[].MessageId
string
Unique message identifier
​
Data.messages[].DoneDate
string
Date and time when message was processed
​
Data.messages[].Status
string
Current delivery status
​
Data.total
string
Total number of messages

​
Success Response

{
  "ErrorCode": 0,
  "ErrorDescription": "Success",
  "Data": {
    "messages": [
      {
        "MobileNumber": "9638812576",
        "SenderId": "test",
        "Message": "test message",
        "SubmitDate": "16-Mar-2018 05:12:28 PM",
        "MessageId": "Smsc1603635",
        "DoneDate": "16-Mar-2018 05:11:00 PM",
        "Status": "DELIVRD"
      }
    ],
    "total": "100"
  }
}

​
Message Status Values

StatusDescription
DELIVRDMessage successfully delivered
UNDELIVMessage undelivered
EXPIREDMessage expired
DELETEDMessage deleted
UNKNOWNStatus unknown
ACCEPTDMessage accepted by carrier
REJECTDMessage rejected
BLACKLISTNumber is blacklisted

​
Use Cases

  • Message history: View all sent messages
  • Delivery tracking: Monitor message delivery status
  • Analytics: Analyze message performance over time
  • Audit trail: Track message history for compliance
  • Debugging: Troubleshoot delivery issues