CommCare Messaging Troubleshooting
The first step in SMS troubleshooting is understanding the available Messaging reports and their purpose. The below table is a summary of the reports with example of when they can be used.
Messaging Reports Summary
Report Name | Description | Use Case |
---|---|---|
Message Log | Contains a list of cumulative messages received and sent |
|
Messaging History | The Messaging History report allows you to view all of the messaging related activity for a project - it will list any successful and attempted messages to help you troubleshoot and understand your messaging project. | If there was an error in sending the message, the report will show the reason for failure (missing phone number, duplicate phone number, etc.).
|
SMS Opt Out Report | Use this report to check if a contact has opted out of receiving SMS messages. If a contact has opted out, they will no longer receive any SMs messages.
| If a user/case is not receiving any SMSes from the system, it is good to double check that they did not opt-out using the SMS OPT Out Report. Users/cases can opt in by sending start to the Gateway number.
|
How Errors are Handled on SMS
Application Configuration | Mobile Behaviour |
---|---|
On the left a validation condition and message were added on the pill_count question When the beneficiary responds with an invalid response, an error message is displayed | |
In the health_status question on the left, there is no validation message even though the input expected is a numeric value Since there is no validation, the error message as shown below will be displayed until the correct value response is received by the system |
Helpful Resources for Troubleshooting
Resource Name | Link | Description |
---|---|---|
Messaging Dashboard | Helpful for understanding the messaging error log | |
Messaging Troubleshooting | Helps users troubleshoot cases were a message may not have been sent out | |
Mobile versus Web Apps | A comparison of how form questions behave on SMS Mobile and on Web Apps |