Delete message

Deletes a dialog message

Function DeleteMessage(Val URL, Val MessageID, Val Token = "") Export

Parameter	CLI option	Type	Required	Description
URL	--url	String	✔	URL of webhook or a Bitrix24 domain, when token used
MessageID	--message	String, Number	✔	ID of the message to be deleted
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.message.delete

1C:Enterprise/OneScript code example

    URL       = "https://b24-ar17wx.bitrix24.by/rest/1/1o2...";
    MessageID = "19864";

    Result = OPI_Bitrix24.DeleteMessage(URL, MessageID);

    URL       = "b24-ar17wx.bitrix24.by";
    Token     = "35c31667006e9f06006b12e400000001000...";
    MessageID = "19866";

    Result = OPI_Bitrix24.DeleteMessage(URL, MessageID, Token);

Bash

    oint bitrix24 DeleteMessage \
     --url "b24-ar17wx.bitrix24.by" \
     --message 21360 \
     --token "***"

CMD/Bat

    oint bitrix24 DeleteMessage ^
     --url "b24-ar17wx.bitrix24.by" ^
     --message 21360 ^
     --token "***"

Result

{
 "result": true,
 "time": {
  "start": 1728454910.86292,
  "finish": 1728454910.9161,
  "duration": 0.0531799793243408,
  "processing": 0.0238890647888184,
  "date_start": "2024-10-09T09:21:50+03:00",
  "date_finish": "2024-10-09T09:21:50+03:00",
  "operating_reset_at": 1728455510,
  "operating": 0
 }
}