История сообщений

Получить данные для каналов сообщений

GET /v1.3/messaging/<lead-id>/sources

После успешного выполнения возвращается массив объектов, описывающих каналы сообщений.

id string Идентификатор канала в мессенджере или социальной сети
realId integer Идентификатор канала в Umnico
name string Наименование фотографии или комментария
type string Тип канала: сообщение, комментарий, фотография и т.д.
saId integer Идентификатор интеграции
sender string Идентификатор клиента, который обратился по данному каналу, в мессенджере или социальной сети
token string Токен канала
identifier string Идентификатор социальной сети или мессенджер

Возможные типы каналов:

  • comment - комментарий к посту
  • message - сообщение
  • photo - комментарий к фотографии
  • video - комментарий к видеозаписи
  • market - комментарий к товару

Примечание

Канала с типом message не имеют интеграции со следующими типами:

  • instagramVOff
  • fb_group

Тип comment не имеют интеграции со следующими типами:

  • vk_personal
  • telebot
  • whatsapp
  • whatsapp2
  • widget

Пример:

GET https://api.umnico.com/v1.3/messaging/90/sources

Response:

[
    {
        "id": "59",
        "realId": 255,
        "name": "Пост о скидках",
        "type": "comment",
        "saId": 88,
        "sender": "1111111",
        "token": null,
        "identifier": "167810486"
    },
    {
        "id": "1111111",
        "realId": 184,
        "name": null,
        "type": "message",
        "saId": 13,
        "sender": "1111111",
        "token": null,
        "identifier": "14327180"
    },
    {
        "id": "1111111",
        "realId": 257,
        "name": null,
        "type": "message",
        "saId": 88,
        "sender": "1111111",
        "token": null,
        "identifier": "167810486"
    }
]

Получить историю сообщений для каждого канала

POST /v1.3/messaging/<lead-id>/history/<source-real-id>

В тело запроса указывается курсор для запроса более ранних сообщений.

  • cursor - значение смещения (если история еще не загружалась, то передавать не нужно)

После успешного выполнения возвращается следующий объект.

cursor integer Смещение, которое необходимо передать в следующем запросе
source integer Идентификатор канала в Umnico (аналогичен source-real-id)
messages массив Массив объектов сообщений

Объект, описывающий сообщение:

datetime integer Unix-время отправки сообщения (в миллисекундах)
sa integer Идентификатор интеграции
incoming bool true - входящее сообщение, false - исходящее
message объект  
  • text
string Текст сообщения
  • url
string Ссылка на сообщение в социальной сети или мессенджере
  • attachments
массив Вложения в сообщения
    • type
string Тип вложения
    • url
string Ссылка для получения вложения
    • text
string Название вложения
    • preview
string Ссылка на превью для видео вложений
    • filesize
float Размер файла в байтах
sender объект Объект, описывающий автора сообщения
  • id
integer Идентификатор профиля клиента или externalId интеграции
  • customerId
integer Идентификатор клиента
  • login
string Логин клиента в мессенджере или название аккаунта в социальной сети
  • avatar
string Аватар аккаунта в мессенджере или социальной сети
  • type
string Тип профиля (равнозначен типу интеграции, в которую написал клиент)
  • socialId
string Идентификатор клиента (или интеграции) в мессенджере или социальной сети
  • profileUrl
string Ссылка на профиль
preview объект Объект, описывающий пост (запись, картинку и т.п.), к которому сделан комментарий
  • photo
string Ссылка на картинку из поста
  • description
string Часть текста из поста
  • owner
string Имя пользователя или группы, создавшей пост
  • url
string Ссылка на сообщение в социальной сети или мессенджере
source объект Объект, описывающий канал сообщений (см. выше)
customId string Специальный идентификатор для внешних интеграторов, который возвращается только в webhook’е Исходящее сообщение

Возможные типы вложений:

  • photo - изображение
  • doc - документ
  • link - ссылка
  • video - видеозапись
  • audio - аудиозапись
  • sticker - стикер
  • market - товар

Пример:

GET https://api.umnico.com/v1.3/messaging/90/history/255

Body:

{
   "cursor": 1
}

Response:

{
    "cursor": 60,
    "source": 255,
    "messages": [
        {
            "datetime": 1564564311000,
            "sa": {
                "id": 88,
                "type": "vk_group",
                "login": "Группа Вк",
                "avatar": "https://sun9-9.userapi.com/c839/v83079/12f/kgc1z-f8gRM.jpg"
            },
            "message": {
                "text": "Здравствуйте, подскажите, до какого действует скидка?",
                "url": "https://vk.com/club168?w=wall-168_59_r84"
            },
            "incoming": true,
            "sender": {
                "id": 78,
                "customerId": 78,
                "login": "Important Client",
                "avatar": "https://sun9-8.userapi.com/c9аав2bb34.jpg",
                "type": "vk_group",
                "socialId": "1111111",
                "profileUrl": "https://vk.com/id1111111",
            },
            "source": {
                "id": "59",
                "realId": 255,
                "name": "Пост о скидках",
                "type": "comment",
                "saId": 88,
                "sender": "1111111",
                "token": null
            },
            "preview": null
        },
        {
            "datetime": 1576835088000,
            "sa": {
                "id": 88,
                "type": "vk_group",
                "login": "Группа Вк",
                "avatar": "https://sun9-9.userapi.com/c839/v83079/12f/kgc1z-f8gRM.jpg"
            },
            "message": {
                "text": "[id1111111|Important Client], здравствуйте. Завтра последний день.",
                "url": "https://vk.com/club168?w=wall-168_59_r99"
            },
            "incoming": false,
            "sender": {
                "id": 168
            },
            "source": {
                "id": "59",
                "realId": 255,
                "name": "Пост о скидках",
                "type": "comment",
                "saId": 88,
                "sender": "1111111",
                "token": null
            },
            "preview": null
        }
    ]
}