Импорт чатов

Авторизация

Тип авторизации — Basic (API Key).

При вызове методов интеграционного API через хедер Authorization передается значение Basic {credentials}, где credentials — это ключ доступа к TQM, полученный в личном кабинете.

Пример значения, которое нужно передать — Basic UuMlW1BUJzVsUM7Q.

Описание метода

Метод позволяет загружать чаты.

Чат должен появиться в системе и стать доступным для поиска в течение 15 минут.

• URL запроса — https://tqm-cloud.tbank.ru/integration

• Метод запроса — POST /import/chat

Запрос

Параметр			Тип	Обязательность	Описание
id			string / null	true	Внешний ID чата, не больше 64 символов.
startDate			string (date-time)	true	Дата начала чата, не больше текущей даты. Дата должна передаваться в формате 2023-09-25T11:00:00 без указания часового пояса.
endDate			string (date-time)	true	Дата окончания чата, не больше текущей даты, не меньше start_date. Дата должна передаваться в формате 2023-09-25T11:00:00 без указания часового пояса.
source			string / null	false	Источник чата, не больше 200 символов.
chatLink			string / null	false	Ссылка на чат во внешней системе, не больше 2000 символов.
result			string / null	false	Результат звонка, не больше 200 символов.
transcription			SmeChatTranscription	true	Текстовая расшифровка чата.
	messages		SmeChatMessage / null	true	Сообщения в SME-чате.
		id	string / null	true	ID сообщения, не больше 64 символов.
		type	SmeChatMessageType	true	Тип сообщения: text — текстовое сообщение; info — служебное сообщение; note — заметка оператора; file — приложен файл.
		authorType	SmeChatMessageAuthorType	true	Тип автора сообщения: system — система; bot — бот; operator — оператор; client — клиент.
		authorId	string / null	false true, если authorType имеет значение operator или client	ID автора сообщения, не больше 50 символов.
		data	string / null	false	Данные сообщения, не больше 4000 символов.
		createdAt	string (date-time)	true	Дата создания сообщения, не больше текущей даты. Дата должна передаваться в формате 2023—09-25T11:00:00 без указания часового пояса.
languageCode			SmeLanguageCode	false	Код языка: ru — русский; en — английский.

Ответ

Код ответа	Значение	Описание
200	OK	Успешная обработка.
400	Bad Request	Ошибка валидации.
401	Unauthorized	Ошибка авторизации.
403	Forbidden	Ошибка доступа к материалу.
500	Internal Server Error	Внутренняя ошибка сервера. При возникновении ошибки 500 данные в TQM не попадают и не сохраняются.

При ошибке 500 коммуникация не поступает в систему из-за внутреннего сбоя.

TQM не сможет восстановить коммуникацию — чтобы она не была утеряна, обратитесь в техническую поддержку. Для упрощения поиска причины ошибки в обращении укажите заголовок ответа x-correlation-id.

Когда поддержка ответит, что проблема решена, повторно вызовите метод для коммуникаций, которые не удалось импортировать.