GenerateUniversalMessage
Генерирует файл универсального сообщения (УС).
POST /GenerateUniversalMessage
Параметры запроса
boxId— идентификатор ящика организации в формате GUID.messageId— идентификатор сообщения.attachmentId— идентификатор сущности документа, для которого нужно сгенерировать универсальное сообщение. Такой сущностью может быть: - для извещения о получении (УС с кодом 1999): титул отправителя, титул получателя или уведомление об уточнении; - для запроса подтверждения полномочий (УС с кодом 2007): титул отправителя или титул получателя; - для уведомления об уточнении (УС с кодом 2999): титул отправителя; - для отказа в подписи (УС с кодом 3999): титул отправителя, предложение об аннулировании; - для информационных сообщений (УС с кодами 4002 и 4003): титул отправителя или титул получателя.
Заголовки запроса
Authorization— данные, необходимые для авторизации.
Тело запроса
Тело запроса должно содержать упрощенный XML-файл с данными для формирования универсального сообщения, соответствующий упрощенной XSD-схеме. Все элементы UniversalMessageInfo должны содержать один и тот же код в атрибуте StatusCode, при этом метод принимает несколько элементов с одинаковым кодом. Единственное исключение — сочетание кодов 2007 и 2999 в одном запросе: оно допустимо, если attachmentId указывает на первый титул отправителя.
Коды ответа
200— операция успешно завершена.400— некорректные параметры запроса или содержимое XML-файла.401— в запросе отсутствует HTTP-заголовокAuthorizationили в этом заголовке содержатся некорректные авторизационные данные.402— у указанного ящика закончилась подписка на API.403— доступ к ящику или документу с предоставленным авторизационным токеном запрещен.404— в указанном ящике нет сообщения с указаннымmessageId.405— используется неподходящий HTTP-метод.409— невозможно сформировать универсальное сообщение для указанной сущности.429— превышено ограничение на количество запросов в единицу времени.500— при обработке запроса возникла непредвиденная ошибка.
Заголовки ответа
Content-Disposition— имя XML-файла универсального сообщения.
Тело ответа
Тело ответа содержит XML-файл универсального сообщения для сущности attachmentId из сообщения messageId в ящике boxId, соответствующий XSD-схеме.
УС с кодом 2007 можно сгенерировать только после окончания переходного периода. УС с кодами 4002 и 4003 можно сгенерировать в любой момент, но их отправка до окончания переходного периода для этого документооборота вернет ошибку.
Возможность отправки УС в качестве извещения о получении (ИоП) для каждого типа документа указана в свойствах вида документооборота документа:
- на титулы отправителя и получателя — в свойстве «ИоП на титул участника» (
TitleReceiptBehavior), - на уведомление об уточнении — в свойстве «Ответное действие на УоУ» (
AmendmentRequestResponseBehavior);
Сгенерированный файл можно отправить методом PostMessagePatch (V4), передав его в поле UniversalMessages структуры MessagePatchToPostV2. Инструкция приведена в разделе Отправка универсального сообщения.
Примеры использования
Пример HTTP-запроса:
POST /GenerateUniversalMessage?boxId={{boxId}}&messageId={{messageId}}&attachmentId={{attachmentId}} HTTP/1.1
Host: diadoc-api.kontur.ru
Authorization: Bearer {{access_token}}
Content-Type: application/xml; charset=utf-8
Accept: application/xml
Пример тела запроса:
<UniversalMessage>
<UniversalMessageInfos>
<UniversalMessageInfo StatusCode="1999">
<PlainText>123</PlainText>
</UniversalMessageInfo>
</UniversalMessageInfos>
<Sender Position="Сотрудник" UseDefaultPersonInfo="false">
<Fio FirstName="Иван" LastName="Иванов" MiddleName="Иванович"/>
<Contacts OtherContactInfo="OtherContactInfo">
<Phones>
<Phone>8-343-123-4567</Phone>
</Phones>
<Emails>
<Email>email@sample.com</Email>
</Emails>
</Contacts>
</Sender>
<Recipient Position="Сотрудник" UseDefaultPersonInfo="false">
<Fio FirstName="Петров" LastName="Петр" MiddleName="Петрович"/>
<Contacts OtherContactInfo="OtherContactInfo">
<Phones>
<Phone>8-343-123-4567</Phone>
</Phones>
<Emails>
<Email>email@sample.com</Email>
</Emails>
</Contacts>
</Recipient>
</UniversalMessage>
Пример тела ответа:
<?xml version="1.0" encoding="windows-1251"?>
<Файл ИдФайл="DP_UNISOOBSCH_2BM-6125600340-732644841-202407101103418496883_2BM-9147414342-757645784-202407101104400484330_20250529_3839e349-99d5-4a54-9b5f-546bffbfb44a" ВерсПрог="Diadoc 1.0" ВерсФорм="5.01">
<Документ КНД="1115144">
<СведУС ДатаФорм="29.05.2025" ВремФорм="13.53.27" ИмяПолФайл="ON_NSCHFDOPPR_2BM-9147414342-757645784-202407101104400484330_2BM-6125600340-732644841-202407101103418496883_20250207_30f13ccc-deb2-4d49-8201-0ab211e8683d" />
<СвСобытДок СтатусУС="1999">
<ТекстУС>123</ТекстУС>
</СвСобытДок>
<ОтпрУС ИдОтпрУС="2BM-9147414342-757645784-202407101104400484330">
<СвЛицОтпрУС Должн="Сотрудник">
<ФИО Фамилия="Иванов" Имя="Иван" Отчество="Иванович" />
<Контакт>
<Тлф>8-343-123-4567</Тлф>
<ЭлПочта>email@google.com</ЭлПочта>
<ИнКонт>OtherContactInfo</ИнКонт>
</Контакт>
</СвЛицОтпрУС>
</ОтпрУС>
<ПолучУС ИдПолучУС="2BM-6125600340-732644841-202407101103418496883">
<СвЛицПолучУС Должн="Сотрудник">
<ФИО Фамилия="Петр" Имя="Петров" Отчество="Петрович" />
<Контакт>
<Тлф>8-343-123-4567</Тлф>
<ЭлПочта>email@google.com</ЭлПочта>
<ИнКонт>OtherContactInfo</ИнКонт>
</Контакт>
</СвЛицПолучУС>
</ПолучУС>
</Документ>
</Файл>
См. также
Инструкции: