Desktop SMS & Text Me the App


No Longer Supported

Text Me The App (TMTA) is no longer supported for new customers.

You may implement Desktop SMS to App using one of the following methods:

Desktop SMS allows users to send themselves an SMS with a link to your app. Configure the landing page that the users will see after they click on that link. Desktop SMS configuration can be used along with Text Me the App.

Configure Desktop SMS Settings

  1. Navigate to the Configuration page, and click on the Desktop SMS tab.


This setting overrides the default desktop redirect behavior for all links

Do not enable Desktop SMS unless this is the desired behavior.

  1. On the left side of the page, under Setup, select the type of landing page you want to use:
  • Branch-hosted SMS Landing Page:
    This is a default SMS landing page hosted by Branch. You can edit the text that your users will see on this page. You can replace the {{link}} placeholder with something else. Please refer to the documentation here.
  • Deepviews Content Previews with SMS:
    Select the Deepview key that you want to display.
  • Custom Landing Page with SMS:
    Use this if you are using Text-Me-The-App. You can create your own custom branded landing page instead of using the one hosted by Branch.
  1. In all cases, you can customize the SMS users will receive.
  2. Click Save.

Test Desktop SMS Configuration

After configuring your Desktop SMS settings, you can test your configuration by:

  1. On the right side, under Test link, click to copy the link.
  2. Open the link in a new tab.
  3. Enter your phone number to receive a link to download the app.

Text Me the App

When users click your links on desktop, they have the option to text themselves a link to download your app. We provide this by default on every Branch link, but you can also create your own fully-branded Text Me The App page.

Left: Branch default. Right: a customized version.Left: Branch default. Right: a customized version.

Left: Branch default. Right: a customized version.

Usage Policies

Branch reserves the right to limit your use of the Text Me The App service and charge for SMS costs at its own discretion. To understand Branch's policies in this regard, please contact your Branch Account Manager or [email protected] at any time for assistance.

As of May 2021, we no longer support Text Me The App (TMTA) in Uzbekistan, Nigeria, and Vietnam.


These instructions allow you to customize the Text Me The App Page instead of using the default TMTA page or show a desktop deepview.

Set Destination URL

  1. Visit the Desktop SMS page on the Branch dashboard.
  2. Select Custom Landing Page with SMS, after you toggle to On.
  3. Enter the destination URL.



Make sure you can access this page

Because you will be making changes to this URL, be sure you have access to the page and can make changes to its HTML.

Insert SendSMS() snippet into your Web Page

When you have set your destination URL from the previous step, go to that page and insert the sendSMS function into your web page code.

And that's it. From here, you can customize the HTML and CSS, and Branch will take care of the rest. If you want to further customize the page or SMS message itself, read further.

Advanced Features

Use Twilio SMS service

In order to get set up with your Twilio account, Branch needs the following information to enable the integration.

  • Branch App ID
  • Account SID
  • Auth Tokens
  • Twilio Phone numbers to send from

Please reach out to your CSM with the above information to enable the Twilio integration.


Phone number retention policy

Phone numbers are redacted from Branch's Twilio instance, but if you use your own SMS provider, phone numbers may be stored either temporarily or indefinitely by that provider.

Use a custom form with SendSMS()

Call sendSMS when someone enters something into your form.

Customize SMS message content

The default text for SMS messages is "Click here to download [App Name] {{ link }}".

If you want to customize this, Branch allows you to set a default for all messages, or customize the message for each link.

Customize all messages

You can create your own custom default message that will be sent if the specific link someone clicks doesn't have a customized message itself. Navigate back to the Desktop SMS page on the Branch dashboard. You should see the following section below.


Editing this field will modify all SMS messages sent.

Custom link-specific messages

If you don't want to edit the global SMS text, you can define a special SMS message for each individual link. Whether you want to switch the language of a message for a different region or include device specific date, you can specify the message in the Deep Link Data section at the bottom of the link editing screen.


Use the $custom_sms_text parameter and then enter your custom message in the value section. Make sure to include the {{ link }} tag in your custom message! Read the following scenario below to see this in action.

The developer of FlowerPower wants to customize the SMS messages based on the country of the recipient. For each Branch link, they would specify in the deep link data a different custom message.

For ads in France:
Cliquez pour télécharger FlowerPower ici {{ link }}

For ads in Spain:
Haz click aquí para descargar FlowerPower {{ link }}

For ads in Germany:
Klicken Sie auf das FlowerPower hier herunterladen {{ link }}

Use liquid tags to further customize messages

You can access almost any value of your link's parameters by using liquid tags. The customization options are only limited to your imagination.

  • The tag {{ link }} is replaced with your Branch link
  • {{ }} and {{ link.campaign }} output the channel and campaign, if these were set when creating the link.
  • {{ }} will output a parameter of your link's data dictionary, where key is the name of the parameter

Here's an example to illustrate this scenario.

Dmitri is creating Branch links to deep link to each of the different flowers in his app FlowerPower. He creates each link with a key/value pair of the key flower and the flower name, e.g. Flower : Rose, Flower : Tulip. He wants to customize his SMS messages based on name of the flower, so he sets his custom link messages as:

{{ }}s on the mind? Click here to buy some for your home! {{ link }}


Setting default replacement values for liquid tags

If a specific tag isn't always going to be filled, you can use a | character to specify a default to fallback on if the tag is missing from your link dictionary.

E.g. {{ | default:"Alex" }}

If the information isn't found, the tag will just be replaced with Alex instead of being replaced by an empty string.


Did this page help you?