App Inbox для мобильных приложений

Отслеживание событий и поведения

Email

Омниканальность

Автоматизация

Настройка App Inbox для мобильных приложений

App Inbox – еще один вариант коммуникации с вашими клиентами, предоставляемый eSputnik. Он позволяет отправлять уведомления в автоматическом и ручном режиме в их личный кабинет в мобильном приложении.

Общее описание App Inbox, его применение, преимущества в сравнении с другими каналами рассылки вы можете найти в статье “App Inbox: почему вы оцените этот канал и как его эффективно использовать”.

Настройка App Inbox для мобильных приложений

Настройка App Inbox включает в себя отправку запросов:

  • Получение токена идентификации.
  • Получение количества непрочитанных App Inbox сообщений.
  • Получение количества страниц с сообщениями.
  • Получение списка всех App Inbox сообщений в мобильном приложении.
  • Изменение статуса App Inbox сообщений.

Получение токена аутентификации

Для получения токена аутентификации пользователя (authToken) отправляется запрос с вашего сервера к API eSputnik. Запрос должен быть аутентифицирован одним из способов, описанных в инструкции к API. Например, API-ключом

В запросе необходимо передать известные поля пользователя: email, phone, externalCustomerId (хотя бы одно поле должно быть обязательным). Эти поля нужны для поиска контакта в eSputnik.

Метод запроса

POST

URL запроса

https://esputnik.com/api/v1/auth/contact/token

Заголовок запроса

Content-Type: application/json

Тело запроса

{ "email": string, "phone": string, "externalCustomerId": string }

Ответ

{

“token”: string

}

 

В дальнейшем authToken используется для аутентификации всех App Inbox запросов. Его нужно передавать в заголовке запроса ES-TOKEN. После каждого запроса текущий токен инвалидируется, а в заголовке ответа ES-TOKEN приходит новый, который используется для следующего запроса.

Если в ответ на любой App Inbox запрос приходит статус 401, то запрос на получение токена необходимо повторить.

Получение количества непрочитанных App Inbox сообщений

Запрос дает вам возможность получать информацию о количестве непрочитанных сообщений в мобильном приложении клиента. Запрос может выполняться регулярно.

Метод запроса

GET

URL запроса

 https://esputnik.com/appinbox/v1/messages/count

Заголовок запроса

ES-TOKEN: authToken

Заголовок ответа

ES-TOKEN: newAuthToken

Ответ

{
"count": int
}

 

Если значение count > 0, пользователь должен увидеть индикатор непрочитанных сообщений.

Индикатор непрочитанных сообщений

Получение списка App Inbox сообщений

Запрос позволяет получить в ответе список сообщений в мобильном приложении, включая следующие данные:

  • id сообщения;
  • дата создания;
  • заголовок;
  • текст сообщения;
  • URL изображения;
  • URL ссылки;
  • статус сообщения (прочитанное или непрочитанное).

Метод запроса

GET 

URL запроса

https://esputnik.com/appinbox/v1/messages?page={pageNumber}&pageSize={pageSize}

Заголовок запроса

ES-TOKEN: authToken

Заголовок ответа

ES-TOKEN: newAuthToken

pageNumber minimum value 0
pageSize minimum value 1

Ответ

{
"list": [{
"id" : string, // UUID
"createdDate" : long, //timestamp in milliseconds
"title": text,
"content": text,
"image": string, // URL
"link": string, // URL
"newMessage" : boolean // true for unread message
},...],
	"totalPages": int
}

 

Если pageNumber или pageSize не установлены, вернутся все актуальные сообщения.

Изменение статуса App Inbox сообщений

Запрос используется для передачи события о прочтении сообщения. Необходимо передавать только идентификаторы сообщений, у которых newMessage=true.

При помощи запроса также можно изменить статус всех сообщений с "непрочитанное" на "прочитанное".

Метод запроса

POST

URL запроса

https://esputnik.com/appinbox/v1/messages/status

Заголовок запроса

ES-TOKEN: authToken

Заголовок ответа

ES-TOKEN: newAuthToken

Тело запроса

Для передачи события о прочтении сообщения:

{
"status" : "OPENED",
"ids": [string]
}

Для изменения статуса всех сообщений на "прочитанное":

{
"status": "OPENED",
"ids": null   //либо не передавать параметр вовсе
}

 

Ответ

нет

Создание App Inbox сообщений

Инструкция по созданию App Inbox сообщений и их рассылке представлена на странице “Создание App Inbox cообщений”.

Остались вопросы?
Специалисты обязательно ответят и помогут решить вашу проблему!
Обратный звонок
Оставьте заявку – и наш специалист свяжется с вами в рабочее время.
Отправить заявку
Консультация в чате
Готовы к вашим вопросам!
Написать в чат
Электронная почта
Напишите в службу поддержки eSputnik.
Отправить email