GetMessage (V5)
Предупреждение
После окончания переходного периода эта версия метода перестанет работать и будет возвращать ошибки. Используйте новую версию метода — GetMessage (V6).
Возвращает данные сообщения по указанному идентификатору.
- GET /V5/GetMessage
- Query Parameters:
boxId – идентификатор ящика организации.
messageId – идентификатор сообщения.
entityId – идентификатор документа в сообщении. Необязательный параметр. Если указан, то вернутся только сущности, связанные с указанным документом.
originalSignature – тип возвращаемой подписи. Необязательный параметр. Если указан, то возвращается оригинальная подпись. Если не указан, то возвращается подпись в формате CADES-T, а в качестве родительской сущности будет указан подписанный документ.
injectEntityContent – признак того, что в результат нужно включить содержимое документа. Если указано значение
true, то содержимое документа будет добавлено в поле ответаContent.Data. Необязательный параметр, по умолчанию равенfalse. Обратите внимание, что добавление содержимого замедляет работу метода.
- Request Headers:
Authorization – данные, необходимые для авторизации.
- Status Codes:
200 OK – операция успешно завершена.
400 Bad Request – данные в запросе имеют неверный формат или отсутствуют обязательные параметры.
401 Unauthorized – в запросе отсутствует HTTP-заголовок
Authorizationили в этом заголовке содержатся некорректные авторизационные данные.402 Payment Required – у указанного ящика закончилась подписка на API.
403 Forbidden – доступ к ящику с предоставленным авторизационным токеном запрещен.
404 Not Found – в указанном ящике нет сообщения с указанным идентификатором.
405 Method Not Allowed – используется неподходящий HTTP-метод.
500 Internal Server Error – при обработке запроса возникла непредвиденная ошибка.
- Response Body:
Тело ответа содержит сообщение с идентификатором
messageIdиз ящикаboxId, представленное структурой Message. Сообщение будет содержать в том числе сущности всех дополнений сообщения.
Для выполнения метода текущий пользователь должен иметь доступ ко всем документам в сообщении, иначе метод вернет ошибку 403 (Forbidden). Если в запросе был указан параметр entityId, то доступ требуется только к указанному документу.
Метод вернет всю информацию, которая относится к указанному сообщению, в том числе содержимое документов и подписей. Обратите внимание, что суммарный размер содержимого всех сущностей, хранящихся в поле Data структуры Content, не может превышать 1 048 576 байт. Если при добавлении содержимого очередного документа этот размер будет превышен, то такое содержимое не будет добавлено в ответ. Если для каких-то документов содержимое не было получено в ответе метода, его можно получить с помощью метода GetEntityContent (V4).
Примеры использования
Пример HTTP-запроса:
GET /V5/GetMessage?boxId={{boxId}}&messageId={{messageId}}&entityId={{entityId}}&injectEntityContent=false HTTP/1.1
Host: diadoc-api.kontur.ru
Authorization: Bearer {{access_token}}
Accept: application/json; charset=utf-8
Content-Type: application/json
Пример тела ответа:
{
"MessageId": "a6865acc-050a-432f-9a77-548e32a3c7c8",
"TimestampTicks": 638841169138072584,
"LastPatchTimestampTicks": 638841169141027588,
"FromBoxId": "09ae254c5cd0408284de7ccb46d86f82@diadoc.ru",
"FromTitle": "Организация-отправитель",
"ToBoxId": "1f208d032a604f6491b1b7aad54cfaf3@diadoc.ru",
"ToTitle": "Организация-получатель",
"Entities": [
{
"EntityType": "Attachment",
"EntityId": "8422e22f-ee03-45b6-b62d-257e99c755d5",
"AuthorUserId": "",
"ParentEntityId": "",
"Content": {
"Size": 32837
},
"AttachmentType": "Contract",
"FileName": "FileName.png",
"NeedRecipientSignature": true,
"DocumentInfo": {
"MessageId": "a6865acc-050a-432f-9a77-548e32a3c7c8",
"EntityId": "8422e22f-ee03-45b6-b62d-257e99c755d5",
"CreationTimestampTicks": 638841169138072584,
"CounteragentBoxId": "1f208d032a604f6491b1b7aad54cfaf3@diadoc.ru",
"DocumentType": "Contract",
"InitialDocumentIds": [],
"SubordinateDocumentIds": [],
"Content": {
"Size": 32837
},
"FileName": "FileName.png",
"DocumentDate": "29.05.2025",
"DocumentNumber": "23",
"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": 638841169138072584,
"DeliveryTimestampTicks": 638841169141027588,
"ForwardDocumentEvents": [],
"ContractMetadata": {
"DocumentStatus": "OutboundWaitingForRecipientSignature",
"ContractPrice": "23",
"ContractType": "",
"ReceiptStatus": "ReceiptStatusNone"
},
"RoamingNotificationStatus": "RoamingNotificationStatusNone",
"HasCustomPrintForm": false,
"CustomData": [],
"DocumentDirection": "Outbound",
"LastModificationTimestampTicks": 638841169141027588,
"IsEncryptedContent": false,
"SenderSignatureStatus": "SenderSignatureCheckedAndValid",
"IsRead": true,
"PacketIsLocked": false,
"ProxySignatureStatus": "ProxySignatureStatusNone",
"TypeNamedId": "Contract",
"Function": "default",
"WorkflowId": 2,
"Title": "Договор №23 от 29.05.25",
"Metadata": [
{
"Key": "FileName",
"Value": "FileName.png"
},
{
"Key": "DocumentNumber",
"Value": "23"
},
{
"Key": "DocumentDate",
"Value": "29.05.2025"
},
{
"Key": "CurrencyCode",
"Value": "643"
},
{
"Key": "ContractPrice",
"Value": "23"
}
],
"RecipientReceiptMetadata": {
"ReceiptStatus": "GeneralReceiptStatusNotAcceptable",
"ConfirmationMetadata": {
"ReceiptStatus": "GeneralReceiptStatusNotAcceptable",
"DateTimeTicks": 0
}
},
"ConfirmationMetadata": {
"ReceiptStatus": "GeneralReceiptStatusNotAcceptable",
"DateTimeTicks": 638841169141027588
},
"RecipientResponseStatus": "WaitingForRecipientSignature",
"AmendmentRequestMetadata": {
"AmendmentFlags": 0,
"ReceiptStatus": "GeneralReceiptStatusNotAcceptable"
},
"EditingSettingId": "",
"LockMode": "None",
"SenderReceiptMetadata": {
"ReceiptStatus": "GeneralReceiptStatusNotAcceptable"
},
"Version": "v1",
"LastOuterDocflows": [],
"DocflowStatus": {
"PrimaryStatus": {
"Severity": "Warning",
"StatusText": "Ожидается подпись контрагента"
},
"PowerOfAttorneyGeneralStatus": {
"Severity": "Warning",
"StatusNamedId": "IsNotAttached",
"StatusText": "Не приложена доверенность",
"Errors": []
}
},
"TtGisFixationCancellationStatus": "TtGisFixationCancellationStatusNone",
"MessageIdGuid": "a6865acc-050a-432f-9a77-548e32a3c7c8",
"EntityIdGuid": "8422e22f-ee03-45b6-b62d-257e99c755d5",
"CreationTimestamp": "2025-05-29T12:01:53.8072584Z"
},
"RawCreationDate": 638841169138072584,
"NeedReceipt": false,
"IsApprovementSignature": false,
"IsEncryptedContent": false,
"Labels": [],
"Version": "v1",
"ContentTypeId": "contract_01"
},
{
"EntityType": "Attachment",
"EntityId": "adbdf5b1-93b1-4ba6-b72e-e6acbfe6960f",
"AuthorUserId": "",
"ParentEntityId": "8422e22f-ee03-45b6-b62d-257e99c755d5",
"Content": {
"Size": 40
},
"AttachmentType": "AttachmentComment",
"NeedRecipientSignature": false,
"RawCreationDate": 638841169138072584,
"NeedReceipt": false,
"IsApprovementSignature": false,
"IsEncryptedContent": false,
"Labels": [],
"ContentTypeId": ""
},
{
"EntityType": "Signature",
"EntityId": "88c3511a-a6de-4d84-b01f-55dc3452d87d",
"AuthorUserId": "9aa516d1-eec7-4e09-b11e-8772d081a4fa",
"ParentEntityId": "8422e22f-ee03-45b6-b62d-257e99c755d5",
"Content": {
"Size": -1
},
"AttachmentType": "Nonformalized",
"NeedRecipientSignature": false,
"SignerBoxId": "09ae254c5cd0408284de7ccb46d86f82@diadoc.ru",
"RawCreationDate": 638841169141027588,
"SignerDepartmentId": "00000000-0000-0000-0000-000000000000",
"NeedReceipt": false,
"IsApprovementSignature": false,
"IsEncryptedContent": false,
"Labels": [],
"ContentTypeId": "",
"PowerOfAttorneyAttachmentStatus": {
"StatusName": "PowerOfAttorneyRequired",
"Comment": "Документ подписан сертификатом физ. лица без МЧД"
}
},
{
"EntityType": "Attachment",
"EntityId": "269f2463-484e-412d-b769-5e6c2b719162",
"AuthorUserId": "",
"ParentEntityId": "8422e22f-ee03-45b6-b62d-257e99c755d5",
"Content": {
"Size": 5208
},
"AttachmentType": "InvoiceConfirmation",
"FileName": "DP_PDPOL_2BM-6125600340-732644841-202407101103418496883_2BM_20250529_269f2463-484e-412d-b769-5e6c2b719162.xml",
"NeedRecipientSignature": false,
"RawCreationDate": 638841169141027588,
"NeedReceipt": false,
"IsApprovementSignature": false,
"IsEncryptedContent": false,
"Labels": [],
"ContentTypeId": "send_confirmation_133_01_03"
},
{
"EntityType": "Signature",
"EntityId": "8f77de9f-2ffb-491e-b9ba-4207e0e20ee0",
"AuthorUserId": "",
"ParentEntityId": "269f2463-484e-412d-b769-5e6c2b719162",
"Content": {
"Size": -1
},
"AttachmentType": "Nonformalized",
"NeedRecipientSignature": false,
"SignerBoxId": "00000000000000000000000000000000@diadoc.ru",
"RawCreationDate": 638841169141027588,
"SignerDepartmentId": "00000000-0000-0000-0000-000000000000",
"NeedReceipt": false,
"IsApprovementSignature": false,
"IsEncryptedContent": false,
"Labels": [],
"ContentTypeId": "",
"PowerOfAttorneyAttachmentStatus": {
"StatusName": "PowerOfAttorneyNotRequired"
}
}
],
"IsDraft": false,
"DraftIsLocked": false,
"DraftIsRecycled": false,
"CreatedFromDraftId": "",
"DraftIsTransformedToMessageIdList": [],
"IsDeleted": false,
"IsTest": false,
"IsInternal": false,
"IsProxified": false,
"ProxyBoxId": "",
"ProxyTitle": "",
"PacketIsLocked": false,
"LockMode": "None",
"MessageType": "Letter",
"IsReusable": false
}
См. также
- Методы для работы с сообщением:
GetMessage (V5) — возвращает данные сообщения по указанному идентификатору
GetMessage (V6) — возвращает данные сообщения по указанному идентификатору
PostMessage (V3) — отправляет сообщение
PostMessagePatch (V3) — отправляет дополнение к сообщению
PostMessagePatch (V4) — отправляет дополнение к сообщению
TransformTemplateToMessage — создает из шаблона исходящее неотправленное сообщение
- Устаревшие версии метода: