Перейти к основному содержимому

PostTemplate

Отправляет шаблон документов.

POST /PostTemplate

Параметры запроса

  • operationId — идентификатор операции. Необязательный параметр, нерегистрочувствительный. Если вызов с указанным идентификатором операции завершился успехом, то и все последующие вызовы с тем же идентификатором операции также завершатся успехом. Результат всех последующих вызовов будет равен результату первого успешного вызова. По умолчанию в качестве идентификатора операции используется MD5-хэш тела запроса.

Заголовки запроса

Тело запроса

Тело запроса должно хранить содержимое шаблона, представленное структурой TemplateToPost.

Коды ответа

  • 200 — операция успешно завершена.
  • 204 — операция еще не завершена. В HTTP-заголовке ответа Retry-After указано время в секундах, через которое нужно повторить запрос.
  • 400 — данные в запросе имеют неверный формат или отсутствуют обязательные параметры.
  • 401 — в запросе отсутствует HTTP-заголовок Authorization или в этом заголовке содержатся некорректные авторизационные данные.
  • 402 — у указанного ящика закончилась подписка на API.
  • 403 — доступ к ящику с предоставленным авторизационным токеном запрещен.
  • 405 — используется неподходящий HTTP-метод.
  • 409 — осуществляется попытка отправить дубликат сообщения.
  • 415 — тип содержимого запроса не поддерживается.
  • 429 — превышено ограничение на количество запросов в единицу времени. Повторите запрос через время, указанное в HTTP-заголовке Retry-After.
  • 500 — при обработке запроса возникла непредвиденная ошибка.

Заголовки ответа

  • Retry-After — если в ответе содержится HTTP-заголовок Retry-After, то операция с указанным идентификатором еще не завершена или превышено ограничение на количество запросов (код ответа 429). В этом случае повторите вызов через указанное в заголовке время (в секундах).

Тело ответа

Тело ответа содержит отправленное сообщение, сериализованное в протобуфер Template.

При отправке шаблонов с одинаковым содержимым задайте каждому из них уникальный operationId. Это нужно для того, чтобы шаблоны с одним телом запроса получили разные идентификаторы операции и успешно доставились в Диадок.

Нельзя отправить шаблон, если отправитель или получатель отключен от оператора ЭДО (заполнено поле DisconnectionFromOperatorDate в структуре Organization).

Примеры использования

Пример HTTP-запроса:

POST /PostTemplate HTTP/1.1
Host: diadoc-api.kontur.ru
Authorization: Bearer {{access_token}}
Content-Type: application/json; charset=utf-8
Accept: application/json

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

{
"FromBoxId": "{{boxId_sender}}",
"ToBoxId": "{{boxId_recipient}}",
"MessageFromBoxId": "{{boxId_sender}}",
"MessageToBoxId": "{{boxId_recipient}}",
"DocumentAttachments": [
{
"UnsignedContent":
{
"Content": "PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0...NC50Ls+", // содержимое XML-файла в кодировке base-64
"Signature": "MIIN5QYJKoZIhvcNAQcCoIIN1jCCDdIA...kA9MJfsplqgW", // содержимое файла подписи в кодировке base-64
},
"EditingSettingId": "9D525B32-DE17-45B9-BE88-D8DBAB06A034",
"NeedReceipt":"true",
"TypeNamedId":"UniversalTransferDocument",
"Version":"utd970_05_03_01"
}
]
}

Пример тела ответа:

