exportVisitor

Выгружает всё, что Gratio хранит о посетителе: карточку, всю переписку в обе стороны и журнал согласий с текстами тех версий, на которые он соглашался. Нужен, когда посетитель просит выдать его данные.

Параметры

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

Выгрузка посетителя в файл:

curl

curl -X POST "$GRATIO_URL/v1/instances/$GRATIO_ID/exportVisitor" \
  -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}/exportVisitor"
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}/exportVisitor`;
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 . '/exportVisitor';
$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, сокращён — у настоящего посетителя событий больше:

{
  "exportedAt": 1791910000,
  "visitor": {"chatId": "vq3k7m2x4a6b2c4d6e7f2g3h4", "ref": "G-7K4MXQ", "name": "Мария", "ipKey": "203.0.113.24"},
  "events": [
    {"seq": 1, "direction": "in", "kind": "message", "messageId": "i3f2b9c0a8e7d4c1b2a3f4e5d6c7b8a90", "body": {"kind": "text", "text": "Сколько стоит пробное?"}, "createdAt": 1791823658},
    {"seq": 2, "direction": "out", "kind": "message", "messageId": "o2b7e41c09d8f3a6b5c4d2e1f0a9b8c", "body": {"text": "Пробное занятие бесплатное.", "author": {"kind": "assistant", "name": "Алина"}}, "createdAt": 1791823671}
  ],
  "consents": [
    {"kind": "notice", "version": "n3f1c0a9b2d4e6f70", "at": 1791823658, "withdrawn": false, "messageId": "i3f2b9c0a8e7d4c1b2a3f4e5d6c7b8a90", "page": "https://school.ru/prices", "ip": "203.0.113.24", "userAgent": "Mozilla/5.0 …"}
  ],
  "consentTexts": {
    "n3f1c0a9b2d4e6f70": {"text": "Отправляя сообщения в этот чат, вы принимаете политику обработки персональных данных", "policyUrl": "https://school.ru/privacy", "createdAt": 1791800000}
  }
}

Поля ответа

Ошибки

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

Что дальше

• deleteVisitor — удалить посетителя со всеми данными.
• getVisitor — карточка посетителя.