Перейти к содержимому

getSettings

Обновлено 17 октября 2026

Содержание
  1. Пример запроса
  2. Пример ответа
  3. Поля ответа
  4. Особенности каналов
  5. Что дальше

Возвращает настройки канала: адрес вебхука, токен для него и флаги уведомлений. Заодно — номер канала и площадку. Gratio отвечает сразу, без запроса к мессенджеру.
Запрос GET /waInstance{idInstance}/getSettings/{apiTokenInstance}
Тело нет
Каналы MAX, Telegram, WhatsApp, почта

Пример запроса

Прочитать настройки канала:

curl

curl "$GRATIO_URL/waInstance$GRATIO_ID/getSettings/$GRATIO_TOKEN"

Python

import os
import requests

BASE = f"{os.environ['GRATIO_URL']}/waInstance{os.environ['GRATIO_ID']}"
TOKEN = os.environ["GRATIO_TOKEN"]

url = f"{BASE}/getSettings/{TOKEN}"
response = requests.get(url, timeout=60)
print(response.status_code, response.json())

Node.js

const { GRATIO_URL, GRATIO_ID, GRATIO_TOKEN } = process.env;
const base = `${GRATIO_URL}/waInstance${GRATIO_ID}`;

const url = `${base}/getSettings/${GRATIO_TOKEN}`;
const response = await fetch(url);
console.log(response.status, await response.json());

PHP

<?php
$base = getenv('GRATIO_URL') . '/waInstance' . getenv('GRATIO_ID');
$url = $base . '/getSettings/' . getenv('GRATIO_TOKEN');

$ch = curl_init($url);
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_TIMEOUT => 90,
]);
$response = json_decode(curl_exec($ch), true);
echo curl_getinfo($ch, CURLINFO_HTTP_CODE), PHP_EOL;
print_r($response);

Пример ответа

Ответ 200 OK для канала MAX с вебхуком:

{
  "wid": "79990000001@c.us",
  "typeInstance": "v3",
  "channel": "max",
  "webhookUrl": "https://example.ru/gratio/hook",
  "webhookUrlToken": "s3cr3t-hook-token",
  "incomingWebhook": "yes",
  "outgoingWebhook": "yes",
  "outgoingMessageWebhook": "yes",
  "outgoingAPIMessageWebhook": "yes",
  "stateWebhook": "yes",
  "incomingCallWebhook": "yes",
  "groupEventsWebhook": "yes"
}

Поля ответа

Поле Тип Описание
wid string номер канала: 79990000001@c.us; у почты — адрес ящика. Пусто, пока номер не привязан
typeInstance string v3 у MAX (как у Green API), telegram, whatsapp, email
channel string площадка: max, telegram, whatsapp, email
webhookUrl string адрес вебхука; пусто — уведомления ждут в очереди, забирайте их receiveNotification
webhookUrlToken string токен, который Gratio передаёт вашему вебхуку в Authorization: Bearer …
incomingWebhook … groupEventsWebhook string флаги уведомлений, "yes" или "no". Что включает каждый — в статье setSettings

Новый канал: webhookUrl и webhookUrlToken пустые, все флаги — "yes".

Особенности каналов

Почта. В ответе — ещё настройки ящика с префиксом email. Значения по умолчанию:

{
  "wid": "info@school.ru", "typeInstance": "email", "channel": "email",
  "webhookUrl": "", "webhookUrlToken": "",
  "incomingWebhook": "yes", "outgoingWebhook": "yes", "outgoingMessageWebhook": "yes",
  "outgoingAPIMessageWebhook": "yes", "stateWebhook": "yes", "incomingCallWebhook": "yes",
  "groupEventsWebhook": "yes",
  "emailFromName": "", "emailSignature": "", "emailSubject": "", "emailReplyAll": "no",
  "emailQuote": "yes", "emailHtml": "yes", "emailSkipBulk": "no", "emailFolders": "inbox,sent",
  "emailAliases": "", "emailForms": []
}

Что значит каждая — в статье Настройки ящика.

Что дальше

Была ли статья полезна?

Похожие статьи