API команда chats

  • Created:

Данная команда API позволяет получать список чат диалогов с оператором за дату или период, а так же получить все сообщения по отдельно взятому диалогу.

Получение списка диалогов

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

Для получения списка диалогов нужно отправить API запрос на URL команды.

URL команды chats:

https://leadback.ru/api/chats.php

Обязательный параметры:

  • secret_key— секретный ключ;
  • client_id— идентификатор клиента.

Параметры опционально:

  • date— дата за которую нужно получить диалоги в формате YYYY-MM-DD (если дата не передана, то будут получены диалоги за сегодня);
  • date_from— начало периода для получения диалогов за интервал дат в формате YYYY-MM-DD (если передан параметр date, то date_from игнорируется);
  • date_to— конец периода для получения диалогов за интервал дат в формате YYYY-MM-DD (если передан параметр date, то date_from игнорируется);
  • order— сортировка результата по дате начала диалога (значения: asc — по возрастанию, desc — по убыванию);
  • limit— кол-во возвращаемых диалогов (по-умолчанию: 10, максимальное значение: 100).
  • offset— текущее смещение в выборке диалогов. Позиция с которой нужно получать данные, нумерация начинается с 0 (по-умолчанию).

Примеры запроса к API:

https://leadback.ru/api/chats.php?secret_key=ВашСекретныйКлюч&client_id=ВашИдентификаторКлиента&date=2019-11-11

Данная команда вернет список диалогов состоявщихся в дату 11 ноября 2019.

Пример ответа API:

{
    "data": [
        {
            "dialog_id": "f03be3ce26460f217f4d795fdc046000",
            "message_from": "demosite.ru_y83ctv@client.cloudim.chat",
            "message_to": "ytrewq@cloudim.ru",
            "message": "здравствуйте!",
            "message_type": "visitor",
            "operator_list": "ytrewq@cloudim.ru",
            "dialog_start": "2019-11-14 05:01:20",
            "dialog_end": "2019-11-14 05:01:20",
            "dialog_duration": "00:00:00",
            "operator_count": "0",
            "visitor_count": "1",
            "user_id": "1",
            "visit_data": {
                "visit_id": "35d3ef50-0000-39b7-0000-ea08b224c000",
                "date_visit": "2019-11-14 04:36:30",
                "referer_url": "https://mail.yandex.ru/",
                "page_url": "https://demosite.ru/?utm_source=yandex.rsya&utm_medium=cpc&utm_campaign=rsya-retarget-return&yclid=0088036513391614000",
                "call_url": "",
                "visit_ip": "212.188.65.1",
                "visit_ua": "Mozilla/5.0 (Windows NT 6.1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/77.0.3865.120 YaBrowser/19.10.2.195 Yowser/2.5 Safari/537.36",
                "ga_cid": "181304000.1572662000",
                "ya_cid": "1572002932903869000",
                "visit_source": "cpc",
                "utm_source": "yandex.rsya",
                "utm_medium": "cpc",
                "utm_campaign": "rsya-retarget-return",
                "utm_term": null,
                "utm_content": null,
                "search_engine": "Yandex",
                "search_text": "",
                "search_href": "https://yandex.ru/yandsearch?text="
            },
            "visit_profile": {
                "email": "123@host.demo",
                "phone": "79000000001"
            },
            "widget_id": "1",
            "site": "demosite.ru"
        },
        {
            "dialog_id": "be127910b58dfc881d8f5c2151ae8112",
            "message_from": "demosite.ru_txbaq@client.cloudim.chat",
            "message_to": "qwerty@cloudim.ru",
            "message": "Как вы доставляете товар?",
            "message_type": "visitor",
            "operator_list": "qwerty@cloudim.ru",
            "dialog_start": "2019-11-14 09:58:56",
            "dialog_end": "2019-11-14 10:13:04",
            "dialog_duration": "00:14:08",
            "dialog_waiting": "00:01:48",
            "operator_count": "4",
            "visitor_count": "4",
            "user_id": "1",
            "visit_data": {
                "visit_id": "0007af67-0000-3a41-0000-4de7bb8c8b00",
                "date_visit": "2019-11-14 06:30:16",
                "referer_url": "https://demosite.ru/reg.php",
                "page_url": "https://demosite.ru/card.php?welcome",
                "call_url": "",
                "visit_ip": "91.217.63.1",
                "visit_ua": "Mozilla/5.0 (Windows NT 6.3; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/77.0.3865.92 YaBrowser/19.10.0.1522 Yowser/2.5 Safari/537.36",
                "ga_cid": "672463000.1538099000",
                "ya_cid": "1571380004628735800",
                "visit_source": "internal"
            },
            "visit_profile": {
                "name": "Александр",
                "email": "alex@mailservice.demo",
                "phone": "79000000000"
            },
            "widget_id": "1",
            "site": "demosite.ru"
        }
    ],
    "totalItems": "2"
}
JSON

