Skip to content

Interface: SendSMSOptions

Defined in: types.ts:17

Options for sending an SMS message.

Properties

is_schedule?

ts
optional is_schedule?: boolean;

Defined in: types.ts:25

Whether the message is scheduled for later delivery.


message

ts
message: string;

Defined in: types.ts:23

The message content to send.


recipient

ts
recipient: string | string[];

Defined in: types.ts:19

Recipient phone number(s). Can be a single number or an array of numbers.


schedule_date?

ts
optional schedule_date?: string;

Defined in: types.ts:27

The scheduled delivery date/time (required if is_schedule is true).


sender

ts
sender: string;

Defined in: types.ts:21

Sender ID (sender name) to use.