Обработать письмо

/api/internal/v1/mails/incoming

POST

https://secured-openapi.tbank.ru/api/internal/v1/mails/incoming

Метод для обработки входящих в банк писем от компаний.

Авторизация

Security

Bearer API Token

MTLS-сертификат

RPS

Ограничение — 20 запросов в секунду

Scopes

Обработка входящих писем → Метод отправки письма через TMail

Запрос

Header parameters

Required

Signature

String

Криптографическая подпись с данными в формате Signature keyId="",algorithm="",[headers=""],signature="", где:

• keyId — уникальный ключ, полученый от менеджера.
• algoritm — алгоритм. Сейчас поддерживается только HMAC-SHA256.
• headers — список с порядком подписанных заголовков запроса. Допускаются только хедеры с названиями, которые указаны в примерах запроса.
• signature — подпись.

Request-Target для метода — post /api/internal/v1/mails/incoming?. Значение Request-Target формируется путем объединения нескольких частей запроса: название метода (глагола) в нижнем регистре, пути метода и всех его параметров. Пример: для запроса get /api/v1/get?param1=str1&param2=str2 часть get — это метод (глагол) запроса, /api/v1/get — его путь, а ?param1=str1&param2=str2 — Query-параметры запроса.

X-Request-Id

String<uuid>

Уникальный идентификатор для трассировки запроса. Не влияет на логику исполнения запроса.

Required

data

String

Requirements: <= 128 characters

Hash (HMAC-SHA256) от тела запроса.

Required

date

String

Requirements: Value must match regular expression ^(Mon|Tue|Wed|Thu|Fri|Sat|Sun), ([0-3][0-9]) (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) ([0-9]{4}) ([01][0-9]|2[0-3])(:[0-5][0-9]){2} GMT$

Время выполнения запроса.

Request body schema application/json

anyOf

MOD1

Required

externalId

String<string>

Уникальный идентификатор письма в Transit.

Required

themeCode

String<string>

Код тематики.

Required

theme

String<string>

Тема письма.

Required

text

String<string>

Текст письма.

files

Array

Requirements: >= 1 items, <= 16 items

Список tecmId файлов, прикрепленных к письму.

Required

createdAt

String<date-time>

Дата создания письма.

MOD2

Required

externalId

String<string>

Уникальный идентификатор письма в Transit.

Required

themeCode

String<string>

Код тематики.

Required

theme

String<string>

Тема письма.

text

String<string>

Текст письма.

Required

files

Array

Requirements: >= 1 items, <= 16 items

Список tecmId файлов, прикрепленных к письму.

Required

createdAt

String<date-time>

Дата создания письма.

Ответ

200

OK

400

Некорректный запрос

401

Ошибка аутентификации

403

Ошибка авторизации

422

Ошибка при обработке данных

429

Слишком много запросов

500

Ошибка сервера

Это полезный материал?

Обратиться в поддержку

Loading...