Вимкнення або ввімкнення сповіщень для користувачів в Telegram
У деяких випадках виникає необхідність вимкнути в Telegram сповіщення для користувачів, які спілкуються із ботом або оператором, щоб уникнути втручання в таке спілкування. За необхідності, повідомлення можна ввімкнути знову.
На нашій платформі це можливо зробити для користувачів, що мають токени Telegram. Ця функція реалізована за допомогою двох API методів, які описані нижче.
Вимкнення сповіщень
Щоб вимкнути сповіщення, надішліть запит на:
- POST /v1/apps/{app_uuid}/token/mute
де замініть {app_uuid} у посиланні на UUID вашого додатка.
Зверніть увагу
Користувачі або чати, для яких вимкнені повідомлення, все ще можуть отримувати транзакційні повідомлення (smartsend, тестові).
Параметри методу та їх опис наведені в наступній таблиці.
| Параметр | Тип | Опис |
|---|---|---|
| token | string | Обов'язковий параметр. Токен Telegram користувача. |
| duration | long | Необов'язковий параметр. Тривалість вимкнення сповіщень в секундах: - Мінімальне значення – 5 секунд. - Максимальне значення – 31 536 000 секунд (приблизно 1 рік).Якщо тривалість не вказана, для вимкнення звуку встановлюється значення 9999-12-31 23:59:59, що вимикає сповіщення «назавжди». Щоб змінити тривалість вимкнення сповіщень, надішліть інший запит із новим значенням. |
У відповіді можуть повернутись помилки, що наведені в таблиці.
| Статус | Повідомлення | Опис |
|---|---|---|
| 400 | Wrong app uuid | Невірний uuid застосунку. |
| 400 | Tokens must be specified | Токен не вказаний. |
| 400 | Duration must be positive int | Значення тривалості має бути додатним цілим числом. |
| 400 | Not registered application | Застосунок не зареєстрований. |
Контакти з вимкненими повідомленнями відображаються у звітах розсилки як "Недоступні контакти" з типом помилки "Інші помилки".
Назва помилки в деталях: CHANNEL_WAS_MUTED.
Ввімкнення повідомлень
Щоб ввімкнути сповіщення, надішліть запит на:
- POST /v1/apps/{app_uuid}/token/unmute
де замініть {app_uuid} у посиланні на UUID вашого додатка.
Запит має містити наступний параметр:
| Параметр | Тип | Опис |
|---|---|---|
| token | string | Обов'язковий параметр. Токен Telegram користувача. |
У відповіді можуть повернутись помилки, що наведені в таблиці.
| Статус | Повідомлення | Опис |
|---|---|---|
| 400 | Wrong app uuid | Невірний uuid застосунку. |
| 400 | Tokens must be specified | Токен не вказаний. |
| 400 | Not registered application | Застосунок не зареєстрований. |
Updated about 2 months ago