Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Excerpt
hiddentrue

Questions frequently asked about CommCare Messaging.

...

CommCare Messaging Frequently Asked Questions

SMS

...

How is the SMS Export different from the Message Log?

...

Pricing

For any SMS pricing questions, please refer to https://dimagi.atlassian.net/wiki/spaces/commcarepublic/pages/2143950358/CommCare+Pricing+FAQs#Fees-for-SMS

SMS Basics

Can I send SMS reminders over e-mail? 

...

  • CommCare Messaging does not support USSD

  • USSD stands for Unstructured Supplementary Service Data.

  • If your project requires USSD, consider using a system like Telerivet. Telerivet's USSD Expansion pack enables you to send USSD requests and receive replies via Telerivet, allowing you to check and recharge your phone's balance and interact with mobile banking services.

How do I specify a language for sending messages?

...

Reference

Meaning

contact_phone_number

sets the phone number that receives message. Always include the country code.

contact_phone_number_is_verified

required case property to activate two way messaging, set to equal 1.

time_zone 

used to adjust the send time for a case

language_code

sets the default language code for a case (ex. en, fra)

partial_submission

meta data available in the form export. determines if a survey was complete 

To see the complete list check out https://dimagi.atlassian.net/wiki/pages/resumedraft.action?draftId=2290778113&draftShareId=67b371a5-7deb-4e4d-8067-2d70159718e8.  

What is the best process for building complex messaging? 

...

...

Complex triggers can be calculated by using a hidden value that combines several questions into one output.

Can we dynamically trigger a workflow with SMS answers?

...

Answer: The "Custom Immediate" schedule type is a custom schedule where the events are defined by waiting a certain number of minutes after the last event. This use case has caused some confusion, especially when used with a repeating schedule, so it's use is discouraged and support for this use case is limited. As a result, you can create new alerts of this type but there are some parts of it that will not be editable. You can still edit the message content that is sent, however. If you need a custom schedule type, consider using the Custom Daily schedule which is a much more robust custom schedule type and allows editing of events.

Gateways

When do I need to set up a gateway?

...

A gateway is essential for international projects to support in-country messaging

...

.

...

...

SMS

...

Gateways cannot send messages if they are offline.

...

Gateways cannot guarantee that SMS messages are delivered on time.

How do the established gateways on HQ work?

  • Twilio gateways use phone numbers maintained by CommCareHQ to send messages inside the US and a limited number of international countries. The per message rates can be high based on the country destination.

  • To learn more check out Gateway Options for SMS Projects.

Are gateways free?

  • CommCare HQ has established free Gateways in some countries. Today, we support gateways in Ethiopia, India, Lesotho, Mozambique, South Africa and Uganda.

  • In most cases, gateways cost money. The primary costs include:

    • Purchase of the smartphone

    • Maintenance of a phone number or active SIM card

    • Assuring the gateway has sufficient credit

    • And may include subscription costs of the Gateway provider

  • Each message from CommCareHQ costs $.01/message.

  • If you have additional questions, reach out to support@dimagi.com to learn more.

Who manages SMS gateways?

  • SMS Gateways are managed in the SMS Connectivity section of the Messaging Tab

  • Project staff are responsible for managing SMS gateways.

  • Project staff are best suited for this, especially if it requires monitoring and maintaining a phone numbers in the field.

Does CommCare have a preferred Gateway provider? 

  • Both Twilio and Telerivet integrate easily with CommCareHQ.

  • For international SMS projects, many projects use a separate Android phone to create a Telerivet gateway.  This requires an active local SIM card.

  • For U.S. based SMS projects, many projects choose to use Twilio.  A web based phone number can be purchased for $1/month.

What is the volume cut-off for a Telerivet gateway versus going to Telecoms?

  • If the messaging system is meant to deliver messages en masse at a specific time of day.

  • Telerivet Gateways have an SMS rate limit, of about 600 messages per hour.

  • Often projects will calculate the daily SMS rate limit, but should actually consider the peak number of messages per hour. The daily limit per Android gateway is 14400 messages a day.

  • For example, 6,000 cases are all set to receive an SMS survey message at 10h00. The rate limit works such that it would take 10 hours to send out messages in batches of 600 message per hour.  The last of these cases would receive their survey message at 20h00.

How do I manage the SMS sending rate limit? Does it depend on my Telerivet subscription level? 

  • The SMS rate limit does not depend on the paid Telerivet subscription.

  • The SMS rate limit can be increased by downloading Expansion Packs from the Google Play store. Each additional expansion pack raises the rate limit by 60 messages per hour. You can download up to 10 expansion packs.

  • One way to further increase the SMS rate limit, is to purchase an additional Android phone, and add a local SIM card.

  • CommCare Messaging supports splitting contacts between gateways.

Is there a difference in Message Loads between inbound and outbound SMS? 

  • Inbound SMS messages do not have rate limits

  • Outbound SMS message do have rate limits, based on the gateways capacity. Shortcodes do not have the same rate limits.

How do you test an SMS gateway?

  • To test an SMS gateway, test each of the rules in your SMS system design. 

  • The first priority is to confirm that messages are sent to phones, and incoming messages are received. 

  • To pass gateway tests, there must be an active gateway phone and a working API connection.

How do you test a gateway in multiple countries?

  • To test an SMS gateway in multiple countries, procure a SIM card for each country mobile operator.  Start by sending test messages to each phone. Once received, send in a response to confirm that messages can be sent both ways.

  • For more information regarding managing your SMS system check out the Telerivet FAQ for helpful tips.

SMS Reminders

How do I reference a case property in an sms reminder? 

...

  • Testing SMS is difficult. Without close monitoring, SMS systems can fail silently. If you experience an error please reach out to support@dimagi.com.

SMS Pricing

...

  • .

...