Get Sender IDs

curl --request GET \
  --url https://api.example.com/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

curl --request GET \
  --url https://api.example.com/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://app.notify.ng/api/v2/SenderId?ApiKey=YOUR_API_KEY&ClientId=YOUR_CLIENT_ID" \
  -H "Content-Type: application/json"

const params = new URLSearchParams({
  ApiKey: 'YOUR_API_KEY',
  ClientId: 'YOUR_CLIENT_ID'
});

const response = await fetch(`https://app.notify.ng/api/v2/SenderId?${params}`, {
  method: 'GET',
  headers: {
    'Content-Type': 'application/json'
  }
});

const data = await response.json();
console.log(data);

import requests

url = "https://app.notify.ng/api/v2/SenderId"
params = {
    "ApiKey": "YOUR_API_KEY",
    "ClientId": "YOUR_CLIENT_ID"
}

response = requests.get(url, params=params)
data = response.json()
print(data)

Parameters

string

required

Your API key for authentication

string

required

Your client identifier for authentication

Response

number

Error code (0 for success)

string

Description of the result

array

Array of sender ID objects

number

Unique identifier for the sender ID

number

Company identifier

string

The sender ID text

string

Purpose or description of the sender ID

boolean

Whether the sender ID is currently active

string

Date when the sender ID was created

string

Approval status of the sender ID

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

Authentication

Credit Balance

SMS Management

Group Management

Sender ID Management

Template Management

Webhooks

Error Handling

Get Sender IDs

Get Sender IDs

Parameters

Response

Success Response

Sender ID Guidelines

Use Cases

​Get Sender IDs

​Parameters

​Response

​Success Response

​Sender ID Guidelines

​Use Cases

Get Sender IDs

Parameters

Response

Success Response

Sender ID Guidelines

Use Cases