Настройки окна

Чат на сайте настраивается тем же методом setSettings, что и другие каналы, — ключами site…. Те же настройки есть в кабинете, в карточке канала. Текущие значения со всеми умолчаниями возвращает getSettings.

Настройки доходят до окна за секунды: окно берёт их при открытии. Кнопку чата сайты кешируют до 2 минут.

Пример

Название, цвет, кнопка с подписью слева, часы работы:

curl

curl -X POST "$GRATIO_URL/v1/instances/$GRATIO_ID/setSettings" \
  -H "Authorization: Bearer $GRATIO_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
    "siteTitle": "Школа робототехники",
    "siteColor": "#F4513C",
    "sitePosition": "left",
    "siteLauncher": "label",
    "siteLauncherText": "Задать вопрос",
    "siteHours": {
      "timezone": "Europe/Moscow",
      "mon": [
        [
          "09:00",
          "18:00"
        ]
      ],
      "tue": [
        [
          "09:00",
          "18:00"
        ]
      ],
      "wed": [
        [
          "09:00",
          "18:00"
        ]
      ],
      "thu": [
        [
          "09:00",
          "18:00"
        ]
      ],
      "fri": [
        [
          "09:00",
          "18:00"
        ]
      ],
      "sat": [
        [
          "10:00",
          "15:00"
        ]
      ]
    }
  }'

Python

import os
import requests

BASE = f"{os.environ['GRATIO_URL']}/v1/instances/{os.environ['GRATIO_ID']}"
HEADERS = {"Authorization": f"Bearer {os.environ['GRATIO_TOKEN']}"}

url = f"{BASE}/setSettings"
payload = {
    "siteTitle": "Школа робототехники",
    "siteColor": "#F4513C",
    "sitePosition": "left",
    "siteLauncher": "label",
    "siteLauncherText": "Задать вопрос",
    "siteHours": {
        "timezone": "Europe/Moscow",
        "mon": [["09:00", "18:00"]],
        "tue": [["09:00", "18:00"]],
        "wed": [["09:00", "18:00"]],
        "thu": [["09:00", "18:00"]],
        "fri": [["09:00", "18:00"]],
        "sat": [["10:00", "15:00"]],
    },
}
response = requests.post(url, json=payload, headers=HEADERS, timeout=60)
print(response.status_code, response.json())

Node.js

const { GRATIO_URL, GRATIO_ID, GRATIO_TOKEN } = process.env;
const base = `${GRATIO_URL}/v1/instances/${GRATIO_ID}`;
const auth = { Authorization: `Bearer ${GRATIO_TOKEN}` };

const url = `${base}/setSettings`;
const payload = {
  siteTitle: "Школа робототехники",
  siteColor: "#F4513C",
  sitePosition: "left",
  siteLauncher: "label",
  siteLauncherText: "Задать вопрос",
  siteHours: {
    timezone: "Europe/Moscow",
    mon: [["09:00", "18:00"]],
    tue: [["09:00", "18:00"]],
    wed: [["09:00", "18:00"]],
    thu: [["09:00", "18:00"]],
    fri: [["09:00", "18:00"]],
    sat: [["10:00", "15:00"]],
  },
};
const response = await fetch(url, {
  method: "POST",
  headers: { ...auth, "Content-Type": "application/json" },
  body: JSON.stringify(payload),
});
console.log(response.status, await response.json());

PHP

<?php
$base = getenv('GRATIO_URL') . '/v1/instances/' . getenv('GRATIO_ID');
$auth = 'Authorization: Bearer ' . getenv('GRATIO_TOKEN');
$url = $base . '/setSettings';
$payload = [
    'siteTitle' => 'Школа робототехники',
    'siteColor' => '#F4513C',
    'sitePosition' => 'left',
    'siteLauncher' => 'label',
    'siteLauncherText' => 'Задать вопрос',
    'siteHours' => [
        'timezone' => 'Europe/Moscow',
        'mon' => [['09:00', '18:00']],
        'tue' => [['09:00', '18:00']],
        'wed' => [['09:00', '18:00']],
        'thu' => [['09:00', '18:00']],
        'fri' => [['09:00', '18:00']],
        'sat' => [['10:00', '15:00']],
    ],
];

$ch = curl_init($url);
curl_setopt_array($ch, [
    CURLOPT_POST => true,
    CURLOPT_HTTPHEADER => [$auth, 'Content-Type: application/json'],
    CURLOPT_POSTFIELDS => json_encode($payload, JSON_UNESCAPED_UNICODE),
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_TIMEOUT => 60,
]);
$response = json_decode(curl_exec($ch), true);
echo curl_getinfo($ch, CURLINFO_HTTP_CODE), PHP_EOL;
print_r($response);

Ответ 200 OK:

{"saveSettings": true}

Где стоит чат

Как выглядит

Тексты

Часы и срок ответа

Мессенджеры

siteMessengers — кнопки «Другие способы связи» в окне и мессенджеры формы контакта, до 8, по порядку:

[
  {"channel": "max", "url": "https://max.ru/…"},
  {"channel": "telegram", "username": "robo_school"},
  {"channel": "vk", "group": "robo_school"},
  {"channel": "whatsapp", "phone": "79990000001"},
  {"channel": "phone", "phone": "79990000001"}
]

У Telegram вместо username можно указать bot.

Согласие

• notice документа не требует. Слова «политику обработки персональных данных» в строке — ссылка на sitePolicyUrl, без неё — на текст siteConsentText; без обоих — строка без ссылки, с названием компании.
• contact и chat — режимы с галочкой — требуют siteConsentText и sitePolicyUrl. Запрос, который ставит такой режим без документа или стирает документ при таком режиме, — 400.
• Журнал согласий. При notice Gratio пишет «уведомление принято» с первой репликой посетителя и с каждой формой с телефоном или почтой. Версия — n и 16 знаков отпечатка строки, текста и адреса политики. Сменили текст или политику — новая версия, при галочке посетители отмечают её заново.
• Согласие приходит в уведомлениях — поле consent в Реплика с сайта и Ответ формой, журнал посетителя — в getVisitor.

Аналитика и хранение

В целях нет персональных данных: ни текстов, ни полей форм.

Как проверяются значения

• Неверное значение — 400 validation с именем ключа: «Неверная настройка — siteColor: …».
• Неизвестный ключ site… — тоже 400.
• Ключи site… есть только у канала «Чат на сайте».

Что дальше

• JS API окна на сайте — открыть окно со страницы, передать данные посетителя.
• Чат на сайте через API — методы канала.
• setSettings — общие настройки уведомлений и вебхука.