Overview

SMS gateways are used by CommCareHQ to send and receive text messages.  Each SMS gateway is represented by a phone number - normally a gateway is setup for each country, but some gateway providers will let you send messages to many countries. 

If you don't want to use one of CommCareHQ's shared Gateways, or if you can't because connectivity isn't working with the countries or networks of your recipients, you can setup your own Android SMS gateway with Telerivet, and integrate it with CommCareHQ.   An Android SMS gateway will use an Android phone and its SIM card to send and receive messages for CommCareHQ.

Below are instructions on how to get setup.

Step 1 - Create a Telerivet Account and Connect it to Your CommCareHQ Project

Before proceeding, you will need an Android phone with an active SIM card. All SMS will be sent and received from this phone and SIM. Your phone will be charged according to your plan for sending and receiving SMS. Click here to see the Telerivet FAQ which has important information, including which phones are recommended to be used.

You should only consider setting up a Telerivet Android gateway if:

  1. You have an Android phone that you will be using exclusively for this purpose
  2. The phone will always be on and charged
  3. The phone will always be connected to wifi (or optionally, mobile data, though that may be more expensive)
  4. You will monitor the phone's balance and ensure it always has enough credit to send and receive SMS

If you have a phone that meets those criteria, you can get started by navigating to Messaging -> SMS Connectivity in your project space. At the bottom of this page, click "Add Another Gateway". CommCareHQ will then walk you through the steps to setup a Telerivet SMS gateway and connect it to your CommCareHQ project for sending and receiving SMS:

 

Step 2: Read these Important Tips for using Telerivet with CommCare Messaging

Step 3 - Registration of Contacts

You still register your contacts in CommCareHQ the same way as you would if used any other SMS gateway. Information on registering mobile worker contacts is here, and information on registering case contacts is here.

Step 4 (Optional) - Share Your Telerivet Gateway with Another Project

If you have already set up your Telerivet gateway on CommCareHQ, you may want to share it with another project. To do this: 

  1. Log into your original project space in CommCareHQ, and navigate to Messaging -> SMS Connectivity. 
  2. Select your pre-existing Telerivet Gatway and click  .

  3. Under "General Settings," check the box that says "Give other domains access." In the next question, type out the name of the project. 
  4. In the new project, make sure that you click "Set As Default" for the shared Telerivet gateway (example below called cc-messaging-test)