basalt / notifications/src / SmsChannelOptions

Interface: SmsChannelOptions

Defined in: notifications/src/channels.ts:177

Properties

from?

> optional from?: string

Defined in: notifications/src/channels.ts:181

Default sender id (phone number / WhatsApp business number).

---

name?

> optional name?: string

Defined in: notifications/src/channels.ts:179

Channel name. Default 'sms'; use 'whatsapp' for the WhatsApp variant.

---

toAddress?

> optional toAddress?: (recipient) => string | undefined

Defined in: notifications/src/channels.ts:183

How to read the recipient's address. Default: recipient.phone.

Parameters

recipient

Notifiable

Returns

string | undefined