Skip to main content
A sender ID is the name or number displayed to a recipient in the “From” field of an SMS. Instead of showing a random short code, you can display your brand name (e.g. MyApp) or a custom alphanumeric string. Sender IDs are country-specific — you register a sender ID for one or more countries, and Pindo uses it when delivering messages to numbers in those countries.

​
Create a sender ID

Use createSenderID to register a new sender ID for one or more countries. Endpoint: POST https://api.pindo.io/sender_ids Request body sent: 
{
  "sender_id": "MyApp",
  "countries": ["RW"]
}
​
senderID
string
required
The sender ID string you want to register. Typically your brand or application name.
​
countries
string[]
required
An array of ISO 3166-1 alpha-2 country codes where this sender ID should be used. For example, ['RW'] for Rwanda or ['RW', 'KE'] for Rwanda and Kenya.
import 'dotenv/config';
import { PindoSMS } from 'pindo-sms';

const pindo = new PindoSMS(process.env.PINDO_API_TOKEN!);

async function registerSenderID() {
  try {
    const response = await pindo.createSenderID('MyApp', ['RW']);
    console.log('Sender ID created:', response);
  } catch (error) {
    console.error('Failed to create sender ID:', error);
  }
}

registerSenderID();

​
Country code examples

CountryCode
RwandaRW
KenyaKE
UgandaUG
TanzaniaTZ
NigeriaNG

​
List sender IDs

Use getSenderIDs to retrieve sender IDs registered on your account. You can optionally filter results by name. Endpoint: GET https://api.pindo.io/sender_ids/?name={name}
​
name
string
Optional filter. When provided, only sender IDs whose name matches are returned. Omit to return all sender IDs.
import 'dotenv/config';
import { PindoSMS } from 'pindo-sms';

const pindo = new PindoSMS(process.env.PINDO_API_TOKEN!);

async function listSenderIDs() {
  try {
    // Retrieve all sender IDs
    const all = await pindo.getSenderIDs();
    console.log('All sender IDs:', all);

    // Filter by name
    const filtered = await pindo.getSenderIDs('MyApp');
    console.log('Filtered sender IDs:', filtered);
  } catch (error) {
    console.error('Failed to fetch sender IDs:', error);
  }
}

listSenderIDs();
Sender ID registration may require approval from Pindo before the ID can be used. Check your Pindo dashboard for the status of a newly created sender ID.

Build docs developers (and LLMs) love

Get started for freeTalk to us