Page Comparison

project

string

Reference project to send notifications. This allows the app to store data in a different data persistence tool.

Supported values:

• LAC-FP

• LAC-HIV

clientId

string

Could be:

• ID associated to a DHIS2 TrackedEntityInstance.

• _id associated to a mongoDB client document.

msg

string

Message to be linked to the notification.

channel

string

Way of communication where the scheduled message will be sent:

Current supported values:

• facebook

• whatsapp

• SMS

to

string

Identifier used by the specified channel to send the message.

templateID

string

Identifier used by the specified channel to use a pre-defined template.

templateParams

string

Parameters to be used in the template specified.

notificationDate

string

Date on which the notification will be sent.

status

cancelled | sent | scheduled | error | unsent

Current status of the notification.

• Cancelled: Cancelled by the cancel endpoint

• Sent: Sent to the user successfully.

• Scheduled: Pending to be sent.

• Error: Try to send the notification, but an error occurs.

• repliedReplied: the client replied using one of the included quick replies of the original notification

• Unsent: Try to send the notification, but client does not consent to receive messages.