User Tools

Site Tools


Differences

This shows you the differences between two versions of the page.

Link to this comparison view

send_notifications [2019/01/09 10:30] (current)
akuzmuk created
Line 1: Line 1:
 +===== Functions to send notifications =====
  
 +==== SendSMS(phone_number,​ message) ====
 +The SendSMS function sends a request to send an SMS to the number **phone_number** with the text **message**. Returns false if an error occurred and true if successful. Success does not mean delivering a message, but only success when creating a query. This function requires an Internet connection, an account in [[http://​docs.webhmi.com.ua/​introduction_to_level2 | Level2]] system and a positive balance in it. The service is paid.
 +
 +Format of **phone_number** - only digits with the country code, without spaces, brackets, plus sign. For example, "​380123456789"​.
 +
 +==== SendEmailMessage(emailAddress,​ subject, message) ====
 +
 +The SendEmailMessage function sends a request to send an e-mail to **emailAddress** with the subject of the letter **subject** and the text **message**. Returns false if an error occurred and true if successful. Success does not mean delivering a message, but only success when creating a query. This function requires an Internet connection, an account in [[http://​docs.webhmi.com.ua/​introduction_to_level2 | Level2]] system and a positive balance in it. The service is paid.
 +
 +The field **message** can contain the html-code.
 +
 +Example:
 +<code lua>
 +function main (userId)
 +    SendEmailMessage("​address@company.com", ​
 +               "​Cooler malfunction. Low oil level.", ​
 +                "<p style='​color:​ red;'>​Cooler error #12 has occurred.</​p><​p>​Низкий уровень масла.</​p>"​);​
 +end
 +</​code>​
 +
 +The function is available since WebHMI 2.7.4710 version.
 +
 +==== SendTelegramMessage(chatId,​ message) ====
 +The SendTelegramMessage function sends a message with the text **message** to the chat with Id = **chatId**. Returns 1 if an error occurred and 0 if successful. Success does not mean delivering a message, but only success when creating a query. To use this function, you must have an Internet connection, an account in the [[Introduction to Level2 | Level2]] system. The service is free.
 +To get ChatId, go to [[http://​telegram.me/​webhmibot]] on your mobile phone (by pre-installing Telegram) and start the dialog with bot webhmibot using the /start command. In response you will receive a message with a unique chatId.
 +
 +Example:
 +
 +{{ :​telegram_screenshot.png?​direct&​400 |}}
 +
 +==== SendViberMessage(chatId,​ message) ====
 +The SendViberMessage function sends a message with the text '​message'​ to the chat with Id = **chatId**. Returns 1 if an error occurred and 0 if successful. ​
 +Success does not mean delivering a message, but only success when creating a query. To use this function, you must have a working Internet connection, an account in the system [[Introduction to Level2 | Level2]] and a positive balance in this system. The service is chargeable. This feature is available starting with firmware version 2.4.4227. ​
 +To get ChatId, go to [[http://​viber.com/​webhmi]] on your mobile phone (having previously installed Viber), click 'Have a look' button.
 +
 +{{ :​viber_1.png?​direct&​400 |}}
 +
 +You will be taken to the public WebHMI account. Go to the personal messages of the public account by clicking the button at the top right.
 +
 +{{ :​viber_2.png?​direct&​400 |}}
 +
 +Write any text in the chat. In response you will receive a message with a unique chatId chat ID.
 +
 +{{ :​viber_3.png?​direct&​400 |}}

Page Tools