Class: Stytch::OTPs::Sms

Inherits:
Object
  • Object
show all
Includes:
RequestHelper
Defined in:
lib/stytch/otps.rb

Instance Method Summary collapse

Methods included from RequestHelper

#delete_request, #get_request, #post_request, #put_request, #request_with_query_params

Constructor Details

#initialize(connection) ⇒ Sms

Returns a new instance of Sms.



122
123
124
 
# File 'lib/stytch/otps.rb', line 122

def initialize(connection)
  @connection = connection
end

Instance Method Details

#login_or_create(phone_number:, expiration_minutes: nil, attributes: nil, create_user_as_pending: nil, locale: nil) ⇒ Object

Send a One-Time Passcode (OTP) to a User using their phone number. If the phone number is not associated with a user already, a user will be created.

### Cost to send SMS OTP Before configuring SMS or WhatsApp OTPs, please review how Stytch [bills the costs of international OTPs](stytch.com/pricing) and understand how to protect your app against [toll fraud](stytch.com/docs/guides/passcodes/toll-fraud/overview).

Note: SMS to phone numbers outside of the US and Canada is disabled by default for customers who did not use SMS prior to October 2023. If you’re interested in sending international SMS, please reach out to [[email protected]]([email protected]?subject=Enable%20international%20SMS).

Even when international SMS is enabled, we do not support sending SMS to countries on our [Unsupported countries list](stytch.com/docs/guides/passcodes/unsupported-countries).

### Next steps

Collect the OTP which was delivered to the User. Call [Authenticate OTP](stytch.com/docs/api/authenticate-otp) using the OTP ‘code` along with the `phone_id` found in the response as the `method_id`.

Parameters:

phone_number

The phone number to use for one-time passcodes. The phone number should be in E.164 format (i.e. 1XXXXXXXXXX). You may use 10000000000 to test this endpoint, see [Testing](stytch.com/docs/home#resources_testing) for more detail. The type of this field is String.

expiration_minutes

Set the expiration for the one-time passcode, in minutes. The minimum expiration is 1 minute and the maximum is 10 minutes. The default expiration is 2 minutes. The type of this field is nilable Integer.

attributes

Provided attributes help with fraud detection. The type of this field is nilable Attributes (object).

create_user_as_pending

Flag for whether or not to save a user as pending vs active in Stytch. Defaults to false.

If true, users will be saved with status pending in Stytch's backend until authenticated.
If false, users will be created as active. An example usage of
a true flag would be to require users to verify their phone by entering the OTP code before creating
an account for them.

The type of this field is nilable Boolean.

locale

Used to determine which language to use when sending the user this delivery method. Parameter is a [IETF BCP 47 language tag](www.w3.org/International/articles/language-tags/), e.g. ‘“en”`.

