---
title: OTP SMS Sender node
description: Uses an email-to-SMS gateway provider to send an SMS message containing a generated one-time password to the user.
component: auth-node-ref
version: 7.4
page_id: auth-node-ref::otp-sms-sender
canonical_url: https://docs.pingidentity.com/auth-node-ref/latest/otp-sms-sender.html
llms_txt: https://docs.pingidentity.com/auth-node-ref/llms.txt
docs_for_agents: https://developer.pingidentity.com/build-with-ai/docs-for-agents.md
keywords: ["Nodes & Trees", "Journeys", "Authentication", "Email", "SMS"]
page_aliases: ["auth-node-otp-sms-sender.adoc"]
superseded_by: https://docs.pingidentity.com/auth-node-ref/latest/otp-sms-sender.html
section_ids:
  compatibility: Compatibility
  outcomes: Outcomes
  properties: Properties
---

# OTP SMS Sender node

Uses an email-to-SMS gateway provider to send an SMS message containing a generated one-time password to the user.

The node sends an email to an address formed by joining the following values together:

* The user's telephone number, obtained by querying a specified profile attribute, for example, `telephoneNumber`.

* The `@` character.

* The email-to-SMS gateway domain, obtained by querying the profile attribute specified by the Mobile Carrier Attribute Name property.

For example, if configured to use the *TextMagic* email-to-SMS service, the node might send an email through the specified SMTP server to the address: `18005550187@textmagic.com`.

## Compatibility

| Product                                    | Compatible?           |
| ------------------------------------------ | --------------------- |
| PingOne Advanced Identity Cloud            | [icon: check, set=fa] |
| ForgeRock Access Management (self-managed) | [icon: check, set=fa] |
| Ping Identity Platform (self-managed)      | [icon: check, set=fa] |

## Outcomes

Single outcome path.

## Properties

| Property                            | Usage                                                                                                                                                                                                                                                 |
| ----------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Mail Server Host Name *(required)*  | Specifies the hostname of the SMTP email server.                                                                                                                                                                                                      |
| Mail Server Host Port               | Specifies the outgoing mail server port.Common ports are 25, 465 for SSL/TLS, or 587 for StartTLS.                                                                                                                                                    |
| Mail Server Authentication Username | Specifies the username AM uses to connect to the mail server.                                                                                                                                                                                         |
| Mail Server Authentication Password | Specifies the password AM uses to connect to the mail server.                                                                                                                                                                                         |
| Email From Address *(required)*     | Specifies the email address from which the one-time password will appear to have been sent.                                                                                                                                                           |
| Mobile Phone Number Attribute Name  | Specifies the user's profile attribute containing the mobile phone number to which to send the SMS containing the OTP.Default: `telephoneNumber`                                                                                                      |
| Mobile Carrier Attribute Name       | Specifies the user's profile attribute containing the mobile carrier domain used as the email to SMS gateway.                                                                                                                                         |
| The subject of the message          | Click Add to add a new message subject. Enter the locale, such as `en-uk`, in the KEY field and the subject in the VALUE field. Repeat these steps for each locale that you support.                                                                  |
| The content of the message          | Click Add to add the content of the message. Enter the locale, such as `en-uk`, in the KEY field and the email content in the VALUE field. Repeat these steps for each locale that you support.                                                       |
| Mail Server Secure Connection       | Specifies how to connect to the mail server.If a secure method is specified, AM must trust the server certificate of the mail server.The possible values for this property are:- `NON SSL/TLS`

- `SSL/TLS`

- `Start TLS`Default: `SSL/TLS`          |
| Gateway Implementation Class        | Specifies the class the node uses to send SMS and email messages. A custom class must implement the `com.sun.identity.authentication.modules.hotp.SMSGateway` interface.Default: `com.sun.identity.authentication.modules.hotp.DefaultSMSGatewayImpl` |