Configuring App Inbox for Mobile Apps
App Inbox is another option to communicate with your customers provided by our CDP. It allows the delivery of automatic and manual notifications to their accounts in the mobile app.
General description of App Inbox, its application, advantages as compared with other communication channels you may find in this article.
Configuring App Inbox for Mobile Apps
To configure App Inbox, you need to send the requests to
- get an authentication token;
- get the number of unread App Inbox messages;
- get the number of pages with messages;
- get the list of all App Inbox messages in the mobile app;
- get the changed status of App Inbox messages.
Getting Authentication Token
Send the request from your server to our platform's API to receive the user authentication token (authToken). Authenticate the request using one of the methods specified in the API instructions, for example, using an API key.
The request has to contain the known contact fields: email, phone, externalCustomerId (at least one field is required). Those fields are used for searching contacts in our system.
| Request method | POST |
|---|---|
| Request URL | api/v1/auth/contact/token |
| Request header | Content-Type: application/json |
| Request body | { "email": string, "phone": string, "externalCustomerId": string } |
| Response | { "token": string } |
Afterward, authToken is used for authentication of all App Inbox requests. Pass it in the header of the ES-TOKEN request. The current token becomes invalidated after each request, and the ES-TOKEN response header passes the new one used in the following request.
If you receive status code 401 as a response to any App Inbox request, resubmit the request to get the token.
Getting the Number of Unread App Inbox Messages
The request permits you to get information about unread messages in the client’s mobile app. You can send this request on a regular basis.
| Request method | GET |
|---|---|
| Request URL | appinbox/v1/messages/count |
| Request header | ES-TOKEN: authToken |
| Response header | ES-TOKEN: newAuthToken |
| Response | { "count": int } |
If count > 0, you shall see the indicator of unread messages.
Getting the List of All App Inbox Messages
The request permits to get in the response the list of messages in the mobile app, including the following data:
- message ID;
- date of creation;
- header;
- message text content;
- image URL;
- link URL;
- message status (opened or unopened);
- category;
- custom data.
| Request method | GET |
|---|---|
| Request URL | appinbox/v1/messages?page={pageNumber}&pageSize={pageSize}&status={status} |
| Request header | ES-TOKEN: authToken |
| Response header | ES-TOKEN: newAuthToken |
| page | minimum value 0 |
| pageSize | minimum value 1 |
| status | OPENED/UNOPENED |
| Response | { "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 "status" : OPENED, UNOPENED // message status },...], "totalPages": int } |
If page, status or pageSize is not set then return all actual messages.
Getting the Changed Status of App Inbox Messages
The request transfers the read message event. It is required to pass only the message IDs having newMessage=true.
Using this request, you also can change the status of all messages from "unread" to "read".
| Request method | appinbox/v1/messages/status |
| Request header | ES-TOKEN: authToken |
| Response header | ES-TOKEN: newAuthToken |
| Request body | { "status" : "OPENED", "ids": [string] } { "status": "OPENED", "ids": null //or leave empty } |
| Response | none |
Creating Segment With Contacts Available for App Inbox
All contacts that enter Yespo through the SDK have Device IDs. This means you can send them App Inbox messages.
To select all contacts with Device IDs in your database, create a dynamic segment and include the All contacts with device condition.
Creating App Inbox Messages
See this article to learn more about creating the messages and campaigns.
Updated about 2 months ago