You've already forked OpenIntegrations
mirror of
https://github.com/Bayselonarrend/OpenIntegrations.git
synced 2025-12-07 23:03:08 +02:00
Main build (Jenkins)
This commit is contained in:
69
docs/en/md/GreenAPI/Message-queue/Clear-message-queue.mdx
vendored
Normal file
69
docs/en/md/GreenAPI/Message-queue/Clear-message-queue.mdx
vendored
Normal file
@@ -0,0 +1,69 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
description: Clear message queue and other functions to work with GreenAPI in the Open Integration Package, a free open-source integration library for 1C:Enterprise 8, OneScript and CLI
|
||||
keywords: [1C, 1С, 1С:Enterprise, 1С:Enterprise 8.3, API, Integration, Services, Exchange, OneScript, CLI, GreenAPI]
|
||||
---
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
# Clear message queue
|
||||
Clears the queue of messages to be sent
|
||||
|
||||
|
||||
|
||||
`Function ClearMessageQueue(Val AccessParameters) Export`
|
||||
|
||||
| Parameter | CLI option | Type | Required | Description |
|
||||
|-|-|-|-|-|
|
||||
| AccessParameters | --access | Structure Of KeyAndValue | ✔ | Access parameters. See FormAccessParameters |
|
||||
|
||||
|
||||
Returns: Map Of KeyAndValue - serialized JSON response from Green API
|
||||
|
||||
<br/>
|
||||
|
||||
:::tip
|
||||
Method at API documentation: [ClearMessagesQueue](https://green-api.com/docs/api/queues/ClearMessagesQueue/)
|
||||
:::
|
||||
<br/>
|
||||
|
||||
|
||||
```bsl title="1C:Enterprise/OneScript code example"
|
||||
ApiUrl = "https://7105.api.greenapi.com";
|
||||
MediaUrl = "https://7105.media.greenapi.com";
|
||||
IdInstance = "71051...";
|
||||
ApiTokenInstance = "425010d90e114aa6b78f0969e...";
|
||||
|
||||
AccessParameters = OPI_GreenAPI.FormAccessParameters(ApiUrl, MediaUrl, IdInstance, ApiTokenInstance);
|
||||
Result = OPI_GreenAPI.ClearMessageQueue(AccessParameters);
|
||||
```
|
||||
|
||||
|
||||
<Tabs>
|
||||
|
||||
<TabItem value="bash" label="Bash" default>
|
||||
```bash
|
||||
# JSON data can also be passed as a path to a .json file
|
||||
|
||||
oint greenapi ClearMessageQueue \
|
||||
--access "{'apiUrl':'***','mediaUrl':'https://7105.media.greenapi.com','idInstance':'7105187566','apiTokenInstance':'***'}"
|
||||
```
|
||||
</TabItem>
|
||||
|
||||
<TabItem value="bat" label="CMD/Bat" default>
|
||||
```batch
|
||||
:: JSON data can also be passed as a path to a .json file
|
||||
|
||||
oint greenapi ClearMessageQueue ^
|
||||
--access "{'apiUrl':'***','mediaUrl':'https://7105.media.greenapi.com','idInstance':'7105187566','apiTokenInstance':'***'}"
|
||||
```
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
|
||||
```json title="Result"
|
||||
{
|
||||
"isCleared": true
|
||||
}
|
||||
```
|
||||
Reference in New Issue
Block a user