$sms
Updated on Aug 29, 2025 2 minutes to readThe SMS Plugin provides methods to send SMS messages, retrieve sent messages, and get available phone numbers.
Methods
| Method | Description |
|---|---|
| getMessages | Retrieves a list of sent SMS messages based on query parameters. |
| getPhones | Returns a list of available phone numbers for the given account token. |
| send | Sends an SMS message to a specified phone number. |
Methods Details
getMessages()
• Type
(query: SmsQuery) => Promise<SmsResponse[]>• Details
Expects SmsQuery object.
Returns a Promise that resolves with an array of SmsResponse objects representing sent messages.
getPhones()
• Type
(accountToken: string) => Promise<SmsPhone[]>• Details
Expects an account token string.
Returns a Promise that resolves with an array of SmsPhone objects.
send()
• Type
(request: SmsRequest) => Promise<SmsResponse>• Details
Expects a SmsRequest object.
Returns a Promise that resolves with a SmsResponse object representing the sent message.