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://api.athenaeum.digital/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/yg2...";

    Result = OPI_Bitrix24.CreateChat(URL, ChatStructure);

    URL   = "b24-ar17wx.bitrix24.by";
    Token = "2f4e4067006e9f06006b12e400000001000...";

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

    Result = OPI_Bitrix24.CreateChat(URL, ChatStructure, 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": 988,
 "time": {
  "start": 1728454867.18514,
  "finish": 1728454867.47953,
  "duration": 0.294389009475708,
  "processing": 0.258857011795044,
  "date_start": "2024-10-09T09:21:07+03:00",
  "date_finish": "2024-10-09T09:21:07+03:00",
  "operating_reset_at": 1728455467,
  "operating": 0.258837938308716
 }
}