Notification Component
:icons:font :hardbreaks: :imagesdir: ../../../assets/images :toc-title: Contents :toc:
Description
Sends a message to the specified recipient. This may include placing a message in the script engine log file.
For a system user, a notification is a websocket message from the server over an existing websocket connection. In particular, the Script Editor web application displays notifications in the form of pop-up messages, which is convenient to use when debugging a script while writing. A comma-separated list of users can be specified as recipients: their logins, identifiers, logins of associated SIP user accounts or their numbers. :description2: Notification can send SIP NOTIFY requests to SIP user devices with a message placed in the request body according to the SIP protocol.
Index |
|
Short name |
|
Script types |
|
Start module |
|
Mode |
Asynchronous |
Icon |
|
Branching type |
Branching, closing |
Properties
| Specification | Description |
|---|---|
Name: Mode Code: Visibility condition: no Default: Log log |
Possible options:
|
Name: Text Code: Visibility condition: yes Default: — |
Message text for Notification and Log modes. |
Name: User Code: Visibility condition: yes Default: — |
An argument specifying a user or a list of users, separated by commas. Login, ID, login or number of the linked SIP account. For Notification mode. |
Name: Save Code: Visibility condition: yes Default: no |
Toggle the mode of saving notifications in the data model. When enabled, the notification will be available in the Account application and in the '/rest/v1/model/platform/notifications/Notifications' collection. Requires a product layer installed on the domain. For Notification mode. |
Name: Display type Code: Visibility condition: yes Default: Auto |
Display method in the user interface. Generates an additional option in a websocket message. Possible options:
For Notification mode. |
Name: Notification type
Code: Default: Info |
Notification formatting. Possible options:
For Notification mode |
Name: Background color Code: Visibility condition: yes Default: — |
Custom background color as a number corresponding to the RGB 24bit representation. For Notification mode. |
Name: Text color Code: Visibility condition: yes Default: — |
Custom text color as a number corresponding to the RGB 24bit representation. For Notification mode. |
Name: Group Code: Visibility condition: yes Default: — |
Message group code for automatic hiding when duplicated. The app that displays the notification should automatically hide the on-screen message when a new message arrives with the same group code. For Notification mode. |
Name: Auto-hide, with Code: Visibility condition: yes Default: — |
The interval after which the notification should disappear from the screen if the user has not performed any action on it. For Notification mode. |
Name: Duplicate to log Code: Visibility condition: yes Default: No |
Switch on additional logging of messages to the script processor log. For Notification mode. |
Name: Message
Code: Default: |
Method of the SIP request sent. Possible options:
For Notification mode. |
Name: User
Code: Default: — |
Destination in the format For SIP Message mode. |
Name: Additional headers Code: Visibility condition: yes Default: `` |
Additional headers inserted into the SIP request. The argument contains a multi-line value, the format of each line is For SIP Message mode. |
Name: Visibility condition: yes Default: — |
The value to be inserted into the sent SIP request for the From header. For SIP Message mode. |
Name: Default: — |
Value for the Event header inserted into the sent SIP request NOTIFY. For SIP Message mode. |
Name: Visibility condition: yes Default: — |
The value to be inserted into the sent SIP request for the Content-Type header. For SIP Message mode. |
Name: Visibility condition: yes Default: — |
Message text inserted into the body of the sent SIP request. For SIP Message mode. |
Name: Wait for confirmation
Code: Default: No |
Switch for waiting for a SIP response to a sent SIP request. For SIP Message mode. |
Name: Report to variable Code: Visibility condition: yes Default: — |
Variable for storing the body of the SIP response to the sent SIP request. For SIP Message mode. |
Name: Time, s Code: Visibility condition: yes Default: |
Timeout for waiting for a response to a sent SIP request, in seconds. For SIP Message mode. |
Name: Transition, time Code: Visibility condition: yes Default: — |
The component to which control is transferred if, in standby mode, a response to the sent SIP request is not received at the specified time. For SIP Message mode. |
Name: Cause of error in variable Code: Visibility condition: yes Default: — |
Variable for storing the error code. |
Name: Transition Code: Visibility condition: no Default: — |
Component to which control is transferred. |
Name: Transition, error Code: Visibility condition: yes Default: — |
Component to which control is transferred in case of an error. |