SMS Component

Provisions an SMS sending service for transactional messages and OTP codes. Deploy in the global region.

Configuration Fields

Field
Type
Required
Default
Description
type
string

required

—
Must be "sms"
name
string

required

—
Unique component name.
senderId
string

optional

—
Alphanumeric sender ID shown to recipients (e.g. MyApp). Not supported in all countries. Max 11 characters.
messageType
string

optional

"TRANSACTIONAL"
"TRANSACTIONAL" (high priority, OTPs) or "PROMOTIONAL" (marketing). AWS only.

Cloud Resources Created

  • SNS SMS Attributes — sets the default sender ID and message type for the account.

Limitations: AWS SNS SMS is account-level, not resource-level. Spending limits apply. Some countries require pre-registration of sender IDs.

JSON Example

{

  "type": "sms",

  "name": "notification-sms",

  "senderId": "MyApp",

  "messageType": "TRANSACTIONAL"

}

References

SMS is a target-only component.

← Referenced by

Function

Function sends SMS messages. Grants sns:Publish (AWS) or equivalent.

← Referenced by

Authentication

Auth provider sends OTP codes for MFA via SMS.