Webim Stored Data API 2.0

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

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

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

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

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

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

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

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

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