Get instance settings

Gets the current instance settings

Parameters

Function GetInstanceSettings(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

Advanced call ?

Parameter	Description
proxy	InternetProxy or a structure with fields Protocol, Host, Port, User, Password, UseOSAuthentication
timeout	Request execution timeout
adv_response	Formats the response as a complete HTTP structure with fields code, body, and headers
retries	Number of HTTP request send attempts on 5** status codes or internal client errors
dontwait	Creates a background job and returns its data (for 1C and OneScript only)

tip

Method at API documentation: GetSettings

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.GetInstanceSettings(AccessParameters);

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':'***'}"

CMD/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':'***'}"

Result

{
 "wid": "***",
 "countryInstance": "",
 "typeAccount": "",
 "webhookUrl": "",
 "webhookUrlToken": "***",
 "delaySendMessagesMilliseconds": 0,
 "markIncomingMessagesReaded": "no",
 "markIncomingMessagesReadedOnReply": "no",
 "sharedSession": "no",
 "proxyInstance": "system proxy",
 "outgoingWebhook": "no",
 "outgoingMessageWebhook": "no",
 "outgoingAPIMessageWebhook": "***",
 "incomingWebhook": "no",
 "deviceWebhook": "no",
 "statusInstanceWebhook": "no",
 "stateWebhook": "no",
 "enableMessagesHistory": "no",
 "keepOnlineStatus": "no",
 "pollMessageWebhook": "yes",
 "incomingBlockWebhook": "no",
 "incomingCallWebhook": "no",
 "outgoingCallWebhook": "no",
 "editedMessageWebhook": "yes",
 "deletedMessageWebhook": "yes",
 "linkPreview": "yes",
 "autoTyping": 0
}