Get instance settings structure
Gets the structure template for instance settings
- Parameters
- Advanced call ?
Function GetInstanceSettingsStructure(Val Clear = False) Export
| Parameter | CLI option | Type | Required | Description |
|---|---|---|---|---|
| Clear | --empty | Boolean | ✖ | True > structure with empty valuse, False > field descriptions at values |
Returns
Structure Of KeyAndValue - Structure of instance settings
| Parameter | Description |
|---|---|
| dontwait | Creates a background job and returns its data (for 1C and OneScript only) |
1C:Enterprise/OneScript code example
Result = OPI_GreenAPI.GetInstanceSettingsStructure();
- Bash
- CMD/Bat
oint greenapi GetInstanceSettingsStructure \
--empty true
oint greenapi GetInstanceSettingsStructure ^
--empty true
Result
{
"webhookUrl": "<URL for notification sending>",
"webhookUrlToken": "***",
"delaySendMessagesMilliseconds": "<message sending interval in milliseconds>",
"markIncomingMessagesReaded": "<mark incoming messages as read: yes, no>",
"markIncomingMessagesReadedOnReply": "<mark incoming messages as read when sending a message to chat: yes, no>",
"outgoingWebhook": "<receive notifications about the send/deliver/read status of outgoing messages: yes, no>",
"outgoingMessageWebhook": "<receive notifications of messages sent from phone: yes, no>",
"outgoingAPIMessageWebhook": "***",
"stateWebhook": "<receive notifications about changes in the authorization state of the instance: yes, no>",
"incomingWebhook": "<receive notifications of incoming messages and files: yes, no>",
"deviceWebhook": "<receive notifications about the device (phone) and battery level: yes, no>",
"keepOnlineStatus": "<sets the 'Online' status for your account>",
"pollMessageWebhook": "<receive notifications when a poll is created and voted on: yes, no>",
"incomingBlockWebhook": "<receive notifications when a chat is added to the blocked contacts list: yes, no>",
"incomingCallWebhook": "<receive notifications about incoming call statuses: yes, no>",
"editedMessageWebhook": "<to be notified when a message has been edited: yes, no>",
"deletedMessageWebhook": "<receive notifications when a message has been deleted: yes, no>"
}