Skip to main content

Signature

getSenderIDs(name?: string): Promise<any>

HTTP request

GET https://api.pindo.io/sender_ids/?name=${name}

Parameters

name
string
default:"''"
Filter results by sender ID name. Pass an empty string or omit to retrieve all registered sender IDs.

Response

A successful response contains a data object with a sender_ids array:
{
  "data": {
    "sender_ids": [
      {
        "name": "ematerw"
      }
    ]
  }
}

Example

import { PindoSMS } from 'pindo-sms';

const pindo = new PindoSMS('your-api-token');

// Retrieve all sender IDs
const all = await pindo.getSenderIDs();
console.log(all.data.sender_ids);

// Filter by name
const filtered = await pindo.getSenderIDs('ematerw');
console.log(filtered.data.sender_ids);

Error handling

try {
  const result = await pindo.getSenderIDs('ematerw');
} catch (err) {
  console.error('Failed to fetch sender IDs:', err.message);
}

Build docs developers (and LLMs) love