1
0
mirror of https://github.com/Bayselonarrend/OpenIntegrations.git synced 2025-11-23 22:05:15 +02:00

Main build (Jenkins)

This commit is contained in:
Vitaly the Alpaca (bot)
2025-10-18 14:55:14 +03:00
parent 08a78c3049
commit 4282f57c7d
118 changed files with 12475 additions and 9388 deletions

View File

@@ -0,0 +1,39 @@
---
sidebar_position: 11
description: Check account and other functions to work with Green Max 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, Green Max]
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
# Check account
Checks the existence of a Max account by phone number
`Function CheckAccount(Val AccessParameters, Val PhoneNumber, Val IgnoreCache = False) Export`
| Parameter | CLI option | Type | Required | Description |
|-|-|-|-|-|
| AccessParameters | --access | Structure Of KeyAndValue | ✔ | Access parameters. See FormAccessParameters |
| PhoneNumber | --phone | String, Number | ✔ | Phone number for verification without + |
| IgnoreCache | --force | Boolean | ✖ | Ignore cache on repeated verification request |
Returns: Map Of KeyAndValue - serialized JSON response from Green API
<br/>
:::tip
Method at API documentation: [CheckAccount](https://green-api.com/v3/docs/api/account/CheckAccount/)
:::
<br/>

View File

@@ -0,0 +1,47 @@
---
sidebar_position: 1
description: Form access parameters and other functions to work with Green Max 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, Green Max]
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
# Form access parameters
Forms the structure of basic authorization data
`Function FormAccessParameters(Val ApiUrl, Val MediaUrl, Val IdInstance, Val ApiTokenInstance) Export`
| Parameter | CLI option | Type | Required | Description |
|-|-|-|-|-|
| ApiUrl | --api | String | &#x2714; | API host link |
| MediaUrl | --media | String | &#x2714; | Link to host API for sending files |
| IdInstance | --id | String | &#x2714; | Unique instance number |
| ApiTokenInstance | --token | String | &#x2714; | Instance access key |
Returns: Structure - Structure of access parameters
<br/>
:::tip
More details in the API documentation: [Get access parameters to instance](https://green-api.com/v3/docs/before-start/#parameters)
:::
<br/>
```bsl title="1C:Enterprise/OneScript code example"
ApiUrl = "https://3100.api.green-api.com/v3";
MediaUrl = "https://3100.api.green-api.com/v3";
IdInstance = "31003...";
ApiTokenInstance = "17915d8e0b4b4975a183478da...";
Result = OPI_GreenMax.FormAccessParameters(ApiUrl, MediaUrl, IdInstance, ApiTokenInstance);
```

View File

@@ -0,0 +1,45 @@
---
sidebar_position: 2
description: Get account information and other functions to work with Green Max 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, Green Max]
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
# Get account information
Gets account information
`Function GetAccountInformation(Val AccessParameters) Export`
| Parameter | CLI option | Type | Required | Description |
|-|-|-|-|-|
| AccessParameters | --access | Structure Of KeyAndValue | &#x2714; | Access parameters. See FormAccessParameters |
Returns: Map Of KeyAndValue - serialized JSON response from Green API
<br/>
:::tip
Method at API documentation: [GetWaSettings](https://green-api.com/v3/docs/api/account/GetAccountSettings/)
:::
<br/>
```bsl title="1C:Enterprise/OneScript code example"
ApiUrl = "https://3100.api.green-api.com/v3";
MediaUrl = "https://3100.api.green-api.com/v3";
IdInstance = "31003...";
ApiTokenInstance = "17915d8e0b4b4975a183478da...";
AccessParameters = OPI_GreenMax.FormAccessParameters(ApiUrl, MediaUrl, IdInstance, ApiTokenInstance);
Result = OPI_GreenMax.GetAccountInformation(AccessParameters);
```

View File

@@ -0,0 +1,48 @@
---
sidebar_position: 5
description: Get authorization code and other functions to work with Green Max 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, Green Max]
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
# Get authorization code
Sends an SMS to the specified number to obtain a confirmation code
`Function GetAuthorizationCode(Val AccessParameters, Val PhoneNumber) Export`
| Parameter | CLI option | Type | Required | Description |
|-|-|-|-|-|
| AccessParameters | --access | Structure Of KeyAndValue | &#x2714; | Access parameters. See FormAccessParameters |
| PhoneNumber | --phone | String, Number | &#x2714; | Phone number without + |
Returns: Map Of KeyAndValue - serialized JSON response from Green API
<br/>
:::tip
Method at API documentation: [StartAuthorization](https://green-api.com/v3/docs/api/account/StartAuthorization/)
:::
<br/>
```bsl title="1C:Enterprise/OneScript code example"
ApiUrl = "https://3100.api.green-api.com/v3";
MediaUrl = "https://3100.api.green-api.com/v3";
IdInstance = "31003...";
ApiTokenInstance = "17915d8e0b4b4975a183478da...";
PhoneNumber = 441234567890;
AccessParameters = OPI_GreenMax.FormAccessParameters(ApiUrl, MediaUrl, IdInstance, ApiTokenInstance);
Result = OPI_GreenMax.GetAuthorizationCode(AccessParameters, PhoneNumber);
```

View File

@@ -0,0 +1,35 @@
---
sidebar_position: 12
description: Get instance settings structure and other functions to work with Green Max 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, Green Max]
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
# Get instance settings structure
Gets the structure template for instance settings
`Function GetInstanceSettingsStructure(Val Clear = False) Export`
| Parameter | CLI option | Type | Required | Description |
|-|-|-|-|-|
| Clear | --empty | Boolean | &#x2716; | True > structure with empty valuse, False > field descriptions at values |
Returns: Structure Of KeyAndValue - Structure of instance settings
<br/>
```bsl title="1C:Enterprise/OneScript code example"
Result = OPI_GreenMax.GetInstanceSettingsStructure();
```

View File

@@ -0,0 +1,45 @@
---
sidebar_position: 3
description: Get instance settings and other functions to work with Green Max 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, Green Max]
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
# Get instance settings
Gets the current instance settings
`Function GetInstanceSettings(Val AccessParameters) Export`
| Parameter | CLI option | Type | Required | Description |
|-|-|-|-|-|
| AccessParameters | --access | Structure Of KeyAndValue | &#x2714; | Access parameters. See FormAccessParameters |
Returns: Map Of KeyAndValue - serialized JSON response from Green API
<br/>
:::tip
Method at API documentation: [GetSettings](https://green-api.com/v3/docs/api/account/GetSettings/)
:::
<br/>
```bsl title="1C:Enterprise/OneScript code example"
ApiUrl = "https://3100.api.green-api.com/v3";
MediaUrl = "https://3100.api.green-api.com/v3";
IdInstance = "31003...";
ApiTokenInstance = "17915d8e0b4b4975a183478da...";
AccessParameters = OPI_GreenMax.FormAccessParameters(ApiUrl, MediaUrl, IdInstance, ApiTokenInstance);
Result = OPI_GreenMax.GetInstanceSettings(AccessParameters);
```

View File

@@ -0,0 +1,45 @@
---
sidebar_position: 7
description: Get instance status and other functions to work with Green Max 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, Green Max]
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
# Get instance status
Gets instance status
`Function GetInstanceStatus(Val AccessParameters) Export`
| Parameter | CLI option | Type | Required | Description |
|-|-|-|-|-|
| AccessParameters | --access | Structure Of KeyAndValue | &#x2714; | Access parameters. See FormAccessParameters |
Returns: Map Of KeyAndValue - serialized JSON response from Green API
<br/>
:::tip
Method at API documentation: [GetStateInstance](https://green-api.com/v3/docs/api/account/GetStateInstance/)
:::
<br/>
```bsl title="1C:Enterprise/OneScript code example"
ApiUrl = "https://3100.api.green-api.com/v3";
MediaUrl = "https://3100.api.green-api.com/v3";
IdInstance = "31003...";
ApiTokenInstance = "17915d8e0b4b4975a183478da...";
AccessParameters = OPI_GreenMax.FormAccessParameters(ApiUrl, MediaUrl, IdInstance, ApiTokenInstance);
Result = OPI_GreenMax.GetInstanceStatus(AccessParameters);
```

View File

@@ -0,0 +1,45 @@
---
sidebar_position: 9
description: Logout instance and other functions to work with Green Max 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, Green Max]
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
# Logout instance
Unlogging the instance
`Function LogoutInstance(Val AccessParameters) Export`
| Parameter | CLI option | Type | Required | Description |
|-|-|-|-|-|
| AccessParameters | --access | Structure Of KeyAndValue | &#x2714; | Access parameters. See FormAccessParameters |
Returns: Map Of KeyAndValue - serialized JSON response from Green API
<br/>
:::tip
Method at API documentation: [Logout](https://green-api.com/v3/docs/api/account/Logout/)
:::
<br/>
```bsl title="1C:Enterprise/OneScript code example"
ApiUrl = "https://3100.api.green-api.com/v3";
MediaUrl = "https://3100.api.green-api.com/v3";
IdInstance = "31003...";
ApiTokenInstance = "17915d8e0b4b4975a183478da...";
AccessParameters = OPI_GreenMax.FormAccessParameters(ApiUrl, MediaUrl, IdInstance, ApiTokenInstance);
Result = OPI_GreenMax.LogoutInstance(AccessParameters);
```

View File

@@ -0,0 +1,45 @@
---
sidebar_position: 10
description: Reboot instance and other functions to work with Green Max 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, Green Max]
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
# Reboot instance
Restarts the instance
`Function RebootInstance(Val AccessParameters) Export`
| Parameter | CLI option | Type | Required | Description |
|-|-|-|-|-|
| AccessParameters | --access | Structure Of KeyAndValue | &#x2714; | Access parameters. See FormAccessParameters |
Returns: Map Of KeyAndValue - serialized JSON response from Green API
<br/>
:::tip
Method at API documentation: [Reboot](https://green-api.com/v3/docs/api/account/Reboot/)
:::
<br/>
```bsl title="1C:Enterprise/OneScript code example"
ApiUrl = "https://3100.api.green-api.com/v3";
MediaUrl = "https://3100.api.green-api.com/v3";
IdInstance = "31003...";
ApiTokenInstance = "17915d8e0b4b4975a183478da...";
AccessParameters = OPI_GreenMax.FormAccessParameters(ApiUrl, MediaUrl, IdInstance, ApiTokenInstance);
Result = OPI_GreenMax.RebootInstance(AccessParameters);
```

View File

@@ -0,0 +1,48 @@
---
sidebar_position: 6
description: Send authorization code and other functions to work with Green Max 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, Green Max]
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
# Send authorization code
Authorizes the instance using the access code from SMS
`Function SendAuthorizationCode(Val AccessParameters, Val AuthCode) Export`
| Parameter | CLI option | Type | Required | Description |
|-|-|-|-|-|
| AccessParameters | --access | Structure Of KeyAndValue | &#x2714; | Access parameters. See FormAccessParameters |
| AuthCode | --code | String | &#x2714; | Authorization code |
Returns: Map Of KeyAndValue - serialized JSON response from Green API
<br/>
:::tip
Method at API documentation: [SendAuthorizationCode](https://green-api.com/v3/docs/api/account/SendAuthorizationCode/)
:::
<br/>
```bsl title="1C:Enterprise/OneScript code example"
ApiUrl = "https://3100.api.green-api.com/v3";
MediaUrl = "https://3100.api.green-api.com/v3";
IdInstance = "31003...";
ApiTokenInstance = "17915d8e0b4b4975a183478da...";
AuthCode = 123456;
AccessParameters = OPI_GreenMax.FormAccessParameters(ApiUrl, MediaUrl, IdInstance, ApiTokenInstance);
Result = OPI_GreenMax.SendAuthorizationCode(AccessParameters, AuthCode);
```

View File

@@ -0,0 +1,52 @@
---
sidebar_position: 4
description: Set instance settings and other functions to work with Green Max 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, Green Max]
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
# Set instance settings
Sets the instance settings
`Function SetInstanceSettings(Val Settings, Val AccessParameters) Export`
| Parameter | CLI option | Type | Required | Description |
|-|-|-|-|-|
| Settings | --settings | Structure Of KeyAndValue | &#x2714; | Instance settings. See GetInstanceSettingsStructure |
| AccessParameters | --access | Structure Of KeyAndValue | &#x2714; | Access parameters. See FormAccessParameters |
Returns: Map Of KeyAndValue - serialized JSON response from Green API
<br/>
:::tip
Method at API documentation: [SetSettings](https://green-api.com/v3/docs/api/account/SetSettings/)
:::
<br/>
```bsl title="1C:Enterprise/OneScript code example"
ApiUrl = "https://3100.api.green-api.com/v3";
MediaUrl = "https://3100.api.green-api.com/v3";
IdInstance = "31003...";
ApiTokenInstance = "17915d8e0b4b4975a183478da...";
AccessParameters = OPI_GreenMax.FormAccessParameters(ApiUrl, MediaUrl, IdInstance, ApiTokenInstance);
SettingsStructure = New Structure;
SettingsStructure.Insert("markIncomingMessagesReaded" , "no");
SettingsStructure.Insert("outgoingWebhook" , "no");
SettingsStructure.Insert("outgoingAPIMessageWebhook" , "yes");
Result = OPI_GreenMax.SetInstanceSettings(SettingsStructure, AccessParameters);
```

View File

@@ -0,0 +1,50 @@
---
sidebar_position: 8
description: Set profile picture and other functions to work with Green Max 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, Green Max]
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
# Set profile picture
Sets a new profile picture
`Function SetProfilePicture(Val AccessParameters, Val Image) Export`
| Parameter | CLI option | Type | Required | Description |
|-|-|-|-|-|
| AccessParameters | --access | Structure Of KeyAndValue | &#x2714; | Access parameters. See FormAccessParameters |
| Image | --picture | BinaryData, String | &#x2714; | Profile picture |
Returns: Map Of KeyAndValue - serialized JSON response from Green API
<br/>
:::tip
Method at API documentation: [SetProfilePicture](https://green-api.com/v3/docs/api/account/SetProfilePicture/)
Parameters with Binary data type can also accept file paths on disk and URLs
:::
<br/>
```bsl title="1C:Enterprise/OneScript code example"
ApiUrl = "https://3100.api.green-api.com/v3";
MediaUrl = "https://3100.api.green-api.com/v3";
IdInstance = "31003...";
ApiTokenInstance = "17915d8e0b4b4975a183478da...";
Image = "https://hut.openintegrations.dev/test_data/picture.jpg"; // URL, Path or Binary Data
AccessParameters = OPI_GreenMax.FormAccessParameters(ApiUrl, MediaUrl, IdInstance, ApiTokenInstance);
Result = OPI_GreenMax.SetProfilePicture(AccessParameters, Image);
```

View File

@@ -0,0 +1,4 @@
{
"label": "Account",
"position": "2"
}