Messages API - ua
- Anastasiia
- Smart Sender
Дане API дозволяє отримувати/надсилати повідомлення контакту і так само отримувати всю історію листування з вибраним контактом.
Надсилання.
Дозволяє надсилати повідомлення контакту (з можливістю вибору каналу).
POST https://api.smartsender.com/v1/contacts/{contactId}/send
Параметри URL:
Назва | Опис |
|---|---|
contactId | Ідентифікатор контакту |
Основні параметри:
Назва | Опис | Валідація |
|---|---|---|
type | Тип повідомлення | Доступні типи
|
watermark | Тимчасова позначка пріоритету повідомлення (за замовчуванням, використовуйте поточний timestamp) | Timestamp |
media | URL вкладення | Обов'язково, якщо медіа повідомлення. Якщо тип не відповідає формату файлу, буде надіслано як “документ“ |
title | Назва місця | Обов'язково, якщо тип location |
latitude | Ширина | Обов'язково, якщо тип location |
longitude | Довгота | Обов'язково, якщо тип location |
content | Текст | Обов'язково, якщо тип text |
fullName | Повне ім'я | Обов'язково, якщо типcontact |
phoneNumber | Номер телефону | Обов'язково, якщо тип contact |
У разі успішної відповіді отримайте об'єкт типу Message.
Отримання (через контакт).
Дозволяє отримувати повідомлення через контакт.
GET https://api.smartsender.com/v1/contacts/{contactId}/messages
Основні параметри:
Назва | Опис | Валідація |
|---|---|---|
page | Запрошувана сторінка | Мінімальне значення 1 |
limitation | Кількість даних для виводу на сторінці | Мінімальне значення 1, максимальне 20 |
activities | Перемикач, який встановлює, чи потрібно додавати системні повідомлення до результату | Необов’язковий, Boolean/Integer, за умовчанням false |
У разі успішної відповіді отримаєте таке:
{
"cursor": Cursor,
"collection": Message[]
}
Опис відповіді:
Отримання (через чат).
Дозволяє отримувати повідомлення через чат.
Основні параметри:
Назва | Опис | Валідація |
|---|---|---|
page | Запрошувана сторінка | Мінімальне значення 1 |
limitation | Кількість даних для виводу на сторінці | Мінімальне значення 1, максимальне 20 |
activities | Перемикач, який встановлює, чи потрібно додавати системні повідомлення до результату | Необов’язковий, Boolean/Integer, за умовчанням false |
У разі успішної відповіді отримаєте таке:
Опис відповіді: