### Get Session Settings using Bash and CMD/Bat Source: https://en.openintegrations.dev/docs/ClickHouse/Common-methods/Get-session-settings These examples show how to invoke the GetSessionSettings command using command-line interfaces. The Bash example uses standard command syntax, while the CMD/Bat example utilizes the caret (^) for line continuation. Both examples specify the session ID, check flag, and timeout value. ```bash oint clickhouse GetSessionSettings \ --id "b3d9c6a2-5a6c-407e-85a6-eb4a72243933" \ --check true \ --timeout 120 ``` ```cmd oint clickhouse GetSessionSettings ^ --id "b3d9c6a2-5a6c-407e-85a6-eb4a72243933" ^ --check true ^ --timeout 120 ``` -------------------------------- ### Create Album using Bash Source: https://en.openintegrations.dev/docs/VK/Community-management/Create-album This example shows how to create an album via the command line using Bash. It utilizes the `oint vk CreateAlbum` command with options for title, description, and authentication parameters. JSON data can be provided directly or via a file path. ```bash # JSON data can also be passed as a path to a .json file oint vk CreateAlbum \ --title "AlbumFromAutoTest" \ --description "NewAlbumFromAutoTest" \ --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" ``` -------------------------------- ### Create Lead using Bash CLI Source: https://en.openintegrations.dev/docs/Bitrix24/Leads-management/Create-lead Provides an example of creating a lead via the command-line interface using Bash. It demonstrates passing lead fields as a JSON string and using an access token for authentication. The `--fields` parameter accepts a JSON structure, and the `--token` parameter is used for authorization. ```bash # JSON data can also be passed as a path to a .json file oint bitrix24 CreateLead \ --url "b24-ar17wx.bitrix24.by" \ --fields "{'ADDRESS':'Pushkin st., b. 10','ADDRESS_COUNTRY':'Russia','EMAIL':[{'VALUE':'yo@example.com','VALUE_TYPE':'HOME'},{'VALUE':'hi@example.com','VALUE_TYPE':'WORK'}],'NAME':'Ivan','LAST_NAME':'Ivanov','PHONE':[{'VALUE':'88005553535','VALUE_TYPE':'WORK'}],'TITLE':'MegaClient'}" \ --token "***" ``` -------------------------------- ### Get Calendar List using CLI (Bash/CMD) Source: https://en.openintegrations.dev/docs/GoogleCalendar/Calendar-list-management/Get-calendar-list These command-line examples show how to retrieve a list of calendars using the 'gcalendar GetCalendarList' command with a token. The Bash example uses backslashes for line continuation, while the CMD/Bat example uses the caret symbol. ```bash oint gcalendar GetCalendarList \ --token "***" ``` ```cmd oint gcalendar GetCalendarList ^ --token "***" ``` -------------------------------- ### Get Statistics via CLI (Bash) Source: https://en.openintegrations.dev/docs/VK/Statistics/Get-statistics This example shows how to use the `oint vk GetStatistics` command in Bash to retrieve community statistics. It requires specifying the start and end dates using `--datefrom` and `--dateto` flags, and optionally provides authorization parameters via the `--auth` flag. JSON data can also be passed as a path to a .json file. ```bash # JSON data can also be passed as a path to a .json file oint vk GetStatistics \ --datefrom "2026-02-20T00:00:00" \ --dateto "2026-02-20T23:59:59" \ --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" ``` -------------------------------- ### Get Instance Settings using Bash Source: https://en.openintegrations.dev/docs/GreenMax/Account/Get-instance-settings This example shows how to fetch instance settings using the 'oint greenmax GetInstanceSettings' command in Bash. It passes access parameters, including API URLs and tokens, as a JSON string. ```bash # JSON data can also be passed as a path to a .json file oint greenmax GetInstanceSettings \ --access "{'apiUrl':'***','mediaUrl':'https://3100.api.green-api.com/v3','idInstance':'3100309139','apiTokenInstance':'***'}" ``` -------------------------------- ### Get User Status using Bash CLI Source: https://en.openintegrations.dev/docs/Bitrix24/Chats-and-dialogs-management/Get-user-status This example shows how to use the 'oint bitrix24 GetUserStatus' command in Bash to get a user's status from Bitrix24. It requires the --url and --token parameters. The token is masked for security purposes in the example. ```bash oint bitrix24 GetUserStatus \ --url "b24-ar17wx.bitrix24.by" \ --token "***" ``` -------------------------------- ### Set Instance Settings via CLI (CMD/Bat) Source: https://en.openintegrations.dev/docs/GreenAPI/Account/Set-instance-settings This example demonstrates setting instance settings using the Green API CLI within a Windows CMD/Bat environment. Similar to the Bash example, it uses the `SetInstanceSettings` command with `--settings` and `--access` parameters. JSON data can be inline or referenced from files. Placeholder '***' is used for sensitive credentials. ```cmd :: JSON data can also be passed as a path to a .json file oint greenapi SetInstanceSettings ^ --settings "{'pollMessageWebhook':'yes','incomingBlockWebhook':'no','incomingCallWebhook':'no','editedMessageWebhook':'yes','deletedMessageWebhook':'yes','outgoingAPIMessageWebhook':'***'}" ^ --access "{'apiUrl':'***','mediaUrl':'https://7105.media.greenapi.com','idInstance':'7105187566','apiTokenInstance':'***'}" ``` -------------------------------- ### Get Chat Blocked Users CLI Example (CMD/Bat) Source: https://en.openintegrations.dev/docs/VKTeams/Chat-management/Get-chat-blocked-users Command-line interface example using CMD/Bat to call the `GetChatBlockedUsers` function. It requires the bot token and chat ID as arguments. ```bat oint vkteams GetChatBlockedUsers ^ --token "***" ^ --chatid "***" ``` -------------------------------- ### Run Project Function and CLI Options Source: https://en.openintegrations.dev/docs/Addons/Melezh/Console-Interface/Projects-setup/Run-project This snippet details the `RunProject` function used to start an integration proxy server. It outlines the parameters: `Port` (server startup port), `Project` (project filepath), and `Create` (option to create a new project). It also specifies the corresponding CLI options and data types. ```text Function RunProject(Val Port, Val Project, Val Create = False) Export Parameter| CLI option| Type| Required| Description ---|---|---|---|--- Port| --port| Number| ✔| Server startup port Project| --proj| String| ✔| Project filepath Create| --create| Boolean| ✖| Create a new project if it doesnt exist Returns: Structure Of KeyAndValue - Server shutdown result ``` -------------------------------- ### Reboot Instance using Bash Source: https://en.openintegrations.dev/docs/GreenAPI/Account/Reboot-instance This example shows how to reboot an instance using the Green API via the command line in Bash. The RebootInstance command is used with the --access option, which takes a JSON structure containing API credentials. JSON data can also be provided as a path to a .json file. ```bash # JSON data can also be passed as a path to a .json file oint greenapi RebootInstance \ --access "{'apiUrl':'***','mediaUrl':'https://7105.media.greenapi.com','idInstance':'7105187566','apiTokenInstance':'***'}" ``` -------------------------------- ### Get Chat Blocked Users CLI Example (Bash) Source: https://en.openintegrations.dev/docs/VKTeams/Chat-management/Get-chat-blocked-users Command-line interface example using Bash to call the `GetChatBlockedUsers` function. It requires the bot token and chat ID as arguments. ```bash oint vkteams GetChatBlockedUsers \ --token "***" \ --chatid "***" ``` -------------------------------- ### Create Deal using Bash CLI Source: https://en.openintegrations.dev/docs/Bitrix24/Deals-management/Create-deal Example of creating a new deal using the `oint` command-line tool in Bash. This shows how to pass deal fields as a JSON string or a file path, along with the URL and access token. ```bash # JSON data can also be passed as a path to a .json file oint bitrix24 CreateDeal \ --url "b24-ar17wx.bitrix24.by" \ --fields "{'TITLE':'Another deal','TYPE_ID':'GOODS','STAGE_ID':'NEW','COMPANY_ID':'1','CONTACT_ID':'3','OPENED':'Y','ASSIGNED_BY_ID':'1','PROBABILITY':'30','CURRENCY_ID':'USD','OPPORTUNITY':'5000','CATEGORY_ID':'5','BEGINDATE':'2024-01-01','CLOSEDATE':'2031-01-01'}" \ --token "***" ``` -------------------------------- ### Get Chat Members - CMD/Bat Source: https://en.openintegrations.dev/docs/VKTeams/Chat-management/Get-chat-members This CMD/Bat script example illustrates how to retrieve chat members using the command line. Similar to the Bash example, it requires the bot token and chat ID for authentication and identification. ```bat oint vkteams GetChatMembers ^ --token "***" ^ --chatid "***" ``` -------------------------------- ### Create Assistant Command (Bash) Source: https://en.openintegrations.dev/docs/OpenAI/Assistants/Create-assistant Provides a Bash command-line example for creating an assistant using the `oint openai CreateAssistant` command. It includes essential parameters like URL, token, model, name, and instructions. ```bash oint openai CreateAssistant \ --url "https://hut.openintegrations.dev/localai/" \ --token "***" \ --model "smolvlm-256m-instruct" \ --name "Math tutor" \ --inst "You are a personal math tutor. When asked a question, write and run Python code to answer the question." ``` -------------------------------- ### Get Object Information via CLI (Bash/CMD) Source: https://en.openintegrations.dev/docs/GoogleDrive/File-and-directory-management/Get-object-information These command-line examples show how to fetch information about a Google Drive object using the `oint gdrive GetObjectInformation` command. It requires authentication token and the object identifier. The Bash example uses backslashes for line continuation, while the CMD/Bat example uses carets. ```bash oint gdrive GetObjectInformation \ --token "***" \ --object "1T61ve0vc7hRiV8RYiMcBqR0GH3umkYDN" ``` ```cmd oint gdrive GetObjectInformation ^ --token "***" ^ --object "1T61ve0vc7hRiV8RYiMcBqR0GH3umkYDN" ``` -------------------------------- ### Get Calendar Events Filter Structure - CLI Examples (Bash, CMD/Bat) Source: https://en.openintegrations.dev/docs/Bitrix24/Calendar-events-management/Get-calendar-events-filter-structure These examples show how to call the GetCalendarEventsFilterStructure function using command-line interfaces. The '--empty true' option can be used to get a structure with empty values, as opposed to field descriptions. Supported shells include Bash and CMD/Bat. ```bash oint bitrix24 GetCalendarEventsFilterStructure \ --empty true ``` ```bat oint bitrix24 GetCalendarEventsFilterStructure ^ --empty true ``` -------------------------------- ### Create Product Selection using CMD/Bat Source: https://en.openintegrations.dev/docs/VK/Product-selection-management/Create-product-collection This example demonstrates creating a product selection using the `oint vk CreateProductCollection` command in CMD/Bat. It shows how to pass parameters like title, picture, main, hidden, and authorization details using command-line arguments. Line continuation is handled with the '^' character. JSON data can also be specified as a file path. ```bat :: JSON data can also be passed as a path to a .json file oint vk CreateProductCollection ^ --title "TestCollection" ^ --picture "https://hut.openintegrations.dev/test_data/picture.jpg" ^ --main true ^ --hidden false ^ --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" ``` -------------------------------- ### Get Image Description Structure CLI Example (Bash) Source: https://en.openintegrations.dev/docs/OpenAI/Requests-processing/Get-image-description-structure Example of using the GetImageDescriptionStructure function via the command line in a Bash environment. It demonstrates how to pass prompt, amount, and size parameters to generate an image description. ```bash oint openai GetImageDescriptionStructure \ --prompt "Yellow alpaca" \ --amount 1 \ --size "1024x1024" ``` -------------------------------- ### Get Instance Settings using Bash CLI Source: https://en.openintegrations.dev/docs/GreenAPI/Account/Get-instance-settings This example shows how to retrieve instance settings via the command line using Bash. The 'oint greenapi GetInstanceSettings' command is used with the --access parameter, which can accept a JSON string or a path to a JSON file. ```bash # JSON data can also be passed as a path to a .json file oint greenapi GetInstanceSettings \ --access "{'apiUrl':'***','mediaUrl':'https://7105.media.greenapi.com','idInstance':'7105187566','apiTokenInstance':'***'}" ``` -------------------------------- ### Create Database using Bash CLI Source: https://en.openintegrations.dev/docs/MySQL/Orm/Create-database This example shows how to create a database using the `oint mysql CreateDatabase` command in a Bash environment. It illustrates passing database name, connection string, and TLS settings as command-line arguments. JSON data can also be provided via a file path. ```bash # JSON data can also be passed as a path to a .json file oint mysql CreateDatabase \ --base "testbase2" \ --dbc "mysql://bayselonarrend:***@127.0.0.1:3306/" \ --tls "{'accept_invalid_certs':true,'ca_cert_path':'','use_tls':true}" ``` -------------------------------- ### Get Group Settings Structure (CMD/Bat) Source: https://en.openintegrations.dev/docs/GreenMax/Group-management/Get-group-settings-structure Executes the `GetGroupSettingsStructure` command using the 'oint' tool in a CMD/Bat environment. This example shows how to invoke the function with the `--empty` option set to true, similar to the Bash example. ```bat oint greenmax GetGroupSettingsStructure ^ --empty true ``` -------------------------------- ### Download File using Bash Source: https://en.openintegrations.dev/docs/OpenAI/File-management/Download-file This example shows how to download a file using the 'oint openai DownloadFile' command in Bash. It requires the server URL, authorization token, and file ID as command-line arguments. ```bash oint openai DownloadFile \ --url "https://hut.openintegrations.dev/localai/" \ --token "***" \ --id "file-12" ``` -------------------------------- ### Install Melezh from Local OSPX Files Source: https://en.openintegrations.dev/docs/Addons/Melezh/Start/Installation Installs Melezh and its dependencies from local .ospx package files using the OPM package manager. This method is useful when installing specific versions or offline installations. Ensure the correct language versions of the packages are used. ```bash opm install -f oint-x.x.x_lang.ospx opm install -f oint-cli-x.x.x_lang.ospx opm install -f melezh-x.x.x_lang.ospx ``` -------------------------------- ### Install Melezh OneScript Package Source: https://en.openintegrations.dev/docs/Addons/Melezh/Start/Installation Installs the Melezh package for OneScript using the OPM package manager. This command fetches the Russian version from the cloud package hub and automatically installs its dependencies (OInt and OInt CLI). ```bash opm install melezh ``` -------------------------------- ### Create Post with Images (Bash CLI) Source: https://en.openintegrations.dev/docs/VK/Community-management/Create-post This example shows how to create a post with text and images using the Bash command-line interface. It utilizes the 'oint vk CreatePost' command with options for text, pictures, advertisement status, URL, and authorization parameters. JSON data for parameters can also be provided as a path to a .json file. ```bash # JSON data can also be passed as a path to a .json file oint vk CreatePost \ --text "Post from autotest" \ --pictures "C:\\Users\\bayse\\AppData\\Local\\Temp\\e3xxe1qo.a25.png" \ --ad true \ --url "https://github.com/Bayselonarrend/OpenIntegrations" \ --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" ``` -------------------------------- ### Download File using Bash Source: https://en.openintegrations.dev/docs/GoogleDrive/File-and-directory-management/Download-file This example shows how to download a file using the `oint gdrive DownloadFile` command in Bash. It requires a token and the file object identifier as arguments. ```bash oint gdrive DownloadFile \ --token "***" \ --object "1t-0FS1Gboi69-71zYiWvPzmzt1PV1HUg" \ ``` -------------------------------- ### Start Timekeeping with Bash CLI Source: https://en.openintegrations.dev/docs/Bitrix24/Timekeeping/Start-timekeeping Provides a command-line example using 'oint' for starting timekeeping via Bash. It specifies the URL, UserID, Time, Report, and Token for the operation. ```bash oint bitrix24 StartTimekeeping \ --url "b24-ar17wx.bitrix24.by" \ --userid 1 \ --time "2026-02-20T12:34:28" \ --report "Late" \ --token "***" ``` -------------------------------- ### Get Cashbox Checks by Date CLI Examples (Bash/CMD) Source: https://en.openintegrations.dev/docs/CDEK/Common-methods/Get-cashbox-checks-by-date These examples show how to call the GetCashboxChecksByDate function using the command-line interface. One example uses Bash syntax with backslashes for line continuation, and the other uses CMD/Bat syntax with carets for line continuation. Both require a token, date, and optionally a test API flag. ```bash oint cdek GetCashboxChecksByDate \ --token "***" \ --date "2026-02-20T13:44:40" \ --testapi "***" ``` ```cmd oint cdek GetCashboxChecksByDate ^ --token "***" ^ --date "2026-02-20T13:44:40" ^ --testapi "***" ``` -------------------------------- ### Install OSPX Package using OPM Source: https://en.openintegrations.dev/docs/Start/Build-from-source Installs a built .ospx package into the local OneScript package directory. This command requires the path to the generated .ospx file. ```bash opm install -f ``` -------------------------------- ### Set Instance Settings via CLI (Bash) Source: https://en.openintegrations.dev/docs/GreenAPI/Account/Set-instance-settings This example shows how to set instance settings using the Green API CLI in a Bash environment. It utilizes the `SetInstanceSettings` command with `--settings` and `--access` flags, where JSON data can be provided directly as strings or as paths to `.json` files. Sensitive information like API tokens are represented by '***'. ```bash # JSON data can also be passed as a path to a .json file oint greenapi SetInstanceSettings \ --settings "{'pollMessageWebhook':'yes','incomingBlockWebhook':'no','incomingCallWebhook':'no','editedMessageWebhook':'yes','deletedMessageWebhook':'yes','outgoingAPIMessageWebhook':'***'}" \ --access "{'apiUrl':'***','mediaUrl':'https://7105.media.greenapi.com','idInstance':'7105187566','apiTokenInstance':'***'}" ``` -------------------------------- ### Get Image Description Structure CLI Example (CMD/Bat) Source: https://en.openintegrations.dev/docs/OpenAI/Requests-processing/Get-image-description-structure Example of using the GetImageDescriptionStructure function via the command line in a CMD/Bat environment. It shows how to pass prompt, amount, and size parameters using caret (^) for line continuation. ```bat oint openai GetImageDescriptionStructure ^ --prompt "Yellow alpaca" ^ --amount 1 ^ --size "1024x1024" ``` -------------------------------- ### Get Instance Status using CMD/Bat CLI Source: https://en.openintegrations.dev/docs/GreenAPI/Account/Get-instance-status This example demonstrates how to retrieve the instance status using the command prompt (CMD/Bat). It uses the 'oint greenapi' command, similar to the Bash example, and accepts access parameters in a JSON format. ```bat :: JSON data can also be passed as a path to a .json file oint greenapi GetInstanceStatus ^ --access "{'apiUrl':'***','mediaUrl':'https://7105.greenapi.com','idInstance':'7105187566','apiTokenInstance':'***'}" ``` -------------------------------- ### Create Story from Image (Bash) Source: https://en.openintegrations.dev/docs/VK/Community-management/Create-story This example shows how to create a story using the `oint vk CreateStory` command in Bash. It illustrates passing the image path and authorization parameters as command-line arguments. JSON data for parameters can be provided directly or as a path to a .json file. ```bash # JSON data can also be passed as a path to a .json file oint vk CreateStory \ --picture "C:\\Users\\bayse\\AppData\\Local\\Temp\\bdyps0ot.vj1.png" \ --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" ``` -------------------------------- ### Get Settings with Private Key Authentication (Bash) Source: https://en.openintegrations.dev/docs/SFTP/Common-methods/Get-settings-private-key This command-line example demonstrates how to retrieve SFTP connection settings using private key authentication via the 'oint sftp' utility. It specifies the host, port, username, private key path, and public key path. This is useful for scripting SFTP connections. ```bash oint sftp GetSettingsPrivateKey \ --host "172.33.0.13" \ --port "2222" \ --user "bayselonarrend" \ --key "***" \ --pub "https://hut.openintegrations.dev/test_data/ssh_key.pub" ``` -------------------------------- ### Get Authorization Code using CMD/Bat Source: https://en.openintegrations.dev/docs/GreenAPI/Account/Get-authorization-code Provides an example of invoking the GetAuthorizationCode function via a CMD/Bat script. Similar to the Bash example, it illustrates passing parameters and the phone number, supporting JSON data input via a file. ```cmd :: JSON data can also be passed as a path to a .json file oint greenapi GetAuthorizationCode ^ --access "{'apiUrl':'***','mediaUrl':'https://7105.media.greenapi.com','idInstance':'7105187566','apiTokenInstance':'***'}" ^ --phone 441234567890 ``` -------------------------------- ### Get User Info with CMD/Bat Source: https://en.openintegrations.dev/docs/Bitrix24/Users-management/Get-user This example demonstrates how to invoke the 'oint bitrix24 GetUser' command in CMD/Bat to fetch user details. Similar to the Bash example, it utilizes --url, --userid, and --token arguments, with the token value being a placeholder. ```cmd oint bitrix24 GetUser ^ --url "b24-ar17wx.bitrix24.by" ^ --userid 3388 ^ --token "***" ``` -------------------------------- ### Get Instance Settings using CMD/Bat CLI Source: https://en.openintegrations.dev/docs/GreenAPI/Account/Get-instance-settings This example demonstrates retrieving instance settings from the command line using CMD/Bat. The 'oint greenapi GetInstanceSettings' command is utilized with the --access parameter, which can be provided as a JSON string or a file path. ```bat :: JSON data can also be passed as a path to a .json file oint greenapi GetInstanceSettings ^ --access "{'apiUrl':'***','mediaUrl':'https://7105.media.greenapi.com','idInstance':'7105187566','apiTokenInstance':'***'}" ``` -------------------------------- ### Create Product Selection using Bash Source: https://en.openintegrations.dev/docs/VK/Product-selection-management/Create-product-collection This example shows how to create a product selection using the `oint vk CreateProductCollection` command in Bash. It illustrates passing parameters such as title, picture URL, main status, hidden status, and authorization details via command-line arguments. JSON data can also be provided as a file path. ```bash # JSON data can also be passed as a path to a .json file oint vk CreateProductCollection \ --title "TestCollection" \ --picture "https://hut.openintegrations.dev/test_data/picture.jpg" \ --main true \ --hidden false \ --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" ``` -------------------------------- ### Start Timekeeping with CMD/Bat CLI Source: https://en.openintegrations.dev/docs/Bitrix24/Timekeeping/Start-timekeeping Illustrates how to start timekeeping using the 'oint' command in a Windows CMD/Bat environment. This example includes essential parameters like URL, UserID, Time, Report, and Token. ```bat oint bitrix24 StartTimekeeping ^ --url "b24-ar17wx.bitrix24.by" ^ --userid 1 ^ --time "2026-02-20T12:34:28" ^ --report "Late" ^ --token "***" ``` -------------------------------- ### Example Authorization Link Output Source: https://en.openintegrations.dev/docs/Twitter/Data-and-settings/Get-authorization-link Provides an example of the URL string returned by the GetAuthorizationLink function, which is used to initiate the browser-based authorization flow. ```text "https://twitter.com/i/oauth2/authorize?response_type=code&client_id=dFBPVWVadDZzeTZMeUNZaEd4Y086MTpjaQ&redirect_uri=https://hut.openintegrations.dev/melezh/6ad91cc8b&scope=tweet.read%20tweet.write%20tweet.moderate.write%20users.read%20follows.read%20follows.write%20offline.access%20space.read%20mute.read%20mute.write%20like.read%20like.write%20list.read%20list.write%20block.read%20block.write%20bookmark.read%20bookmark.write&state=state&code_challenge=challenge&code_challenge_method=plain" ``` -------------------------------- ### Create Lead using CMD/Bat CLI Source: https://en.openintegrations.dev/docs/Bitrix24/Leads-management/Create-lead Illustrates how to create a lead using the command-line interface in a CMD/Bat environment. Similar to the Bash example, it shows passing lead fields as a JSON string and utilizing an access token. The command uses caret (`^`) for line continuation. ```cmd :: JSON data can also be passed as a path to a .json file oint bitrix24 CreateLead ^ --url "b24-ar17wx.bitrix24.by" ^ --fields "{'ADDRESS':'Pushkin st., b. 10','ADDRESS_COUNTRY':'Russia','EMAIL':[{'VALUE':'yo@example.com','VALUE_TYPE':'HOME'},{'VALUE':'hi@example.com','VALUE_TYPE':'WORK'}],'NAME':'Ivan','LAST_NAME':'Ivanov','PHONE':[{'VALUE':'88005553535','VALUE_TYPE':'WORK'}],'TITLE':'MegaClient'}" ^ --token "***" ``` -------------------------------- ### Get Channel User List (Bash) Source: https://en.openintegrations.dev/docs/Slack/Channel-management/Get-channel-user-list Command-line interface example for getting a list of users in a Slack channel using the 'oint slack GetChannelUserList' command. Requires a bot token and channel ID. ```bash oint slack GetChannelUserList \ --token "***" \ --channel "C0AG8MWLKGC" ``` -------------------------------- ### Create Deal using CMD/Bat CLI Source: https://en.openintegrations.dev/docs/Bitrix24/Deals-management/Create-deal Example of creating a new deal using the `oint` command-line tool in CMD/Bat. This demonstrates passing deal fields as a JSON string or a file path, along with the URL and access token, using caret for line continuation. ```bat :: JSON data can also be passed as a path to a .json file oint bitrix24 CreateDeal ^ --url "b24-ar17wx.bitrix24.by" ^ --fields "{'TITLE':'Another deal','TYPE_ID':'GOODS','STAGE_ID':'NEW','COMPANY_ID':'1','CONTACT_ID':'3','OPENED':'Y','ASSIGNED_BY_ID':'1','PROBABILITY':'30','CURRENCY_ID':'USD','OPPORTUNITY':'5000','CATEGORY_ID':'5','BEGINDATE':'2024-01-01','CLOSEDATE':'2031-01-01'}" ^ --token "***" ``` -------------------------------- ### Get Authorization Code using 1C:Enterprise/OneScript Source: https://en.openintegrations.dev/docs/GreenAPI/Account/Get-authorization-code Example of how to use the GetAuthorizationCode function in 1C:Enterprise/OneScript. It demonstrates setting up API credentials, formatting access parameters, and calling the function to get an authorization code. ```1c ApiUrl = "https://7105.api.greenapi.com"; MediaUrl = "https://7105.media.greenapi.com"; IdInstance = "71051..."; ApiTokenInstance = "425010d90e114aa6b78f0969e..."; PhoneNumber = 441234567890; AccessParameters = OPI_GreenAPI.FormAccessParameters(ApiUrl, MediaUrl, IdInstance, ApiTokenInstance); Result = OPI_GreenAPI.GetAuthorizationCode(AccessParameters, PhoneNumber); ``` -------------------------------- ### Create Lead using 1C:Enterprise/OneScript Source: https://en.openintegrations.dev/docs/Bitrix24/Leads-management/Create-lead Demonstrates creating a lead with detailed contact and address information using the 1C:Enterprise/OneScript language. It shows how to construct the `FieldsStructure` including nested arrays for emails and phones, and how to call the `CreateLead` function with both webhook URL and Bitrix24 domain with token authentication. ```1c EmailsArray = New Array; EmailsArray.Add(New Structure("VALUE,VALUE_TYPE", "yo@example.com", "HOME")); EmailsArray.Add(New Structure("VALUE,VALUE_TYPE", "hi@example.com", "WORK")); PhonesArray = New Array; PhonesArray.Add(New Structure("VALUE,VALUE_TYPE", "88005553535", "WORK")); FieldsStructure = New Structure; FieldsStructure.Insert("ADDRESS" , "Pushkin st., b. 10"); FieldsStructure.Insert("ADDRESS_COUNTRY", "Russia"); FieldsStructure.Insert("EMAIL" , EmailsArray); FieldsStructure.Insert("NAME" , "John"); FieldsStructure.Insert("LAST_NAME" , "Doe"); FieldsStructure.Insert("PHONE" , PhonesArray); FieldsStructure.Insert("TITLE" , "MegaClient"); URL = "https://b24-ar17wx.bitrix24.by/rest/1/av5..."; Result = OPI_Bitrix24.CreateLead(URL, FieldsStructure); FieldsStructure.Insert("NAME" , "Ivan"); FieldsStructure.Insert("LAST_NAME", "Ivanov"); URL = "b24-ar17wx.bitrix24.by"; Token = "a5b00469006e9f06006b12e400000001000..."; Result = OPI_Bitrix24.CreateLead(URL, FieldsStructure, Token); ``` -------------------------------- ### Get Daily Plan using CMD/Bat CLI Source: https://en.openintegrations.dev/docs/Bitrix24/Tasks-management/Get-daily-plan This example demonstrates how to call the `GetDailyPlan` function via the command-line interface (CLI) using CMD/Bat scripts. It requires the Bitrix24 domain URL and an access token, similar to the Bash example. The function returns the API response. ```bat oint bitrix24 GetDailyPlan ^ --url "b24-ar17wx.bitrix24.by" ^ --token "***" ``` -------------------------------- ### Reboot Instance using CMD/Bat Source: https://en.openintegrations.dev/docs/GreenAPI/Account/Reboot-instance This example demonstrates how to reboot an instance using the Green API from the command line in CMD/Bat. The RebootInstance command is executed with the --access parameter, which accepts a JSON object with the necessary authentication details. The command also supports passing JSON data via a file path. ```bat :: JSON data can also be passed as a path to a .json file oint greenapi RebootInstance ^ --access "{'apiUrl':'***','mediaUrl':'https://7105.media.greenapi.com','idInstance':'7105187566','apiTokenInstance':'***'}" ``` -------------------------------- ### Get Online Users Status (Bash) Source: https://en.openintegrations.dev/docs/Viber/Settings-and-information/Get-online-users A command-line interface example to get the online status of users. It uses the 'oint viber GetOnlineUsers' command with token and user ID parameters. The output is a JSON response. ```bash oint viber GetOnlineUsers \ --token "***" \ --users "tMNGhftyUPrB3r1lD+bT4g==" ``` -------------------------------- ### Create Story from Image (CMD/Bat) Source: https://en.openintegrations.dev/docs/VK/Community-management/Create-story This example demonstrates how to create a story using the `oint vk CreateStory` command in CMD/Bat. It shows how to pass the image path and authorization parameters using command-line arguments. JSON data can be supplied directly or via a .json file path. ```bat :: JSON data can also be passed as a path to a .json file oint vk CreateStory ^ --picture "C:\\Users\\bayse\\AppData\\Local\\Temp\\bdyps0ot.vj1.png" ^ --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" ``` -------------------------------- ### Download File using CMD/Bat Source: https://en.openintegrations.dev/docs/OpenAI/File-management/Download-file This example demonstrates downloading a file using the 'oint openai DownloadFile' command in CMD/Bat. It requires the server URL, authorization token, and file ID specified as command-line arguments. ```bat oint openai DownloadFile ^ --url "https://hut.openintegrations.dev/localai/" ^ --token "***" ^ --id "file-12" ``` -------------------------------- ### Get Slack Channel Info (Bash) Source: https://en.openintegrations.dev/docs/Slack/Channel-management/Get-channel This example shows how to get Slack channel information using the `oint slack GetChannel` command in Bash. It requires a bot token and a channel ID, which are passed as command-line arguments. ```bash oint slack GetChannel \ --token "***" \ --channel "C0AG8MWLKGC" ``` -------------------------------- ### Download File in Bash and CMD/Bat Source: https://en.openintegrations.dev/docs/Dropbox/File-and-directory-management/Download-file These code snippets demonstrate how to download a file using Bash and CMD/Bat. They require a token for authentication and the path of the file. The examples use the 'oint dropbox DownloadFile' command with the --token and --path options. ```Bash oint dropbox DownloadFile \ --token "***" \ --path "/New/pic.png" ``` ```CMD/Bat oint dropbox DownloadFile ^ --token "***" ^ --path "/New/pic.png" ``` -------------------------------- ### CLI Usage Source: https://en.openintegrations.dev/docs/GRPC/Common-methods/Get-connection-parameters Command-line interface examples for using the GetConnectionParameters function. ```APIDOC ## CLI Usage ### Description Command-line interface examples for using the GetConnectionParameters function. ### Bash Example ```bash oint grpc GetConnectionParameters \ --addr "https://grpcb.in:9001" \ --proto "{'main.proto':'https://hut.openintegrations.dev/test_data/grpcbin_with_import.proto','my_types.proto':'https://hut.openintegrations.dev/test_data/mt.proto'}" ``` ### CMD/Bat Example ```bat :: JSON data can also be passed as a path to a .json file oint grpc GetConnectionParameters ^\ --addr "https://grpcb.in:9001" ^\ --proto "{'main.proto':'https://hut.openintegrations.dev/test_data/grpcbin_with_import.proto','my_types.proto':'https://hut.openintegrations.dev/test_data/mt.proto'}" ``` ``` -------------------------------- ### Create Model using Bash CLI Source: https://en.openintegrations.dev/docs/Ollama/Models-management/Create-model This example shows how to create a model via the command line using the 'oint ollama CreateModel' command in Bash. It accepts the server URL, model name, settings, and headers as arguments, with settings and headers provided as JSON strings or paths to JSON files. ```bash # JSON data can also be passed as a path to a .json file oint ollama CreateModel \ --url "https://hut.openintegrations.dev/ollama" \ --model "mario" \ --settings "{'from':'tinyllama','system':'You are Mario from Super Mario Bros.'}" \ --headers "{'Authorization':'***'}" ``` -------------------------------- ### Get Products by ID using CMD/Bat CLI Source: https://en.openintegrations.dev/docs/VK/Product-management/Get-products-by-id Command-line interface example using CMD/Bat to retrieve product information by ID. Similar to the Bash example, it utilizes `--items` for product IDs and `--auth` for authentication parameters. The caret symbol (^) is used for line continuation in CMD/Bat scripts. ```bat :: JSON data can also be passed as a path to a .json file oint vk GetProductsByID ^ --items "['12677732','12677734']" ^ --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" ``` -------------------------------- ### Get Deals List with Bash Source: https://en.openintegrations.dev/docs/Bitrix24/Deals-management/Get-deals-list Retrieves a list of deals from Bitrix24 via the command line using the `oint` utility. This example demonstrates how to pass URL, filter criteria, and an access token as command-line arguments. JSON filter data can also be provided via a file path. ```bash # JSON data can also be passed as a path to a .json file oint bitrix24 GetDealsList \ --url "b24-ar17wx.bitrix24.by" \ --filter "{'TITLE':'Sale in RUB','CURRENCY_ID':'RUB'}" \ --token "***" ``` -------------------------------- ### Get Collection List in 1C:Enterprise/OneScript Source: https://en.openintegrations.dev/docs/MongoDB/Collection-management/Get-collection-list Example of using OPI_MongoDB.GetCollectionList to retrieve a list of collections from a MongoDB database. Requires connection parameters and optionally a database name. ```1c Address = "127.0.0.1:1234"; Login = "bayselonarrend"; Password = "12we..."; ConnectionParams = New Structure("authSource", "admin"); ConnectionString = OPI_MongoDB.GenerateConnectionString(Address, , Login, Password, ConnectionParams); Connection = OPI_MongoDB.CreateConnection(ConnectionString); Base = "test_database"; Result = OPI_MongoDB.GetCollectionList(Connection, Base); ``` -------------------------------- ### Create Bucket using Bash CLI Source: https://en.openintegrations.dev/docs/S3/Buckets-management/Create-bucket Example of creating a new S3 bucket using the 'oint s3 CreateBucket' command in Bash. It shows how to pass bucket name, basic data, and directory style as arguments. ```bash # JSON data can also be passed as a path to a .json file oint s3 CreateBucket \ --name "42625bab" \ --basic "{'URL':'s3.openintegrations.dev','AccessKey':'***','SecretKey':'***','Region':'BTC','Service':'s3'}" \ --dir true ```