Получение истории переписки

Получив список диалогов, далее вы можете получить весь список сообщений по конкретному диалогу, используя его идентификатор dialog_id.

Примеры получения списка сообщений:

https://leadback.ru/api/chats.php?secret_key=ВашСекретныйКлюч&client_id=ВашИдентификаторКлиента&dialog_id=be127910b58dfc881d8f5c2151ae8112

Обязательный параметры:

  • secret_key— секретный ключ;
  • client_id— идентификатор клиента;
  • dialog_id— идентификатор диалога полученный через API на этапе загрузки списка диалогов.

Пример ответа API:

{
    "data": [
        {
            "id_message": "13438925",
            "dialog_id": "be127910b58dfc881d8f5c2151ae8112",
            "date_create": "2019-11-14 09:58:56",
            "message_from": "demosite.ru_txbaq@client.cloudim.chat",
            "message_to": "qwerty@cloudim.ru",
            "message_type": "visitor",
            "message": "Как вы доставляете товар?"
        },
        {
            "id_message": "13438930",
            "dialog_id": "be127910b58dfc881d8f5c2151ae8112",
            "date_create": "2019-11-14 09:59:14",
            "message_from": "demosite.ru_txbaq@client.cloudim.chat",
            "message_to": "qwerty@cloudim.ru",
            "message_type": "visitor",
            "message": "Интересуют сроки и цена доставки"
        },
        {
            "id_message": "13438947",
            "dialog_id": "be127910b58dfc881d8f5c2151ae8112",
            "date_create": "2019-11-14 10:00:44",
            "message_from": "qwerty@cloudim.ru",
            "message_to": "demosite.ru_txbaq@client.cloudim.chat",
            "message_type": "operator",
            "message": "Добрый день",
            "answer_time": "90"
        },
        {
            "id_message": "13438948",
            "dialog_id": "be127910b58dfc881d8f5c2151ae8112",
            "date_create": "2019-11-14 10:00:45",
            "message_from": "qwerty@cloudim.ru",
            "message_to": "demosite.ru_txbaq@client.cloudim.chat",
            "message_type": "operator",
            "message": "Сроки доставки 3-5 дней, стоимость рассчитываем индивидуально"
        },
        {
            "id_message": "13439053",
            "dialog_id": "be127910b58dfc881d8f5c2151ae8112",
            "date_create": "2019-11-14 10:07:42",
            "message_from": "demosite.ru_txbaq@client.cloudim.chat",
            "message_to": "qwerty@cloudim.ru",
            "message_type": "visitor",
            "message": "Меня интересует доставка в Краснодар"
        },
        {
            "id_message": "13439059",
            "dialog_id": "be127910b58dfc881d8f5c2151ae8112",
            "date_create": "2019-11-14 10:08:26",
            "message_from": "qwerty@cloudim.ru",
            "message_to": "demosite.ru_txbaq@client.cloudim.chat",
            "message_type": "operator",
            "message": "Сейчас рассчитаю",
            "answer_time": "44"
        },
        {
            "id_message": "13439103",
            "dialog_id": "be127910b58dfc881d8f5c2151ae8112",
            "date_create": "2019-11-14 10:12:30",
            "message_from": "demosite.ru_txbaq@client.cloudim.chat",
            "message_to": "qwerty@cloudim.ru",
            "message_type": "visitor",
            "message": "Спасибо!"
        },
        {
            "id_message": "13439110",
            "dialog_id": "be127910b58dfc881d8f5c2151ae8112",
            "date_create": "2019-11-14 10:13:04",
            "message_from": "qwerty@cloudim.ru",
            "message_to": "demosite.ru_txbaq@client.cloudim.chat",
            "message_type": "operator",
            "message": "Стоимость доставки к вам будет 500 руб.",
            "answer_time": "34"
        }
    ],
    "totalItems": "8"
}
JSON
Поделиться ссылкой:
Tagged:

Оставить комментарий