1
0
mirror of https://github.com/Bayselonarrend/OpenIntegrations.git synced 2025-06-02 23:27:50 +02:00
OpenIntegrations/docs/en/md/Bitrix24/Notifications-managment/Create-system-notification.md
2024-10-15 09:53:37 +03:00

2.2 KiB

sidebar_position
sidebar_position
2

Create system notification

Creates a system notification to the user

Function CreateSystemNotification(Val URL, Val UserID, Val Text, Val Tag = "", Val Attachments = "", Val Token = "") Export

Parameter CLI option Type Description
URL --url String URL of webhook or a Bitrix24 domain, when token used
UserID --user String, Number User ID for sending the notification
Text --text String Notification text
Tag --tag String Uniqueness Tag. If already exist, other notif. will be deleted
Attachments --blocks Array of Structure Array of attachments
Token --token String Access token, when app auth method used

Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API


:::tip Method at API documentation: im.notify.system.add :::

    UserID = 1;

    URL   = "https://b24-ar17wx.bitrix24.by/rest/1/1o2...";
    Text  = "Message text";
    Image = "https://raw.githubusercontent.com/Bayselonarrend/OpenIntegrations/main/service/test_data/picture.jpg";
    File  = "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/document.docx";

    Attachments = New Array;
    Attachments.Add(OPI_Bitrix24.GetPictureBlock("Image1"  , Image));
    Attachments.Add(OPI_Bitrix24.GetFileBlock("File1.docx" , File));

    Result = OPI_Bitrix24.CreateSystemNotification(URL, UserID, Text, ,Attachments);

    URL    = "b24-ar17wx.bitrix24.by";
    Token  = "49e20867006e9f06006b12e400000001000...";
    Tag    = "New";
    UserID = 10;

    Result = OPI_Bitrix24.CreateSystemNotification(URL, UserID, Text, Tag, , Token);
{
 "result": 17770,
 "time": {
  "start": 1728454921.63299,
  "finish": 1728454921.69824,
  "duration": 0.0652530193328857,
  "processing": 0.0368680953979492,
  "date_start": "2024-10-09T09:22:01+03:00",
  "date_finish": "2024-10-09T09:22:01+03:00",
  "operating_reset_at": 1728455521,
  "operating": 0
 }
}