Skip to main content
GET
/
api
/
v2
/
SenderId
{
  "ErrorCode": 123,
  "ErrorDescription": "<string>",
  "Data": [
    {}
  ],
  "Data[].Id": 123,
  "Data[].CompanyId": 123,
  "Data[].Sender-Id": "<string>",
  "Data[].Purpose": "<string>",
  "Data[].IsActive": true,
  "Data[].CreatedDate": "<string>",
  "Data[].ApproveStatus": "<string>",
  "Data[].ApprovedDate": "<string>"
}

​
Get Sender IDs

Retrieve a list of all approved sender IDs in your account. 
curl -X GET "https://accounts.netvox.ng/api/v2/SenderId?ApiKey=YOUR_API_KEY&ClientId=YOUR_CLIENT_ID" \
  -H "Content-Type: application/json"

​
Parameters

​
ApiKey
string
required
Your API key for authentication
​
ClientId
string
required
Your client identifier for authentication

​
Response

​
ErrorCode
number
Error code (0 for success)
​
ErrorDescription
string
Description of the result
​
Data
array
Array of sender ID objects
​
Data[].Id
number
Unique identifier for the sender ID
​
Data[].CompanyId
number
Company identifier
​
Data[].Sender-Id
string
The sender ID text
​
Data[].Purpose
string
Purpose or description of the sender ID
​
Data[].IsActive
boolean
Whether the sender ID is currently active
​
Data[].CreatedDate
string
Date when the sender ID was created
​
Data[].ApproveStatus
string
Approval status of the sender ID
​
Data[].ApprovedDate
string
Date when the sender ID was approved

​
Success Response

{
  "ErrorCode": 0,
  "ErrorDescription": "Success",
  "Data": [
    {
      "Id": 94,
      "CompanyId": 47,
      "Sender-Id": "SMS123",
      "Purpose": "TEST",
      "IsActive": true,
      "CreatedDate": "Nov 20, 2018",
      "ApproveStatus": "Approved",
      "ApprovedDate": "Nov 21, 2018"
    }
  ]
}

​
Sender ID Guidelines

  • Alphanumeric: Use only letters and numbers
  • Length: Typically 3-11 characters
  • Approval: All sender IDs must be approved before use
  • Purpose: Provide clear purpose for each sender ID
  • Compliance: Follow local regulations and carrier requirements

​
Use Cases

  • Brand recognition: Use consistent sender IDs for brand awareness
  • Compliance: Ensure all sender IDs are properly approved
  • Management: Track and manage multiple sender IDs
  • Integration: Sync sender ID data with your application