Сообщение

Сообщение — набор взаимосвязанных сущностей, — пользовательских и служебных документов, — хранящийся в ящике организации.

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

Из сообщения можно получить сущности (например, титулы, ИоП, подписи, комментарии и т.п.) и работать с каждой из них отдельно.

Дополнение к сообщению

Дополнение к сообщению — это каждый новый документ, добавленный к сообщению после его создания.

Сообщение создается при отправке документа, а затем дополняется новыми документами — пользовательскими или служебными. Пример:

  • Организация отправляет контрагенту накладную — на данном этапе сообщение включает в себя титул и подпись отправителя.

  • Контрагент извещает о получении накладной, подписывает ее и отправляет ответный титул — после каждого действия в сообщение добавляются дополнения: ИоП, подпись и титул получателя.

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


См. также

Представление в API:
  • Message — данные сообщения или черновика

  • MessagePatch — данные дополнения к сообщению

Инструкции:
Методы для работы с сообщением:
  • GetMessage (V5) — возвращает данные сообщения по указанному идентификатору

  • GetMessage (V6) — возвращает данные сообщения по указанному идентификатору

  • PostMessage (V3) — отправляет сообщение

  • PostMessagePatch (V3) — отправляет дополнение к сообщению

  • PostMessagePatch (V4) — отправляет дополнение к сообщению

  • TransformTemplateToMessage — создает из шаблона исходящее неотправленное сообщение