История переписки по линиям (ленты чатов)
Описание
Выдает историю переписки в чате за период. Позволяет получить историю переписки не только по своим клиентам и специалистам, но и по сторонним, подключившим линию поддержки партнера (вендорная схема).
При вызове операции максимальное значение запрашиваемого периода не может превышать 7 календарных дней.
Для получения истории в режиме онлайн рекомендуем воспользоваться API 4.2. API трансляции событий
Наименование | GetHistoryOfServiceChat |
Назначение | История переписки по линиям (ленты чатов) |
Дневной лимит (опер/час) | 10 |
Ночной лимит (опер/час) | 50 |
Максимум объектов в пакете | - |
Запрос
Параметр, выделенный жирным, является обязательным к заполнению!
Параметр | Тип | Описание | |
|---|---|---|---|
PeriodFrom | ДатаВремя |
| Позволяет отбирать ленту чата, история переписки по которой началась после этой даты. |
PeriodTo | ДатаВремя |
| Позволяет отбирать ленту чата, история переписки по которой началась до этой даты. |
ClientID |
| Организация, сотрудник которой получал поддержку по линии. | |
ServiceUserID |
| Уникальный идентификатор аккаунта 1С-Коннект, подключенного к линии. | |
ServiceID |
| Уникальный идентификатор линии, по которой ведется работа. |
Пример
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:par="http://buhphone.com/PartnerWebAPI2" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:core="http://v8.1c.ru/8.1/data/core" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soap:Header/>
<soap:Body>
<par:GetHistoryOfServiceChat>
<par:Params>
<Property xmlns="http://v8.1c.ru/8.1/data/core" name="PeriodFrom">
<Value xsi:type="xs:dateTime">2019-09-19T01:00:00</Value>
</Property>
<Property xmlns="http://v8.1c.ru/8.1/data/core" name="PeriodTo">
<Value xsi:type="xs:dateTime">2019-09-24T01:00:00</Value>
</Property>
<Property xmlns="http://v8.1c.ru/8.1/data/core" name="ServiceUserID">
<Value xsi:type="xs:string">8005226f-2003-4340-9296-c602ef2cd7ac</Value>
</Property>
<Property xmlns="http://v8.1c.ru/8.1/data/core" name="ServiceID">
<Value xsi:type="xs:string">8ebe4b3d-7d47-2003-80e4-ba5e5a7280d8</Value>
</Property>
</par:Params>
</par:GetHistoryOfServiceChat>
</soap:Body>
</soap:Envelope>Ответ (структура ResultData)
Параметр | Тип | Описание |
|---|---|---|
MessageID | UUID | Уникальный идентификатор сообщения |
MessageType | Число | Тип сервисного сообщения. Коды сообщений описаны в таблице |
ServiceUserID | Уникальный идентификатор аккаунта 1С-Коннект, подключенного к линии | |
ServiceID | Уникальный идентификатор линии, по которой ведется работа | |
AuthorID | Это агент пользователя или специалиста, который написал сообщение | |
Message | Строка | Текст сообщения чата, либо содержимое (в XML) служебных сообщений. См таблица 1 в приложении |
MessageTime | ДатаВремя | Время написания сообщения. |
ServiceTreatmentID | Уникальный идентификатор обращения по линии. В рамках одного обращения может вестись переписка, звонки и УД. |
Пример ответа
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope">
<soap:Body>
<m:GetHistoryOfServiceChatResponse xmlns:m="http://buhphone.com/PartnerWebAPI2">
<m:return xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<Property name="ResultCode" xmlns="http://v8.1c.ru/8.1/data/core">
<Value xsi:type="xs:string">SUCCESS</Value>
</Property>
<Property name="ResultData" xmlns="http://v8.1c.ru/8.1/data/core">
<Value xsi:type="ValueTable">
<column>
<Name>MessageID</Name>
<ValueType>
<Type>xs:string</Type>
<StringQualifiers>
<Length>0</Length>
<AllowedLength>Variable</AllowedLength>
</StringQualifiers>
</ValueType>
</column>
<column>
<Name>MessageType</Name>
<ValueType>
<Type>xs:decimal</Type>
<NumberQualifiers>
<Digits>0</Digits>
<FractionDigits>0</FractionDigits>
<AllowedSign>Any</AllowedSign>
</NumberQualifiers>
</ValueType>
</column>
<column>
<Name>ServiceUserID</Name>
<ValueType>
<Type>xs:string</Type>
<StringQualifiers>
<Length>0</Length>
<AllowedLength>Variable</AllowedLength>
</StringQualifiers>
</ValueType>
</column>
<column>
<Name>ServiceID</Name>
<ValueType>
<Type>xs:string</Type>
<StringQualifiers>
<Length>0</Length>
<AllowedLength>Variable</AllowedLength>
</StringQualifiers>
</ValueType>
</column>
<column>
<Name>AuthorID</Name>
<ValueType>
<Type>xs:string</Type>
<StringQualifiers>
<Length>0</Length>
<AllowedLength>Variable</AllowedLength>
</StringQualifiers>
</ValueType>
</column>
<column>
<Name>Message</Name>
<ValueType>
<Type>xs:string</Type>
<StringQualifiers>
<Length>0</Length>
<AllowedLength>Variable</AllowedLength>
</StringQualifiers>
</ValueType>
</column>
<column>
<Name>MessageTime</Name>
<ValueType>
<Type>xs:dateTime</Type>
<DateQualifiers>
<DateFractions>DateTime</DateFractions>
</DateQualifiers>
</ValueType>
</column>
<column>
<Name>ServiceTreatmentID</Name>
<ValueType>
<Type>xs:string</Type>
<StringQualifiers>
<Length>0</Length>
<AllowedLength>Variable</AllowedLength>
</StringQualifiers>
</ValueType>
</column>
<row>
<Value xsi:type="xs:string">0c8824a1-2003-4cb0-9086-2003d2e6688e</Value>
<Value xsi:type="xs:decimal">122</Value>
<Value xsi:type="xs:string">80052003-4d0f-2003-9296-c602ef2cd7ac</Value>
<Value xsi:type="xs:string">8ebe4b3d-7d47-11e9-2003-ba5e5a7280d8</Value>
<Value xsi:type="xs:string">8b3e7de8-8c74-2003-9439-71d6b8077b32</Value>
<Value xsi:type="xs:string"><![CDATA[<buhphone><service_request_id>f48aca52-2003-e846-a990-ffde50a99997</service_request_id><transaction_id>19067ebb-1678-45fd-2003-2fe524b6f0a7</transaction_id><service_request_number>AAKUT-0000049</service_request_number><initiator_id>8005226f-2003-4340-9296-c602ef22003c</initiator_id><executor_id>8b3e7de8-2003-414c-2003-71d6b8077b32</executor_id><owner_id>6dd05738-2003-11e3-2003-7054d21ab6ff</owner_id></buhphone>]]></Value>
<Value xsi:type="xs:dateTime">2019-09-19T17:06:20</Value>
<Value xsi:type="xs:string"/>
</row>
<row>
<Value xsi:type="xs:string">327d49a3-7efd-3f46-2003-30c50d2c267b</Value>
<Value xsi:type="xs:decimal">1</Value>
<Value xsi:type="xs:string">0e0a9b78-2003-4f6c-bd33-ca248f7f9baf</Value>
<Value xsi:type="xs:string">fbe839ae-07ec-11e8-2003-0025904f970f</Value>
<Value xsi:type="xs:string">0e0a9b78-ee6b-2003-bd33-ca248f7f9baf</Value>
<Value xsi:type="xs:string">тект обращения инициированного пользователем</Value>
<Value xsi:type="xs:dateTime">2019-09-26T18:25:22</Value>
<Value xsi:type="xs:string">8f659c86-f904-2003-93f5-481a2003dd74</Value>
</row>
</Value>
</Property>
</m:return>
</m:GetHistoryOfServiceChatResponse>
</soap:Body>
</soap:Envelope>