...
| Table of Contents |
|---|
Список аккаунтов
Если Вам нужно Для того, чтобы получить список всех аккаунтов подписчиков из аккаунта Вашей платформы, то компании отправьте серверу следующий GET запрос:
| Code Block | ||||
|---|---|---|---|---|
| ||||
GET https://api.leeloo.ai/api/v1/accounts?limit=3&offset=0&filter[tags]=tag3,tag2 |
...
- limit - ограничение количества результатов (не рекомендуется выгружать большое количество данных сразу, так как это может замедлить выгрузку данных);
- offset - сколько результатов пропустить (по умолчанию "0");
- filter[tags] - фильтр по тэгам;
- tag3,tag2 - список тэгов.
Если Все все сделано правильно, то сервер Вам сервер выдаст следующий ответ:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"data": [
{
"id": "59bbc641b1223300210cdf2f",
"name": "Kurt Bowie",
"tags": [
"tag2"
],
"from": "FACEBOOK",
"botStatus": "BOT",
"lastMessageTime": "2017-11-03T08:34:18.417Z",
"createdAt": "2017-09-15T12:23:29.023Z"
},
{
"id": "5899afd15c97121f006c8b48",
"name": "Weend Vidente",
"tags": [
"68187",
"tag3"
],
"from": "TELEGRAM",
"botStatus": "BOT",
"lastMessageTime": "2017-09-07T14:30:58.798Z",
"createdAt": "2017-02-07T11:30:25.324Z"
}
],
"meta": {
"limit": 3,
"offset": 0,
"filteredCount": 2,
"totalCount": 2
},
"status": 1
} |
где:
- data - массив запрашиваемых аккаунтов;
- id - id аккаунта (уникальное значение для каждого подписчика в системе, можно узнать только через API);
- name - имя аккаунта (как подписчик назвал себя в настройках мессенджера);
- tags - массив тэгов аккаунта (какие тэги были добавлены для данного пользователя на платформе);
- from - из какого мессенджера данный аккаунт;
- botStatus - статус бот/админ для данного аккаунта (статус "BOT" - сообщения от бота приходят пользователю, "ADMIN" - с подписчиком общается человек - сообщения от бота не приходят);
- lastMessageTime - время последнего сообщения (когда от подписчика было отправлено последнее сообщение);
- createdAt - время добавления аккаунта в платформу (когда произошла подписка).
...
- data - массив сообщений;
- id - id сообщения;
- text - содержимое сообщения;
- type - тип сообщения:
- SYSTEM_MESSAGE - уведомление о действии аккаунта (подписка, формирование и изменение статуса заказа);
- BOT_MESSAGE - сообщения, отправленые без прямого участия пользователя (Рассылка, туннель, умные ответы, приветсвие и т.д.);
- YOUR_MESSAGE - сообщение, отправленное пользователем вручную, через страницу чатов;
- FRIEND_MESSAGE - сообщение, отправленное аккаунтом (клиентом).
- read - прочитано ли сообщение (true/false);
- createdAt, updatedAt - время появления сообщения в истории чатов.
- links:
- createdBy - автор сообщения;
- id - идентификатор пользователя, отправившего сообщение.
...