Skip to main content
GET
/
api
/
v2
/
MessageStatus
{
  "ErrorCode": 123,
  "ErrorDescription": "<string>",
  "Data": {},
  "Data.MobileNumber": "<string>",
  "Data.SenderId": "<string>",
  "Data.Message": "<string>",
  "Data.SubmitDate": "<string>",
  "Data.MessageId": "<string>",
  "Data.DoneDate": "<string>",
  "Data.Status": "<string>"
}

Get Message Status

Retrieve the delivery status and details of a specific SMS message using its message ID.
curl -X GET "https://accounts.netvox.ng/api/v2/MessageStatus?ApiKey=YOUR_API_KEY&ClientId=YOUR_CLIENT_ID&MessageId=Smsc1603635" \
  -H "Content-Type: application/json"

Parameters

ApiKey
string
required
Your API key for authentication
ClientId
string
required
Your client identifier for authentication
MessageId
string
required
Message ID of the SMS to check (obtained from send response)

Response

ErrorCode
number
Error code (0 for success)
ErrorDescription
string
Description of the result
Data
object
Message status details
Data.MobileNumber
string
Mobile number that received the message
Data.SenderId
string
Sender ID used for the message
Data.Message
string
Original message content
Data.SubmitDate
string
Date and time when message was submitted
Data.MessageId
string
Unique message identifier
Data.DoneDate
string
Date and time when message was processed
Data.Status
string
Current delivery status

Success Response

{
  "ErrorCode": 0,
  "ErrorDescription": "Success",
  "Data": {
    "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"
  }
}

Error Response

{
  "ErrorCode": 022,
  "ErrorDescription": "Invalid jobid"
}

Message Status Values

StatusDescription
DELIVRDMessage successfully delivered to recipient
UNDELIVMessage failed to deliver
EXPIREDMessage expired before delivery
DELETEDMessage was deleted
UNKNOWNStatus is unknown
ACCEPTDMessage accepted by carrier
REJECTDMessage rejected by carrier
BLACKLISTRecipient number is blacklisted

Use Cases

  • Delivery confirmation: Check if a specific message was delivered
  • Customer support: Help customers track their message status
  • Analytics: Monitor delivery success rates
  • Debugging: Troubleshoot delivery issues
  • Compliance: Maintain delivery logs for regulatory requirements

Best Practices

  1. Store Message IDs: Always store message IDs returned from send operations
  2. Polling: Check status periodically for important messages
  3. Error handling: Handle different status values appropriately
  4. Timeouts: Set reasonable timeouts for status checks