Currently supported languages are English (‘“en”`), Spanish (`“es”`), and Brazilian Portuguese (`“pt-br”`); if no value is provided, the copy defaults to English.

Request support for additional languages [here](docs.google.com/forms/d/e/1FAIpQLScZSpAu_m2AmLXRT3F3kap-s_mcV6UTBitYn6CdyWP0-o7YjQ/viewform?usp=sf_link“)!

The type of this field is nilable +LoginOrCreateRequestLocale+ (string enum).

Returns:

An object with the following fields:

request_id

Globally unique UUID that is returned with every API call. This value is important to log for debugging purposes; we may ask for this value to help identify a specific API call when helping you debug an issue. The type of this field is String.

user_id

The unique ID of the affected User. The type of this field is String.

phone_id

The unique ID for the phone number. The type of this field is String.

user_created

In ‘login_or_create` endpoints, this field indicates whether or not a User was just created. The type of this field is Boolean.

status_code

The HTTP status code of the response. Stytch follows standard HTTP response status code patterns, e.g. 2XX values equate to success, 3XX values are redirects, 4XX are client errors, and 5XX are server errors. The type of this field is Integer.



266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'lib/stytch/otps.rb', line 266

def (
  phone_number:,
  expiration_minutes: nil,
  attributes: nil,
  create_user_as_pending: nil,
  locale: nil
)
  headers = {}
  request = {
    phone_number: phone_number
  }
  request[:expiration_minutes] = expiration_minutes unless expiration_minutes.nil?
  request[:attributes] = attributes unless attributes.nil?
  request[:create_user_as_pending] = create_user_as_pending unless create_user_as_pending.nil?
  request[:locale] = locale unless locale.nil?

  post_request('/v1/otps/sms/login_or_create', request, headers)
end

#send(phone_number:, expiration_minutes: nil, attributes: nil, locale: nil, user_id: nil, session_token: nil, session_jwt: nil) ⇒ Object

Send a one-time passcode (OTP) to a user’s phone number. If you’d like to create a user and send them a passcode with one request, use our [log in or create](stytch.com/docs/api/log-in-or-create-user-by-sms) endpoint.

Note that sending another OTP code before the first has expired will invalidate the first code.

### Cost to send SMS OTP Before configuring SMS or WhatsApp OTPs, please review how Stytch [bills the costs of international OTPs](stytch.com/pricing) and understand how to protect your app against [toll fraud](stytch.com/docs/guides/passcodes/toll-fraud/overview).

Note: SMS to phone numbers outside of the US and Canada is disabled by default for customers who did not use SMS prior to October 2023. If you’re interested in sending international SMS, please reach out to [[email protected]]([email protected]?subject=Enable%20international%20SMS).

Even when international SMS is enabled, we do not support sending SMS to countries on our [Unsupported countries list](stytch.com/docs/guides/passcodes/unsupported-countries).

### Add a phone number to an existing user

This endpoint also allows you to add a new phone number to an existing Stytch User. Including a ‘user_id`, `session_token`, or `session_jwt` in your Send one-time passcode by SMS request will add the new, unverified phone number to the existing Stytch User. If the user successfully authenticates within 5 minutes, the new phone number will be marked as verified and remain permanently on the existing Stytch User. Otherwise, it will be removed from the User object, and any subsequent login requests using that phone number will create a new User.

### Next steps

Collect the OTP which was delivered to the user. Call [Authenticate OTP](stytch.com/docs/api/authenticate-otp) using the OTP ‘code` along with the `phone_id` found in the response as the `method_id`.

Parameters:

phone_number

The phone number to use for one-time passcodes. The phone number should be in E.164 format (i.e. 1XXXXXXXXXX). You may use 10000000000 to test this endpoint, see [Testing](stytch.com/docs/home#resources_testing) for more detail. The type of this field is String.

expiration_minutes

Set the expiration for the one-time passcode, in minutes. The minimum expiration is 1 minute and the maximum is 10 minutes. The default expiration is 2 minutes. The type of this field is nilable Integer.

attributes

Provided attributes help with fraud detection. The type of this field is nilable Attributes (object).

locale

Used to determine which language to use when sending the user this delivery method. Parameter is a [IETF BCP 47 language tag](www.w3.org/International/articles/language-tags/), e.g. ‘“en”`.

Currently supported languages are English (‘“en”`), Spanish (`“es”`), and Brazilian Portuguese (`“pt-br”`); if no value is provided, the copy defaults to English.

Request support for additional languages [here](docs.google.com/forms/d/e/1FAIpQLScZSpAu_m2AmLXRT3F3kap-s_mcV6UTBitYn6CdyWP0-o7YjQ/viewform?usp=sf_link“)!

The type of this field is nilable +SendRequestLocale+ (string enum).
user_id

The unique ID of a specific User. The type of this field is nilable String.

session_token

The ‘session_token` associated with a User’s existing Session. The type of this field is nilable String.

session_jwt

The ‘session_jwt` associated with a User’s existing Session. The type of this field is nilable String.

Returns:

An object with the following fields:

request_id

Globally unique UUID that is returned with every API call. This value is important to log for debugging purposes; we may ask for this value to help identify a specific API call when helping you debug an issue. The type of this field is String.

user_id

The unique ID of the affected User. The type of this field is String.

phone_id

The unique ID for the phone number. The type of this field is String.

status_code

The HTTP status code of the response. Stytch follows standard HTTP response status code patterns, e.g. 2XX values equate to success, 3XX values are redirects, 4XX are client errors, and 5XX are server errors. The type of this field is Integer.



187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/stytch/otps.rb', line 187

def send(
  phone_number:,
  expiration_minutes: nil,
  attributes: nil,
  locale: nil,
  user_id: nil,
  session_token: nil,
  session_jwt: nil
)
  headers = {}
  request = {
    phone_number: phone_number
  }
  request[:expiration_minutes] = expiration_minutes unless expiration_minutes.nil?
  request[:attributes] = attributes unless attributes.nil?
  request[:locale] = locale unless locale.nil?
  request[:user_id] = user_id unless user_id.nil?
  request[:session_token] = session_token unless session_token.nil?
  request[:session_jwt] = session_jwt unless session_jwt.nil?

  post_request('/v1/otps/sms/send', request, headers)
end