...
Table of Contents |
---|
Список аккаунтов
Вы можете получить список всех аккаунтов клиентов из вашей компании.
...
- data - данные аккаунта;
- gender - пол;
- locale - локаль аккаунта;
- subscribeHistory - история подписок акканута:
- tunnelName - имя туннеля;
- leadgentoolName - имя ЛГТ;
- trafficSource - имя источника траффика.
- links - связи аккаунта:
- users - пользователи, общавшиеся с аккаунтом;
- orders - заказы ссформированные аккаунтом.
- included - дополнительные данные:
- users - массив пользователей платформы, контактировавших с аккаунтом:
- id - id пользователя;
- name - имя пользователя платформы;
- createdAt - время создания пользователя;
- updatedAt - время последнего обновления данных пользователя.
- orders - массив заказов (ордеров) сформированных аккаунтом:
- price - цена заказа;
- currency - валюта заказа;
- paymentMethod - название службы, через которую был сформирован заказ;
- status - текущий статус заказа;
- updatedAt - время последнего обновления статуса заказа.
- users - массив пользователей платформы, контактировавших с аккаунтом:
...
История сообщений аккаунта
Вы можете получить сообщения из истории чата с аккаунтом.
Пример GET запроса:
Code Block |
---|
GET https://api.leeloo.ai/api/v1/accounts/59bbc641b1223300210cdf2f/chat-messages?limit=3&offset=0 |
- 59bbc641b1223300210cdf2f - id аккаунта;
- limit - ограничение количества результатов;
- offset - пропуск результатов.
Code Block |
---|
{
"data": [
{
"id": "59fc4b178dd98a000a958b8b",
"text": "Last message",
"type": "BOT_MESSAGE",
"read": true,
"createdAt": "2017-11-03T10:55:19.024Z",
"updatedAt": "2017-11-03T10:55:19.024Z"
},
{
"id": "59fc28fa03193700519a72af",
"text": "Pre last message",
"type": "YOUR_MESSAGE",
"read": true,
"createdAt": "2017-11-03T09:29:46.936Z",
"updatedAt": "2017-11-03T09:29:46.936Z",
"links": {
"createdBy": {
"type": "users",
"id": "58be00d668aaeaded60aa186"
}
}
},
{
"id": "59fc2a14a2493e0047813e24",
"text": "Good morning!",
"type": "FRIEND_MESSAGE",
"read": true,
"createdAt": "2017-11-03T08:37:28.621Z",
"updatedAt": "2017-11-03T08:37:28.621Z"
}
{
"id": "59fc2a14a2493e0047813e24",
"text": "Good morning, {name}! \n\nTest message content",
"type": "BOT_MESSAGE",
"read": true,
"createdAt": "2017-11-03T08:34:24.443Z",
"updatedAt": "2017-11-03T08:34:24.443Z"
},
{
"id": "59fc2a14a2493e0047813e24",
"text": "",
"type": "SYSTEM_MESSAGE",
"read": true,
"createdAt": "2017-11-03T08:31:23.321Z",
"updatedAt": "2017-11-03T08:31:23.321Z"
}
],
"meta": {
"limit": 3,
"offset": 0,
"filteredCount": 3,
"totalCount": 113
},
"status": 1
} |
- data - массив сообщений;
- id - id сообщения;
- text - содержимое сообщения;
- type - тип сообщения:
- SYSTEM_MESSAGE - уведомление о действии аккаунта (подписка, формирование и изменение статуса заказа);
- BOT_MESSAGE - сообщения, отправленые без прямого участия пользователя (Рассылка, туннель, умные ответы, приветсвие и т.д.);
- YOUR_MESSAGE - сообщение, отправленное пользователем вручную, через страницу чатов;
- FRIEND_MESSAGE - сообщение, отправленное аккаунтом (клиентом).
- read - прочитано ли сообщение (true/false);
- createdAt, updatedAt - время появления сообщения в истории чатов.
- links:
- createdBy - автор сообщения;
- id - идентификатор пользователя, отправившего сообщение.
- createdBy - автор сообщения;
...