Отправить пуш-уведомление

POST

https://business.tbank.ru/openapi/api/partner-notifications/v1/send

Метод для отправки пуш-уведомления

Авторизация

Security

Bearer API Token

RPS

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

Scopes

Отправка уведомлений клиентам → Отправка уведомлений партнером

Запрос

Header parameters

X-Request-Id

String<uuid>

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

Request body schema application/json

Required

messageId

String

Requirements: <= 36 characters

Уникальный ID сообщения

Required

type

String

Requirements: <= 50 characters

Тип сообщения

delivery

Object

period

Object

start

String

Requirements: <= 5 characters

Время начала интервала доставки сообщения в формате hh

end

String

Requirements: <= 5 characters

Время окончания интервала доставки сообщения в формате hh

timezone

String

Requirements: <= 6 characters

Таймзона клиента, с учетом которой рассчитается интервал доставки. По умолчанию используется GMT+3 (+03:00)

sequence

Array

Requirements: [sms, push], <= 1 items

Default: push

label

String

Requirements: <= 100 characters

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

recipient

Object

phone

String

Requirements: <= 13 characters

Номер телефона получателя

smsMessage

Object

smsMessageText

String

Requirements: <= 500 characters

Текст SMS сообщения

subject

String

Requirements: <= 50 characters

Подпись СМС-сообщения

ttl

Number

Время жизни сообщения в секундах

pushNotification

Object

pushNotificationTitle

String

Requirements: <= 100 characters

Заголовок PUSH уведомления

pushNotificationText

String

Requirements: <= 2048 characters

Текст PUSH уведомления

redirectUrl

String

Requirements: <= 2048 characters

Ссылка для редиректа по нажатию на пуш

ttl

Number

Время жизни сообщения в секундах

timeline

Object

enabled

String

Requirements: [Y, N]

Признак необходимости отображения пуша в ленте пушей

Ответ

200

Successful operation

400

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

401

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

403

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

422

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

429

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

500

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

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

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