Данный раздел описывает возможности системы по переговоров. Система позволяет получать сообщения как в режиме онлайн так и по запросу.
Для запроса архива можно воспользоваться запросом ChatsRequest с указанием компонента NoChatDatesGrp. Запрос работает в двух режимах
- "Начиная с даты". Передав NoDates = 1 с указанием даты начиная с которой необходимо вернуть чаты (>=)
- "За период". Передав NoDates = 2 с указанием даты начала (>=) и даты окончания периода (<=)
Так же можно запросить чат по его идентификатору.
ChatsRequest (35=UA)
Запрос архива чатов
Тэг | Поле | Наличие | Тип | Описание | Допустимые значения | |
|---|---|---|---|---|---|---|
| 11004 | ChatsRequestID | Y | String | Уникальный идентификатор запроса | ||
| 11005 | NoChatDates | N | NumInGroup |
| ||
| => | 1132 | TransactTime | N | TZTransactTime | ||
| 11004 | ChatID | N | String | Уникальный идентификатор чата | ||
ChatsRequestAck (35=UW)
Ответ на запрос архива чатов. Присылается либо в случае возникновения ошибки, либо в завершении передачи запрошенных сообщений
Тэг | Поле | Наличие | Тип | Описание | Допустимые значения | |
|---|---|---|---|---|---|---|
| 11004 | ChatsRequestID | Y | String | Уникальный идентификатор запроса | ||
| 11006 | ChatsRequestResult | Y | Int | Результат запроса. Могут вводиться дополнительные статусы, для формализации причин отмены запроса |
| |
| 11007 | ChatsRequestStatus | Y | Int | Статус запроса |
| |
| 58 | Text | N | String | Текст ошибки | ||
ChatStartMessage (35=US)
Сообщение присылается в случае создания нового чата.
Тэг | Поле | Наличие | Тип | Описание | Допустимые значения | |
|---|---|---|---|---|---|---|
| 11004 | ChatID | Y | String | Уникальный идентификатор чата | ||
| 11008 | Base64Text | Y | Base64 | Заголовок чата | ||
| 1132 | TransactTime | Y | TZTransactTime | Время сообщения | ||
| 11009 | Direction | Y | Integer | Направление сообщения | 0 = Входящее 1 = Исходящее | |
| 11004 | ChatsRequestID | N | String | Идентификатор запроса, если сообщение отправлено в ответ на запрос | ||
| => | << Компонент Parties >> | N | ||||
ChatEndMessage (35=UE)
Сообщение присылается в случае завершения чата.
Тэг | Поле | Наличие | Тип | Описание | Допустимые значения | |
|---|---|---|---|---|---|---|
| 11004 | ChatID | Y | String | Уникальный идентификатор чата | ||
| 11003 | ChatMessageID | Y | String | Уникальный идентификатор сообщения | ||
| 1132 | TransactTime | Y | TZTransactTime | Время сообщения | ||
| 11009 | Direction | Y | Integer | Направление сообщения | 0 = Входящее 1 = Исходящее | |
| 11004 | ChatsRequestID | N | String | Идентификатор запроса, если сообщение отправлено в ответ на запрос | ||
| 11008 | Base64Text | Y | Base64 | Текст сообщения | ||
| => | << Компонент Parties >> | N | ||||
ChatMessage (35=UM)
Сообщение присылается на каждое сообщение в чате
Тэг | Поле | Наличие | Тип | Описание | Допустимые значения | |
|---|---|---|---|---|---|---|
| 11002 | ChatID | Y | String | Уникальный идентификатор чата | ||
| 11003 | ChatMessageID | Y | String | Уникальный идентификатор сообщения | ||
| 1132 | TransactTime | Y | TZTransactTime | Время сообщения | ||
| 11009 | Direction | Y | Integer | Направление сообщения | 0 = Входящее 1 = Исходящее | |
| 11004 | ChatsRequestID | N | String | Идентификатор запроса, если сообщение отправлено в ответ на запрос | ||
| 11008 | Base64Text | Y | Base64 | Текст сообщения | ||
=> | 448 | PartyID | N | String | Идентификатор участника | |
| => | 447 | PartyIDSource | N | Char | Схема идентификаторов | D = Proprietary/Custom code |
| => | 452 | PartyRole | N | Int | Роль участника |
|