Skip to main content

Импорт звонков

Авторизация

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

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

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

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

Метод для загрузки звонков. Требования к аудиофайлам:

  • Стерео формат — в одном канале оператор, в другом — клиент.

  • Качество записи — не меньше 32 Кб/c, желательно 64 Кб/с.

  • Размер — не больше 32 Мб. Это нужно для корректного распознавания текста.

  • Формат — MP3 или PCM-WAV.

    • PCM-WAV впоследствии конвертируется в MP3 — его размер не должен превышать 32 Мб после конвертации.
    • Размер исходного файла в PCM-WAV не должен превышать 100 Мб, максимальная длительность записи — не больше одного часа.

Звонок должен появиться в системе и стать доступным для поиска в течение 15 минут, расшифровка и речевой поиск — в течение часа.

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

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

Запрос

ПараметрТипОбязательность Описание
IdstringtrueВнешний ID звонка, не больше 32 символов.
CallDirectionstringtrue

Направление звонков:

  • inbound — входящий;
  • outbound — исходящий.
StartDatestringtrueДата начала звонка, не больше текущей даты.

Дата должна передаваться в формате 2023-09-25T11:00:00 без указания часового пояса.
EndDatestringtrueДата окончания звонка, не больше текущей даты, не меньше start_date.

Дата должна передаваться в формате 2023-09-25T11:00:00 без указания часового пояса.
HangupPartystringtrue

Сторона, положившая трубку в коммуникации:

  • client — клиент;
  • operator — оператор;
  • server — тех. проблемы;
  • error — ошибка;
  • timeout — превышено время ожидания.
OperatorIdstringtrueID оператора, не больше 50 символов.
OperatorChannelstringtrue

Канал оператора:

  • left — левый;
  • right — правый.
ClientPhoneNumberstringtrueТелефон клиента, не больше 50 символов.
ReasonstringfalseПричина звонка, не больше 200 символов.
ResultstringfalseРезультат звонка, не больше 200 символов.
FileLinkstringtrueСсылка на файл, не больше 2000 символов.
LanguageCodestringfalse

Язык разговора:

  • ru — русский;
  • en — английский.
TaskTypestringfalseТип задания, не больше 200 символов.

Ответ

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

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

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

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


openapi@tbank.ru

АО «ТБанк» использует файлы «cookie» с целью персонализации сервисов и повышения удобства пользования веб-сайтом. «Cookie» представляют собой небольшие файлы, содержащие информацию о предыдущих посещениях веб-сайта. Если вы не хотите использовать файлы «cookie», измените настройки браузера.