Versions Compared

Key

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

Our recommended approach in setting up an SMS gateway is to Setup an Android SMS Gateway. For higher volume projects, you can also consider leveraging a commercial SMS gateway.

Commercial gateways may be better suited for your project if you have higher volume messaging. Below are two options to do this.

Leverage an Existing Gateway in CommCare

CommCare has a set number of existing custom gateways in its system that are only available in certain countries. To see a full list of available gateways, go to Messaging -> SMS Connectivity in your CommCareHQ project space. From there you can choose one to use for your project.

Image RemovedImage Added

There are a few global gateways (US phone numbers) but these are more expensive for sending and receiving international messages. 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.

Please note that Dimagi does not create new custom gateways upon request, and we cannot guarantee the reliability of gateways as they operate independently of CommCare.

Set up a Custom Gateway

Multiexcerpt include macro
macro_uuid846f10d6-3459-462c-8ce9-b12bb0b90265
nameTechnical Documentation
templateDataeJyLjgUAARUAuQ==
pageCommCare Help Site Design Guidance
addpanelfalse

Alternatively, you can establish a relationship with a commercial SMS gateway service provider that provides the local regional coverage that you require. These include both international service providers that offer services in many regions, as well as local service providers who specialize in a single region.

Please note that this approach requires more technical expertise.

Depending on the chosen service provider, these may require adding a new SMS Backend to the CommCare HQ open source codebase.

For information on how a developer can contribute to this codebase, see https://github.com/dimagi/commcare-hq/blob/master/CONTRIBUTING.rst .

Here is more information about CommCare Messaging APIs: SMS APIs