Webim Stored Data API 2.0

Описание полей объекта state_history в ответе на запрос:

Описание полей объекта visit_session в ответе на запрос:

Описание полей объекта rates в ответе на запрос:

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

<br />
{<br />
   "chats": [<br />
      {<br />
         "id": 453,<br />
         "created_at": "2012-04-04T09:14:57Z",<br />
         "category": "Категория",<br />
         "subcategory": "Подкатегория",<br />
         "operator_id": 123,<br />
         "operator_comment": null,<br />
         "rates": [<br />
           {<br />
             "rate": 3,<br />
             "operator_id": 209920,<br />
             "created_at": "2020-05-13T23:57:01Z"<br />
           }<br />
         ],<br />
         "messages": [<br />
            {<br />
               "created_at": "2012-04-04T09:14:57Z",<br />
               "kind": "for_operator",<br />
               "message": "Посетитель открыл окно диалога со страницы"<br />
               "id": "24113c657f254698a3e660c64c4ed6b5"<br />
            },<br />
            {<br />
               "created_at": "2012-04-04T09:14:57Z",<br />
               "kind": "info",<br />
               "message": "Пожалуйста, подождите немного."<br />
               "id": "f5eee59b508e47f999d8a373d0362c95"<br />
            },<br />
            {<br />
               "created_at": "2012-04-04T09:14:57Z",<br />
               "kind": "events",<br />
               "message": "Оператор Администратор включился в разговор"<br />
               "id": "324090d75f904a3eb04e54b2fc44094b"<br />
            },<br />
            {<br />
               "created_at": "2012-04-04T09:14:57Z",<br />
               "kind": "operator_busy",<br />
               "message": "Приносим извинения, оператор отлучился"<br />
               "id": "b1f9c575fc4d4b45b2480a490443a802"<br />
            },<br />
            {<br />
               "created_at": "2012-04-04T09:14:57Z",<br />
               "kind": "file_operator",<br />
               "data": {<br />
                  "guid": "8cdb288",<br />
                  "content_type": "text",<br />
                  "filename": "v.txt"<br />
               },<br />
               "operator_id": 123<br />
            },<br />
            {<br />
               "created_at": "2012-04-04T09:14:57Z",<br />
               "kind": "file_visitor",<br />
               "data": {<br />
                  "guid": "81f0488",<br />
                  "content_type": "text",<br />
                  "filename": "v.txt"<br />
               },<br />
               "operator_id": 123<br />
            },<br />
            {<br />
               "created_at": "2012-04-04T09:14:57Z",<br />
               "kind": "operator",<br />
               "message": "Здравствуйте! Чем я могу Вам помочь?",<br />
               "operator_id": 123<br />
            },<br />
            {<br />
               "created_at": "2012-04-04T09:14:57Z",<br />
               "kind": "contacts_request",<br />
               "message": "Введите, пожалуйста, информацию.",<br />
               "operator_id": 123<br />
            },<br />
            {<br />
               "created_at": "2012-04-04T09:14:57Z",<br />
               "kind": "contacts",<br />
               "message": {<br />
                  "name": "Вася",<br />
                  "phone": "1",<br />
                  "email": "v@webim.ru"<br />
               }<br />
            },<br />
            {<br />
               "created_at": "2012-04-04T09:14:57Z",<br />
               "kind": "visitor",<br />
               "message": "Пока нет, спасибо"<br />
            }<br />
         ],<br />
         "state_history": [<br />
            {<br />
               "state": "queue",<br />
               "operator_id": null,<br />
               "at": "2014-06-10T17:06:22Z",<br />
               "department_id": null<br />
            },<br />
            {<br />
               "state": "queue",<br />
               "operator_id": 3,<br />
               "at": "2014-06-10T17:06:22Z",<br />
               "department_id": null<br />
            },<br />
            {<br />
               "state": "chatting",<br />
               "operator_id": 3,<br />
               "at": "2014-06-10T17:06:28Z",<br />
               "department_id": null<br />
            },<br />
            {<br />
               "state": "queue",<br />
               "operator_id": null,<br />
               "at": "2014-06-10T20:07:04Z",<br />
               "department_id": 2<br />
            }<br />
         ],<br />
         "visitor": {<br />
            "fields": {<br />
               "email": "support@webim.ru",<br />
               "id": "asdf123",<br />
               "icq": "123123123",<br />
               "login": "somelogin",<br />
               "name": "asdf123",<br />
               "phone": "+7 (812) 385-53-37",<br />
               "profile_url": "https://vk.com/id000",<br />
               "site": "https://webim.ru"<br />
            },<br />
            "id": "4d123f6d7143490d966432ccb24403a4"<br />
         },<br />
         "visit_session": {<br />
            "ip": "192.168.1.123",<br />
            "landing_page": {<br />
               "url": "https://webim.ru"<br />
            }<br />
         },<br />
         "start_page": {<br />
            "url": "https://webim.ru/help/api"<br />
         }<br />
      },<br />
      {<br />
         "id": 454,<br />
         "created_at": "2018-04-04T09:15:57Z"<br />
      },<br />
      {<br />
         "id": 455,<br />
         "created_at": "2012-04-04T09:16:57Z"<br />
      }<br />
      ...<br />
   ],<br />
   "more_chats_available": false,<br />
   "last_ts": 1429054006896762<br />
}<br />

В запросе должен быть указан параметр since. В первом запросе передается since=0, в ответе на каждый запрос есть поле last_ts, и в каждом следующем запросе в качестве since должно передаваться значение last_ts из предыдущего. NB: в параметрах since и last_ts значение указывается в микросекундах!

Таким образом каждый следующий запрос получает в ответ только обновления по отношению к тому, что было получено на все предыдущие запросы.

Один и тот же диалог может быть получен несколько раз, если с момента, когда он был получен первый раз, в нем происходили какие-либо изменения.

В ответ на запрос истории возвращается за раз не более 100 диалогов. Если поле more_chats_available в ответе имеет значение true, это означает, что на сервере остались новые или изменившиеся диалоги, "не поместившиеся" в это ограничение, и следует сделать еще один запрос с новым значением since для их получения (и повторять это до тех пор, пока more_chats_available не примет значение false).