OpenIntegrations/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Create-chat.md

sidebar_position
1

Create chat

Creates a new chat based on the field structure

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

Parameter	CLI option	Type	Destination
URL	--url	String	URL of webhook or a Bitrix24 domain, when token used
ChatStructure	--fields	Structure of KeyAndValue	Chat fields structure. See GetChatStructure
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.chat.add :::

 Image = "https://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/f2pph8uucc89is6c/";
 
 Result = OPI_Bitrix24.CreateChat(URL, ChatStructure);
 
 URL = "b24-ar17wx.bitrix24.by";
 Token = "fe3fa966006e9f06006b12e400000001000...";
 
 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 %url% --fields %fields% --token %token%

{
 "result": 26,
 "time": {
 "start": 1720816597.42171,
 "finish": 1720816597.52933,
 "duration": 0.107618093490601,
 "processing": 0.081672191619873,
 "date_start": "2024-07-12T20:36:37+00:00",
 "date_finish": "2024-07-12T20:36:37+00:00",
 "operating_reset_at": 1720817197,
 "operating": 0
 }
}