2025-03-13 20:28:06 +03:00
|
|
|
---
|
|
|
|
|
sidebar_position: 2
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
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);
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
2025-05-01 20:09:27 +03:00
|
|
|
<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>
|
2025-03-13 20:28:06 +03:00
|
|
|
|
|
|
|
|
|
2025-03-18 10:00:47 +03:00
|
|
|
```json title="Result"
|
|
|
|
|
{
|
|
|
|
|
"isCleared": true
|
|
|
|
|
}
|
|
|
|
|
```
|