Skip to main content

Create chat

Creates a new chat based on the field structure

Function CreateChat(Val URL, Val ChatStructure, Val Token = "") Export

ParameterCLI optionTypeRequiredDescription
URL--urlString✔URL of webhook or a Bitrix24 domain, when token used
ChatStructure--fieldsStructure Of KeyAndValue✔Chat fields structure. See GetChatStructure
Token--tokenString✖Access token, when app auth method used

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


tip

Method at API documentation: im.chat.add


1C:Enterprise/OneScript code example
    Image = "https://hut.openintegrations.dev/test_data/picture.jpg";
    OPI_TypeConversion.GetBinaryData(Image);

    B64Image = GetBase64StringFromBinaryData(Image);

    MembersArray = New Array;
    MembersArray.Add(10);
    MembersArray.Add(1);

    ChatStructure = New Structure;
    ChatStructure.Insert("TYPE"       , "OPEN");
    ChatStructure.Insert("TITLE"      , "New chat");
    ChatStructure.Insert("DESCRIPTION", "This is a new chat");
    ChatStructure.Insert("COLOR"      , "GREEN");
    ChatStructure.Insert("MESSAGE"    , "Welcome to new chat");
    ChatStructure.Insert("USERS"      , MembersArray);
    ChatStructure.Insert("AVATAR"     , B64Image);
    ChatStructure.Insert("OWNER_ID"   , 1);

    URL = "https://b24-ar17wx.bitrix24.by/rest/1/h0m...";

    Result = OPI_Bitrix24.CreateChat(URL, ChatStructure);

    URL   = "b24-ar17wx.bitrix24.by";
    Token = "75d8c668006e9f06006b12e400000001000...";

    ChatStructure = New Structure;
    ChatStructure.Insert("TYPE" , "CHAT");
    ChatStructure.Insert("TITLE", "Private chat");
    ChatStructure.Insert("USERS", MembersArray);

    Result = OPI_Bitrix24.CreateChat(URL, ChatStructure, Token);
    oint bitrix24 CreateChat \
     --url ""b24-ar17wx.bitrix24.by"" \
     --fields ""/tmp/3tcehvfu.fxk.json"" \
     --token "***"
Result
{
 "result": 3102,
 "time": {
  "start": 1757976743.02991,
  "finish": 1757976743.15509,
  "duration": 0.125181913375854,
  "processing": 0.092663049697876,
  "date_start": "2025-09-15T22:52:23+00:00",
  "date_finish": "2025-09-15T22:52:23+00:00",
  "operating_reset_at": 1757977343,
  "operating": 0
 }
}