Skip to main content

Set instance settings

Sets the instance settings

Function SetInstanceSettings(Val Settings, Val AccessParameters) Export

ParameterCLI optionTypeRequiredDescription
Settings--settingsStructure Of KeyAndValue✔Instance settings. See GetInstanceSettingsStructure
AccessParameters--accessStructure Of KeyAndValue✔Access parameters. See FormAccessParameters

Returns: Map Of KeyAndValue - serialized JSON response from Green API


tip

Method at API documentation: SetSettings


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);

    SettingsStructure = New Structure;
    SettingsStructure.Insert("pollMessageWebhook"       , "yes");
    SettingsStructure.Insert("incomingBlockWebhook"     , "no");
    SettingsStructure.Insert("incomingCallWebhook"      , "no");
    SettingsStructure.Insert("editedMessageWebhook"     , "yes");
    SettingsStructure.Insert("deletedMessageWebhook"    , "yes");
    SettingsStructure.Insert("outgoingAPIMessageWebhook", "yes");

    Result = OPI_GreenAPI.SetInstanceSettings(SettingsStructure, AccessParameters);
    # 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'}" \
     --access "{'apiUrl':'***','mediaUrl':'https://7105.media.greenapi.com','idInstance':'7105187566','apiTokenInstance':'***'}"