Данный раздел описывает возможности системы по переговоров. Система позволяет получать сообщения как в режиме онлайн так и по запросу.
PlantUML Macro |
---|
@startuml ChatRequest title Chat requests actor Клиент as c participant Сервис as e c -> e: ChatsRequest alt Ошибка e -> c: ChatsRequestAck (11007=1) else e --> c: ChatStartMessage e --> c: ChatMessage ... e --> c: ChatEndMessage ... e -> c: ChatsRequestAck (11007=0) end e --> c: ChatStartMessage e --> c: ChatMessage e --> c: ChatEndMessage ... @enduml |
...
Предупреждение |
---|
По умолчанию при подключении к системе в сессию будут отправляться сделки сообщения к которым у пользователя есть доступ. |
...
- "Начиная с даты". Передав NoDates NoChatDates = 1 с указанием даты начиная с которой необходимо вернуть чаты (>=)
- "За период". Передав NoDates NoChatDates = 2 с указанием даты начала (>=) и даты окончания периода (<=)
Так же можно запросить чат по его идентификатору.
ChatsRequest (35=
...
UR)
Запрос архива чатов
Тэг | Поле | Наличие | Тип | Описание | Допустимые значения | |
---|---|---|---|---|---|---|
11004 | ChatsRequestID | Y | String | Уникальный идентификатор запроса | ||
11005 | NoChatDates |
N | NumInGroup |
|
| ||
=> | 60 | TransactTime |
N | TransactTime |
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 | Заголовок чата |
60 | TransactTime | Y |
TransactTime | Время сообщения | |||||
11009 | Direction | Y | Integer | Направление сообщения | 0 = Входящее 1 = Исходящее | |
11004 | ChatsRequestID | N | String | Идентификатор запроса, если сообщение отправлено в ответ на запрос | ||
=> | << Компонент Parties >> | N |
ChatEndMessage (35=UE)
Сообщение присылается в случае завершения чата.
Подсказка |
---|
Сообщение о завершении чата направляется всем участникам чата, после того как одна из сторон завершает переговоры нажав на кнопку End, в тексте переговоров появляется сообщение "End contact" |
Тэг | Поле | Наличие | Тип | Описание | Допустимые значения | |
---|---|---|---|---|---|---|
11004 | ChatID | Y | String | Уникальный идентификатор чата | ||
11003 | ChatMessageID | Y | String | Уникальный идентификатор сообщения |
60 | TransactTime | Y |
TransactTime | Время сообщения | ||||
11004 | ChatsRequestID | N | String | Идентификатор запроса, если сообщение отправлено в ответ на запрос |
=> | << Компонент Parties >> | N |
ChatMessage (35=UM)
Сообщение присылается на каждое сообщение в чате
Тэг | Поле | Наличие | Тип | Описание | Допустимые значения | |
---|---|---|---|---|---|---|
11002 | ChatID | Y | String | Уникальный идентификатор чата | ||
11003 | ChatMessageID | Y | String | Уникальный идентификатор сообщения |
60 | TransactTime | Y |
TransactTime | Время сообщения | |||||
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 | Роль участника |
|