Class: SMS
Defined in: sms.ts:17
SMS sending and campaign status operations.
Constructors
Constructor
ts
new SMS(client): SMS;Defined in: sms.ts:18
Parameters
| Parameter | Type |
|---|---|
client | HttpClient |
Returns
SMS
Methods
getStatus()
ts
getStatus(campaignId, status?): Promise<Result<SmsDeliveryReport, MNotifyError>>;Defined in: sms.ts:49
Fetches the delivery report for a campaign.
Parameters
| Parameter | Type | Default value |
|---|---|---|
campaignId | string | undefined |
status | string | "null" |
Returns
Promise<Result<SmsDeliveryReport, MNotifyError>>
send()
ts
send(options): Promise<Result<SendSMSResponse, MNotifyError>>;Defined in: sms.ts:21
Sends an SMS message to one or more recipients.
Parameters
| Parameter | Type |
|---|---|
options | SendSMSOptions |
Returns
Promise<Result<SendSMSResponse, MNotifyError>>