Skip to main content
Create Sender ID
curl --request POST \
  --url https://api.example.com/api/v2/SenderId \
  --header 'Content-Type: application/json' \
  --data '
{
  "SenderId": "<string>",
  "Purpose": "<string>",
  "ApiKey": "<string>",
  "ClientId": "<string>"
}
'
{
  "ErrorCode": 123,
  "ErrorDescription": "<string>",
  "Data": "<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.

​
Create Sender ID

Create a new sender ID for your SMS messages. All sender IDs must be approved before they can be used. 
curl -X POST "https://accounts.netvox.ng/api/v2/SenderId" \
  -H "Content-Type: application/json" \
  -d '{
    "SenderId": "YOURBRAND",
    "Purpose": "Marketing and notifications",
    "ApiKey": "YOUR_API_KEY",
    "ClientId": "YOUR_CLIENT_ID"
  }'

​
Request Body

​
SenderId
string
required
Valid sender ID (3-11 characters, alphanumeric only)
​
Purpose
string
required
Purpose or description of the sender ID
​
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
string
Success message

​
Success Response

{
  "ErrorCode": 0,
  "ErrorDescription": "Success",
  "Data": "Senderid Added successfully."
}

​
Error Response

{
  "ErrorCode": 027,
  "ErrorDescription": "Already exist"
}

​
Sender ID Guidelines

​
Valid Sender IDs

  • Alphanumeric only: Letters and numbers
  • Length: 3-11 characters
  • Examples: YOURBRAND, SMS123, COMPANY

​
Invalid Sender IDs

  • Special characters: @, #, $, etc.
  • Spaces or punctuation
  • Too short (< 3 characters) or too long (> 11 characters)

​
Approval Process

  1. Submit: Create sender ID via API
  2. Review: Our team reviews the request
  3. Approval: Sender ID is approved for use
  4. Activation: Start using the approved sender ID

​
Use Cases

  • Brand recognition: Use your company name as sender ID
  • Marketing campaigns: Create branded sender IDs for campaigns
  • Service notifications: Use descriptive sender IDs for different services
  • Compliance: Ensure all sender IDs are properly approved