Messages API
- Oleksandr Serdiuk
- Dmytro Lytvyn
Данное 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 |
В случае успешного ответа получите следующее:
Описание ответа: