...
- Create an account (or log into your existing account) at: https://telerivet.com/
- Setup your Android phone:
a)
b)
c) Follow the steps outlined on the screen to download and install the application. Note that you do not have to use your google account do this; can use the option to just go through Telerivet.
d) On the Android phone, setup Telerivet to process incoming calls. - Generate an API Key if one is not yet generated:
a)
b)
c) After generating your API key, please write down the API Key, the Project ID and Phone ID, or keep the Telerivet tab open online so that you can refer to this information in a few minutes. - Configure Telerivet to notify CommCareHQ when SMS are sent to your phone:
a)
b)
--update
c) Please type in the information as shown below. For the webhook URL, be sure to include https and a "/" at the end of the URL. This is very important. Make sure to also write down the "Webhook secret" somewhere as well (you will need it later).
...
- Log into your original project space in CommCareHQ, and navigate to Messaging -> SMS Connectivity.
- Select your pre-existing Telerivet Gatway and click
. - Under "General Settings," check the box that says "Give other domains access." In the next question, type out the name of the domain.
- In your new domain, make sure that you click "Set As Default" for the copied Telerivet gateway (example below called cc-messaging-test)
Step 4: Read these Important Tips for using Telerivet with CommCare Messaging
- Please revisit Step 1, 4c. We have found that lots of people often miss this step ("For the webhook URL, be sure to include https and a "/" at the end of the URL. This is very important."), and it's incredibly important!
- When setting your gateway, check to see where your project falls under Telerivet's pricing. It is important to set up the right pricing structure before your project goes live. For example, it's important to ensure that the number of contacts you will be sending to falls within the limit allowed on the account. If you want to set your Telerivet pricing to a non-free plan, make sure that when you use your credit card to add funds to "Select a plan" that you want to use.
...
- Ideally, all data sent from Telerivet to Commcare will be sent through a wi-fi connection. However, if the wi-fi connection is not working or intermittently cuts out, then it's important to have a back up 3G connection. By default, Android phones won't automatically switch from Wi-Fi to mobile data if the phone is connected to the Wi-Fi network but the Wi-Fi network isn't connected to the internet. The Telerivet Android app lets you override that. From the Phone Settings screen in the Telerivet Android app, scroll to the bottom and enable "Network failover". Then Telerivet will automatically switch the phone from Wi-Fi to mobile data if it can't connect to telerivet's servers via Wi-Fi. This may use more airtime but will result in a more reliable connection.
- If there are problems with CommCareHQ and messages can't be sent from the gateway to CommCareHQ immediately, Telerivet will retry failed webhooks periodically for up to a day.
...