GenerateUniversalMessage

Генерирует файл универсального сообщения (УС).

POST /GenerateUniversalMessage

Query Parameters:

boxId – идентификатор ящика организации.
messageId – идентификатор сообщения.
attachmentId –
идентификатор сущности документа, для которого нужно сгенерировать универсальное сообщение. Такой сущностью может быть:
- для извещения о получении (УС с кодом 1999): титул отправителя, титул получателя или уведомление об уточнении;
- для уведомления об уточнении (УС с кодом 2999): титул отправителя;
- для отказа в подписи (УС с кодом 3999): титул отправителя, предложение об аннулировании.

Request Headers:

Authorization – данные, необходимые для авторизации.

Request Body:

Тело запроса должно содержать упрощенный XML-файл с данными для формирования универсального сообщения, соответствующий упрощенной XSD-схеме.

Status Codes:

200 OK – операция успешно завершена.
400 Bad Request – данные в запросе имеют неверный формат, или отсутствуют обязательные параметры, или указаны коды УС из разных групп, или переданный XML-файл не соответствут XSD-схеме.
401 Unauthorized – в запросе отсутствует HTTP-заголовок Authorization или в этом заголовке содержатся некорректные авторизационные данные.
402 Payment Required – у указанного ящика закончилась подписка на API.
403 Forbidden – доступ к ящику или документу с предоставленным авторизационным токеном запрещен.
404 Not Found – не найдены документ или сообщение с указанным идентификатором или указанная сущность имеет неверный тип.
405 Method Not Allowed – используется неподходящий HTTP-метод.
409 Conflict – невозможно сформировать универсальное сообщение для указанной сущности.
500 Internal Server Error – при обработке запроса возникла непредвиденная ошибка.

Response Headers:

Content-Disposition – имя XML-файла универсального сообщения.

Response Body:

Тело ответа содержит XML-файл универсального сообщения для сущности attachmentId из сообщения messageId в ящике boxId, соответствующий XSD-схеме.

Возможность отправки УС в качестве извещения о получении (ИоП) для каждого типа документа указана в свойствах вида документооборота документа:

на титулы отправителя и получателя — в свойстве «ИоП на титул участника» (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

Пример тела запроса:

<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</ИнКонт>
        </Контакт>
      </СвЛицПолучУС>
    </ПолучУС>
  </Документ>
</Файл>

См. также

Инструкции: