GetSettings#
Метод предназначен для получения текущих настроек инстанса.
Для метода используются ограничения на частоту запросов в секунду.
Запрос#
Для получения текущих настроек инстанса требуется выполнить запрос по адресу:
 GET    
 {{apiUrl}}/v3/waInstance{{idInstance}}/getSettings/{{apiTokenInstance}}
Для получения параметров запроса apiUrl, idInstance и apiTokenInstance обратитесь к разделу Перед началом работы.
Ответ#
Поля ответа#
| Поле | Тип | Описание | 
|---|---|---|
wid |  string | Идентификатор аккаунта | 
typeInstance |  string | Версия интерфейса. Поле принимает значение v3 для мессенджера MAX и whatsapp - для мессенджера WhatsApp |  
webhookUrl |  string | Адрес отправки уведомлений (URL). При получении уведомлений технологией HTTP API, поле должно быть пустым. Описание работы поля. | 
webhookUrlToken |  string | Заголовок авторизации для отправки уведомлений. Описание работы поля. | 
delaySendMessagesMilliseconds |  integer | Интервал отправки сообщений в миллисекундах | 
markIncomingMessagesReaded |  string | Временно не работает. Отмечать входящие сообщения прочитанными, возможные значения: yes, no. Игнорируется, если markIncomingMessagesReadedOnReply в значении 'yes'. |  
markIncomingMessagesReadedOnReply |  string | Временно не работает. Отмечать входящие сообщения прочитанными при отправке сообщения через API, возможные значения: yes, no. Если в значении 'yes', то настройка markIncomingMessagesReaded игнорируется. |  
outgoingWebhook |  string | Получать уведомления о статусах отправленных сообщений, возможные значения: yes, no. |  
outgoingMessageWebhook |  string | Получать уведомления о сообщениях, отправленных с телефона, web версии и desktop версии, возможные значения: yes, no |  
outgoingAPIMessageWebhook |  string | Получать уведомления о сообщениях, отправленных через API, возможные значения: yes, no. При отправке сообщения на несуществующий аккаунт MAX, уведомление не придет. |  
stateWebhook |  string | Нет | 
incomingWebhook |  string | Получать уведомления о входящих сообщениях и файлах, возможные значения: yes, no |  
Применение настроек
Для получения уведомлений о статусах отправки/доставки/прочтении сообщений, отправленных с телефона требуется включить настройки:
outgoingMessageWebhookoutgoingWebhook
Пример тела ответа#
{
    "wid": "79991234567@c.us",
    "typeInstance": "v3",
    "webhookUrl": "",
    "webhookUrlToken": "",
    "delaySendMessagesMilliseconds": 0,
    "markIncomingMessagesReaded": "no",
    "markIncomingMessagesReadedOnReply": "no",
    "outgoingWebhook": "yes",
    "outgoingMessageWebhook": "yes",
    "outgoingAPIMessageWebhook": "yes",
    "stateWebhook": "yes",
    "incomingWebhook": "yes",
}
Ошибки GetSettings#
Перечень общих для всех методов ошибок смотрите в разделе Стандартные ошибки
Примеры кода#
import requests
url = "{{apiUrl}}/v3/waInstance{{idInstance}}/getSettings/{{apiTokenInstance}}"
payload = {}
headers= {}
response = requests.request("GET", url, headers=headers, data = payload)
print(response.text.encode('utf8'))
<?php
//The apiUrl, idInstance and apiTokenInstance values are available in console, double brackets must be removed
$url = "{{apiUrl}}/v3/waInstance{{idInstance}}/getSettings/{{apiTokenInstance}}";
$options = array(
    'http' => array(
        'header' => "Content-Type: application/json\r\n",
        'method' => 'GET'
    )
);
$context = stream_context_create($options);
$response = file_get_contents($url, false, $context);
echo $response;
?>
curl --location '{{apiUrl}}/v3/waInstance{{idInstance}}/getSettings/{{apiTokenInstance}}'
var restTemplate = new RestTemplate();
var requestUrl = new StringBuilder();
requestUrl
    .append({{apiUrl}})
    .append("/v3/waInstance").append({{idInstance}})
    .append("/getSettings/")
    .append({{apiTokenInstance}});
var response = restTemplate.exchange(requestUrl.toString(), HttpMethod.GET, null, String.class);
System.out.println(response);
var requestUrl = new StringBuilder();
requestUrl
    .append({{apiUrl}})
    .append("/v3/waInstance").append({{idInstance}})
    .append("/getSettings/")
    .append({{apiTokenInstance}});
var response = Unirest.get(requestUrl.toString())
    .header("Content-Type", "application/json")
    .asString();
System.out.println(response);
Sub GetSettings()
    Dim url As String
    Dim http As Object
    Dim response As String
    ' The apiUrl, idInstance and apiTokenInstance values are available in console, double brackets must be removed
    url = "{{apiUrl}}/v3/waInstance{{idInstance}}/getSettings/{{apiTokenInstance}}"
    Set http = CreateObject("WinHttp.WinHttpRequest.5.1")
    http.Open "GET", url, False
    http.Send
    response = http.responseText
    Debug.Print response
    ' Outputting the answer to the desired cell
    ' Range("A1").Value = response
    Set http = Nothing
End Sub
program GetSettings;
{$APPTYPE CONSOLE}
uses
System.SysUtils,
System.Classes, System.Net.HttpClient, System.Net.URLClient, System.Net.HttpClientComponent;
var
HttpClient: TNetHTTPClient;
RequestHeaders: TNetHeaders;
Response: IHTTPResponse;
EndpointURL, ID_INSTANCE, API_TOKEN_INSTANCE: string;
begin
ID_INSTANCE := '110100001';
API_TOKEN_INSTANCE := 'd75b3a66374942c5b3c019c698abc2067e151558acbd451234';
EndpointURL := 'https://api.green-api.com/v3/waInstance' + ID_INSTANCE + '/getSettings/' + API_TOKEN_INSTANCE;
HttpClient := TNetHTTPClient.Create(nil);
RequestHeaders := [
    TNetHeader.Create('Content-Type', 'application/json')
];
try
    Response := HTTPClient.Get(EndpointURL, nil, RequestHeaders);
    if Response.StatusCode = 200 then
    Writeln('[Response]: ' + Response.ContentAsString)
    else
    Writeln('[ERROR ' + IntToStr(Response.StatusCode) + ']:' + Response.StatusText + '' + Response.ContentAsString);
    readln;
except
    on E: Exception do
    Writeln(E.ClassName, ': ', E.Message);
end;
HttpClient.Free;
end.