livechat.php¶

В этой статье

Методы API

livechat/delete_chat

livechat/get_chats

livechat/load_chats

livechat/save_chat

livechat/update_chat

Модуль интеграции LiveChat: управление историей чатов, сохранение данных диалогов и получение списков сообщений

Методы API¶

Метод	Действие	Описание
`delete_chat`	удаление чата	Удаляет запись о чате из базы данных по его идентификатору.
`get_chats`	получение списка чатов	Получает расширенную историю чатов с данными о посетителях и сообщениях через внешний API.
`load_chats`	загрузка чатов	Загружает список чатов по фильтрам даты и категории.
`save_chat`	сохранение чата	Создает новую запись о завершенном чате в базе данных.
`update_chat`	обновление чата	Обновляет конкретное поле в записи чата.

livechat/delete_chat¶

Удаляет запись о чате из базы данных по его идентификатору.

HTTP-метод: POST

Параметры:

action	✅	string	Идентификатор метода: `delete_chat`
token	✅	string	Токен авторизации
id	✅	integer	Идентификатор чата для удаления

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

curl -s "https://invapi.hostkey.ru/livechat.php" -X POST \
--data "action=delete_chat" \
--data "token=HOSTKEY_TOKEN" \
--data "id=VALUE"

Пример успешного ответа

{
"result": "OK"
}

Примеры ошибок

{
"-2": {
"code": -2,
"message": "livechat: invalid token"
}
}

livechat/get_chats¶

Получает расширенную историю чатов с данными о посетителях и сообщениях через внешний API.

HTTP-метод: GET

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `get_chats`
token	✅	string	Токен авторизации
date_from	✅	string	Дата начала периода получения чатов
date_to	✅	string	Дата окончания периода получения чатов
page	❌	integer	Номер страницы для пагинации результатов
author_name	✅	string	Параметр `author_name`
user_type	✅	string	Параметр `user_type`
timestamp	✅	string	Параметр `timestamp`
text	✅	string	Параметр `text`

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

curl -s "https://invapi.hostkey.ru/livechat.php" -X GET \
--data "action=get_chats" \
--data "token=HOSTKEY_TOKEN" \
--data "date_from=VALUE" \
--data "date_to=VALUE" \
--data "author_name=VALUE" \
--data "user_type=VALUE" \
--data "timestamp=VALUE" \
--data "text=VALUE"

Пример успешного ответа

{
"result": "OK",
"chats": [
{
"visitor_name": "string",
"visitor_city": "string",
"visitor_country": "string",
"agent_name": "string",
"chat_rating": "string",
"chat_url": "string",
"chat_ref": "string",
"trans": "string",
"started": 1625097600,
"id": 12345
}
]
}

Примеры ошибок

{
"-1": {
"result": "-1",
"error": "curl_livechat failed: error message OR No chats found OR errors list"
},
"-2": {
"result": "-2",
"error": "module: invalid token"
}
}

livechat/load_chats¶

Загружает список чатов по фильтрам даты и категории.

HTTP-метод: GET

Параметры:

action	✅	string	Идентификатор метода: `load_chats`
token	✅	string	Токен авторизации
date_from	❌	integer	Дата начала периода (Unix timestamp)
date_to	❌	integer	Дата окончания периода (Unix timestamp)
chat_category	❌	string	Категория чата для фильтрации
start	❌	integer	Смещение (offset) для пагинации результатов
limit	❌	integer	Количество записей для возврата в ответе

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

curl -s "https://invapi.hostkey.ru/livechat.php" -X GET \
--data "action=load_chats" \
--data "token=HOSTKEY_TOKEN"

Пример успешного ответа

{
"result": "OK",
"chats": [
{
"id": 1,
"chat_rate": "5",
"chat_comment": "Good service",
"category": "support",
"trans": "20:30 Visitor: Hello! <br>\n20:31 Agent: Hi!",
"chat_date": 1704067200,
"agent": "John Doe"
}
]
}

Примеры ошибок

{
"-1": {
"result": "-1",
"error": "No chats found"
},
"-2": {
"result": -2,
"error": "livechat: invalid token"
}
}

livechat/save_chat¶

Создает новую запись о завершенном чате в базе данных.

HTTP-метод: POST

Параметры:

action	✅	string	Идентификатор метода: `save_chat`
token	✅	string	Токен авторизации
chat_rate	❌	number	Оценка чата (рейтинг)
chat_comment	❌	string	Комментарий к чату без эмодзи
chat_category	❌	string	Категория чата
chat_trans	❌	string	Текст транскрипции без эмодзи
chat_date	❌	integer	Дата завершения чата в формате timestamp
chat_agent	❌	string	Идентификатор агента чата

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

curl -s "https://invapi.hostkey.ru/livechat.php" -X POST \
--data "action=save_chat" \
--data "token=HOSTKEY_TOKEN" \
--data "chat_rate=5" \
--data "chat_comment=Great service!" \
--data "chat_category=support" \
--data "chat_trans=Hello, I need help with my order." \
--data "chat_date=1704067200" \
--data "chat_agent=agent_001"

Пример успешного ответа

{
"result": "OK"
}

Примеры ошибок

{
"-2": {
"result": -2,
"error": "livechat: invalid token"
}
}

livechat/update_chat¶

Обновляет конкретное поле в записи чата.

HTTP-метод: POST

Параметры:

action	✅	string	Идентификатор метода: `update_chat`
token	✅	string	Токен авторизации
id	✅	integer	Идентификатор записи чата для обновления.
option	✅	string	Название поля (опции) в базе данных, которое необходимо обновить. Допустимые значения: rate, comment, category, trans.
value	✅	string	Новое значение для выбранного поля чата.

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

curl -s "https://invapi.hostkey.ru/livechat.php" -X POST \
--data "action=update_chat" \
--data "token=HOSTKEY_TOKEN" \
--data "id=123" \
--data "option=rate" \
--data "value=5"

Пример успешного ответа

{
"result": "OK"
}

Примеры ошибок

{
"code": -2,
"message": "livechat: invalid token"
}