Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Next »

Send Message

This operation is used to send different type of messages to users in the application. 

Current Implementation

The supported type of messages are email and alert.

In order to be able to use this operation, a user must have 'send_messages' permission.

Parameters

Base URL: /communication/send

Parameters:

NameTypeMandatoryDescription
tokenStringYesSecurity Token obtained before.
userIdStringYesThe id of the logged in user.
typeENUMNo

Possible values: ['email', 'alert'].

Default value: "email".

This parameter identifies the type of message that must be sent.

senderIdStringIf type == 'email' -> No
If type == 'alert' -> Yes 
Id of the user used as sender. For messages of type 'email', this parameter is not mandatory. In this case, the sender is set as the receiver.
receiverIdStringYesId of the user that must receive the message.
templateIdStringYesId of the template that should be used for the message.
...StringNoAll the parameters (all the previously listed and any other parameter used in the invocation of this operation) are used as variables for the selected template. The template then could have, for example, the following variables: {userId}, {type}, {username}, {doctor}, etc.
  • No labels