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

PostMessagePatch (V3)

warning

Метод устарел и будет удален из API после 03 апреля 2027 года. Подробнее в истории изменений. Для работы с универсальными сообщениями используйте новую версию метода — PostMessagePatch (V4).

Отправляет дополнение к сообщению.

POST /V3/PostMessagePatch

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

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

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

Тело запроса

Тело запроса должно содержать отправляемое дополнение к сообщению, представленное структурой MessagePatchToPost.

Коды ответа

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

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

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

Тело ответа

Тело ответа содержит отправленное дополнение, представленное структурой MessagePatch.

Для выполнения метода текущий пользователь должен иметь доступ ко всем документам, для которых формирует дополнения, иначе метод вернет ошибку 403 (Forbidden).

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

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

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

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

{
"BoxId": "{{boxId}}",
"MessageId": "bbcedb0d-ce34-4e0d-b321-3f600c920935",
"RecipientTitles": [
{
"ParentEntityId":"30cf2c07-7297-4d48-bc6f-ca7a80e2cf95&",
"SignedContent":
{
"Content": "PD94bWwgdmVyc2l...LDQudC7Pg==", // содержимое XML-файла в кодировке base-64
"Signature": "MIIN5QYJKoZIhvc...KsTM6zixgz" // содержимое файла подписи в кодировке base-64
}
}
]
}

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

{
"MessageId": "bbcedb0d-ce34-4e0d-b321-3f600c920935",
"TimestampTicks": 639046584722481846,
"Entities": [],
"ForDraft": false,
"DraftIsRecycled": false,
"DraftIsTransformedToMessageIdList": [],
"DraftIsLocked": false,
"MessageIsDeleted": false,
"EntityPatches": [],
"MessageIsRestored": false,
"MessageIsDelivered": false,
"PatchId": "02988e7d-0623-488a-a883-1475e3fb927f",
"MessageType": "Letter"
}

См. также

Инструкции:

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

  • CanPostMessage — проверяет возможность отправки сообщения с указанными параметрами
  • GetMessage (V6) — возвращает данные сообщения по указанному идентификатору
  • PostMessage (V3) — отправляет сообщение
  • PostMessagePatch (V4) — отправляет дополнение к сообщению
  • TransformTemplateToMessage — создает из шаблона исходящее неотправленное сообщение

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

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

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