{
"MessageId": "a696ffd7-a294-42b1-bdfe-1ab0d13bdf56",
"TimestampTicks": 639058946899687613,
"FromBoxId": "09ae254c5cd0408284de7ccb46d86f82@diadoc.ru",
"ToBoxId": "1f208d032a604f6491b1b7aad54cfaf3@diadoc.ru",
"MessageFromBoxId": "09ae254c5cd0408284de7ccb46d86f82@diadoc.ru",
"MessageToBoxId": "1f208d032a604f6491b1b7aad54cfaf3@diadoc.ru",
"Entities": [
{
"EntityType": "Attachment",
"EntityId": "7ad5eada-7d50-4935-9aef-f35b8a5063f7",
"AuthorUserId": "",
"ParentEntityId": "",
"Content": {
"Size": 2244
},
"AttachmentType": "UniversalTransferDocument",
"FileName": "ON_NSCHFDOPPR_2BM-9644020274-964401000-202003110841117348216_2BM-9661310181-966101000-202003110849192021107_20250704_48478eaf-0b35-46bb-8497-aa0939d0bf09_0_0_0_0_0_00.xml",
"NeedRecipientSignature": false,
"DocumentInfo": {
"MessageId": "a696ffd7-a294-42b1-bdfe-1ab0d13bdf56",
"EntityId": "7ad5eada-7d50-4935-9aef-f35b8a5063f7",
"CreationTimestampTicks": 639058946899687613,
"CounteragentBoxId": "1f208d032a604f6491b1b7aad54cfaf3@diadoc.ru",
"DocumentType": "UniversalTransferDocument",
"InitialDocumentIds": [],
"SubordinateDocumentIds": [],
"Content": {
"Size": 2244
},
"FileName": "ON_NSCHFDOPPR_2BM-9644020274-964401000-202003110841117348216_2BM-9661310181-966101000-202003110849192021107_20250704_48478eaf-0b35-46bb-8497-aa0939d0bf09_0_0_0_0_0_00.xml",
"DocumentDate": "",
"IsDeleted": false,
"DepartmentId": "00000000-0000-0000-0000-000000000000",
"IsTest": false,
"FromDepartmentId": "00000000-0000-0000-0000-000000000000",
"ToDepartmentId": "00000000-0000-0000-0000-000000000000",
"RevocationStatus": "RevocationStatusNone",
"SendTimestampTicks": 639058946899687613,
"DeliveryTimestampTicks": 639058946899687613,
"ForwardDocumentEvents": [],
"RoamingNotificationStatus": "RoamingNotificationStatusNone",
"HasCustomPrintForm": false,
"CustomData": [],
"DocumentDirection": "Outbound",
"LastModificationTimestampTicks": 639058946899687613,
"IsEncryptedContent": false,
"SenderSignatureStatus": "WaitingForSenderSignature",
"IsRead": true,
"RoamingNotificationStatusDescription": "",
"PacketIsLocked": false,
"UniversalTransferDocumentMetadata": {
"DocumentStatus": "OutboundWaitingForSenderSignature",
"Total": "1.00",
"Vat": "",
"Grounds": "",
"DocumentFunction": "ДОП",
"Currency": 643,
"ConfirmationDateTimeTicks": 0,
"InvoiceAmendmentFlags": 0
},
"ProxySignatureStatus": "ProxySignatureStatusNone",
"TypeNamedId": "UniversalTransferDocument",
"Function": "ДОП",
"WorkflowId": 19,
"Title": "Шаблон УПД №____ от ____",
"Metadata": [
{
"Key": "FileName",
"Value": "ON_NSCHFDOPPR_2BM-9644020274-964401000-202003110841117348216_2BM-9661310181-966101000-202003110849192021107_20250704_48478eaf-0b35-46bb-8497-aa0939d0bf09_0_0_0_0_0_00.xml"
},
{
"Key": "TotalSum",
"Value": "1.00"
},
{
"Key": "CurrencyCode",
"Value": "643"
}
],
"RecipientReceiptMetadata": {
"ReceiptStatus": "GeneralReceiptStatusUnknown",
"ConfirmationMetadata": {
"ReceiptStatus": "GeneralReceiptStatusUnknown",
"DateTimeTicks": 0
}
},
"ConfirmationMetadata": {
"ReceiptStatus": "GeneralReceiptStatusUnknown",
"DateTimeTicks": 0
},
"RecipientResponseStatus": "RecipientResponseStatusUnknown",
"AmendmentRequestMetadata": {
"AmendmentFlags": 0,
"ReceiptStatus": "GeneralReceiptStatusUnknown"
},
"EditingSettingId": "9d525b32-de17-45b9-be88-d8dbab06a034",
"LockMode": "None",
"SenderReceiptMetadata": {
"ReceiptStatus": "GeneralReceiptStatusUnknown"
},
"Version": "utd970_05_03_01",
"LastOuterDocflows": [],
"DocflowStatus": {
"PrimaryStatus": {
"Severity": "Warning",
"StatusText": "Требуется создать документ"
}
},
"TtGisFixationCancellationStatus": "TtGisFixationCancellationStatusNone",
"MessageIdGuid": "a696ffd7-a294-42b1-bdfe-1ab0d13bdf56",
"EntityIdGuid": "7ad5eada-7d50-4935-9aef-f35b8a5063f7",
"CreationTimestamp": "2026-02-05T13:24:49.9687613Z"
},
"RawCreationDate": 639058946899687613,
"NeedReceipt": false,
"IsApprovementSignature": false,
"IsEncryptedContent": false,
"Labels": [],
"Version": "utd970_05_03_01",
"ContentTypeId": "utd970_dop_orig_t1_05_03_01"
}
],
"IsDeleted": false,
"MessageToDepartmentId": "",
"LockMode": "None",
"IsReusable": false
}

См. также

Инструкции:

Методы для работы с шаблонами:

  • PostTemplate — отправляет шаблон документа
  • PostTemplatePatch — отправляет дополнение к шаблону документа
  • TransformTemplateToMessage — cоздает из шаблона исходящее неотправленное сообщение

Оцените материал страницы

Нашли ошибку или столкнулись с проблемой?

СКБ Контурс 1988 года