deleteVisitor

Удаляет посетителя со всеми данными: переписку окна, журнал этого чата в Gratio, его уведомления — и ждущие в очереди, и доставленные, — и файлы. Окно на его устройстве перестаёт писать в этот чат сразу. Нужен, когда посетитель просит удалить его данные.

Параметры

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

Удалить посетителя:

curl

curl -X POST "$GRATIO_URL/v1/instances/$GRATIO_ID/deleteVisitor" \
  -H "Authorization: Bearer $GRATIO_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{"chatId": "vq3k7m2x4a6b2c4d6e7f2g3h4"}'

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}/deleteVisitor"
payload = {"chatId": "vq3k7m2x4a6b2c4d6e7f2g3h4"}
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}/deleteVisitor`;
const payload = { chatId: "vq3k7m2x4a6b2c4d6e7f2g3h4" };
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 . '/deleteVisitor';
$payload = ['chatId' => 'vq3k7m2x4a6b2c4d6e7f2g3h4'];

$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 — сколько чего удалено:

{
  "deleted": true,
  "chatId": "vq3k7m2x4a6b2c4d6e7f2g3h4",
  "visitor": 1,
  "messages": 14,
  "outbound": 6,
  "reactions": 1,
  "history": 14,
  "events": 21,
  "notifications": 20,
  "files": 2
}

Что происходит

• Посетитель больше не может писать с этого устройства: окно начнёт новый чат с новым chatId.
• Журнал согласий только дописывается: в нём остаётся строка об отзыве согласия, а прежние записи не меняются.
• Данные у вас — в вашей CRM, базе, подписках — Gratio не трогает: удалите их сами.
• Выгрузить данные перед удалением — exportVisitor.

Ошибки

Общие правила — в статье Ответы и ошибки.

Что дальше

• exportVisitor — выгрузить данные посетителя.
• Настройки окна — сколько хранить переписку: siteRetentionDays.