1
0
mirror of https://github.com/Bayselonarrend/OpenIntegrations.git synced 2024-12-16 11:38:11 +02:00
OpenIntegrations/docs/en/md/Bitrix24/Message-management/Delete-message.md

66 lines
1.5 KiB
Markdown
Raw Normal View History

---
sidebar_position: 4
---
# Delete message
Deletes a dialog message
`Function DeleteMessage(Val URL, Val MessageID, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| 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 not-webhook method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [im.message.delete](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12119)
:::
<br/>
```bsl title="Code example"
URL = FunctionParameters["Bitrix24_URL"];
MessageID = FunctionParameters["Bitrix24_ChatMessageID"];
Result = OPI_Bitrix24.DeleteMessage(URL, MessageID);
URL = FunctionParameters["Bitrix24_Domain"];
Token = FunctionParameters["Bitrix24_Token"];
MessageID = FunctionParameters["Bitrix24_UserMessageID"];
Result = OPI_Bitrix24.DeleteMessage(URL, MessageID, Token);
```
```sh title="CLI command example"
oint bitrix24 DeleteMessage --url %url% --message %message% --token %token%
```
```json title="Result"
{
"result": true,
"time": {
"start": 1720969167.77137,
"finish": 1720969167.82331,
"duration": 0.051936149597168,
"processing": 0.0215229988098145,
"date_start": "2024-07-14T14:59:27+00:00",
"date_finish": "2024-07-14T14:59:27+00:00",
"operating_reset_at": 1720969767,
"operating": 0
}
}
```