Set up SMS provider

To send a verification or authentication SMS to your users, you must have an SMS provider solution. ReachFive provides Twilio as the default solution. However, you can use any SMS provider solution that you wish.

SMS Prerequisites

  • You must have access to the ReachFive Console.

  • You must have the SMS feature enabled.

  • You must have an SMS provider account.

    Please contact support if you do not see SMS enabled.

Set up Twilio

Twilio
  1. Log in to your Twilio account.

  2. From your Twilio console dashboard, copy your Account SID, Auth Token, and My Twilio phone number.

    This is typically found on your Project’s home page, under Account Info.

    Expand to see visual.

    account info
ReachFive Console
  1. Go to Settings  SMS  Providers and choose Twilio from the Client type dropdown.

  2. Enter your Twilio Account SID.

  3. Enter your Twilio Auth Token.

  4. Enter the phone number from your Twilio Account that you configured to be your sender.

    By default, Twilio assigns you a number. However, you can configure your own number to be used if so desired.
  5. Type something and click the Send Test SMS button.

    You might have a local test server to see these messages.
  6. Don’t forget to Save your input.

    Expand to see visual.

    console twilio

Set up Custom SMS provider

  1. Go to to Settings  SMS  Providers and choose Custom SMS Provider from from the Client type dropdown.

  2. Enter the endpoint for your custom provider’s SMS API.

    When sent, the REQUEST and payload are set and not customisable.
  3. Enter the HTTP Authorization value (if applicable).

    If the API uses a non-standard authorization header, ensure you tick the Use non-standard name for the Authorization header box and enter the header name.
  4. Select the Send Test SMS button.

  5. Don’t forget to Save your input.

Select the endpoint where you would like ReachFive to send sms requests

The request and payload are the following. The payload is not customisable.

POST https://YOUR_DOMAIN

{
  "sms": "string/sms",
  "template_id": "string",
  "personalizations": {
     "given_name": "string",
     "last_name": "string",
     "gender": "string",
     "has_password": "boolean", (1)
     "redirect_url": "string/url"
   }
}
1 The has_password boolean is only included in the payload for the password_reset template.

The has_password boolean gives custom sms providers the option to let users create a password.

  • true: The user already has a password; the user should be asked to reset the existing password.

  • false: The user does not have a password associated with their account; the user should be asked to create a password.