Create chat
Creates a new chat based on the field structure
Function CreateChat(Val URL, Val ChatStructure, Val Token = "") Export
| Parameter | CLI option | Type | Required | Description |
|---|---|---|---|---|
| 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
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 = "8a1bee68006e9f06006b12e400000001000...";
ChatStructure = New Structure;
ChatStructure.Insert("TYPE" , "CHAT");
ChatStructure.Insert("TITLE", "Private chat");
ChatStructure.Insert("USERS", MembersArray);
Result = OPI_Bitrix24.CreateChat(URL, ChatStructure, Token);
- Bash
- CMD/Bat
# JSON data can also be passed as a path to a .json file
oint bitrix24 CreateChat \
--url "b24-ar17wx.bitrix24.by" \
--fields "{'TYPE':'CHAT','TITLE':'Private chat','USERS':['10','1']}" \
--token "***"
:: JSON data can also be passed as a path to a .json file
oint bitrix24 CreateChat ^
--url "b24-ar17wx.bitrix24.by" ^
--fields "{'TYPE':'CHAT','TITLE':'Private chat','USERS':['10','1']}" ^
--token "***"
Result
{
"result": 3266,
"time": {
"start": 1760522253,
"finish": 1760522253.60064,
"duration": 0.600636959075928,
"processing": 0,
"date_start": "2025-10-15T09:57:33+00:00",
"date_finish": "2025-10-15T09:57:33+00:00",
"operating_reset_at": 1760522853,
"operating": 0.178215980529785
}
}