Types

The pindo-sms SDK exports two TypeScript interfaces alongside the PindoSMS class. Import them to type your payloads and improve IDE autocompletion.

Import

import { PindoSMS, SMSPayload, BulkSMSPayload } from 'pindo-sms';

Exports

Name	Kind	Description
`PindoSMS`	class	The main SDK class. See PindoSMS Class.
`SMSPayload`	interface	Payload for `sendSMS`.
`BulkSMSPayload`	interface	Payload for `sendBulkSMS`.

SMSPayload

Used as the argument to sendSMS.

interface SMSPayload {
  to: string;
  text: string;
  sender: string;
}

string

required

The recipient’s phone number in E.164 format (e.g. +250781234567).

text

string

required

The text content of the SMS message.

sender

string

required

The sender ID displayed to the recipient.

BulkSMSPayload

Used as the argument to sendBulkSMS.

interface BulkSMSPayload {
  recipients: { phonenumber: string; name: string }[];
  text: string;
  sender: string;
}

recipients

object[]

required

An array of recipient objects.

Show recipient properties

phonenumber

string

required

The recipient’s phone number in E.164 format.

name

string

required

The recipient’s display name. Referenced via @contact.name in the message text.

text

string

required

The SMS message text. Supports @contact.name for per-recipient personalization.

sender

string

required

The sender ID displayed to all recipients.

PindoSMS Class

​Import

​Exports

​SMSPayload

​BulkSMSPayload

Build docs developers (and LLMs) love

Import

Exports

SMSPayload

BulkSMSPayload