PostMessage (V3)

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

POST /V3/PostMessage
Query Parameters:

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

Request Headers:
Request Body:

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

Status Codes:

  • 200 OK – операция успешно завершена.

  • 204 No Content – операция еще не завершена. В HTTP-заголовке ответа Retry-After указано время в секундах, через которое нужно повторить запрос.

  • 400 Bad Request – данные в запросе имеют неверный формат, или отсутствуют обязательные параметры, или превышено максимально допустимое количество документов в сообщении.

  • 401 Unauthorized – в запросе отсутствует HTTP-заголовок Authorization или в этом заголовке содержатся некорректные авторизационные данные.

  • 402 Payment Required – у указанного ящика закончилась подписка на API.

  • 403 Forbidden – доступ к ящику с предоставленным авторизационным токеном запрещен или организация ликвидирована.

  • 405 Method Not Allowed – используется неподходящий HTTP-метод.

  • 409 Conflict – осуществляется попытка отправить дубликат сообщения или запрещен прием документов от контрагентов согласно свойству Sociability в структуре Organization.

  • 500 Internal Server Error – при обработке запроса возникла непредвиденная ошибка.

Response Headers:

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

Response Body:

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

В одном сообщении можно отправить не более 40 документов.

См. также

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

  • GetMessage (V5) — возвращает данные сообщения по указанному идентификатору

  • GetMessage (V6) — возвращает данные сообщения по указанному идентификатору

  • PostMessage (V3) — отправляет сообщение

  • PostMessagePatch (V3) — отправляет дополнение к сообщению

  • PostMessagePatch (V4) — отправляет дополнение к сообщению

  • TransformTemplateToMessage — создает из шаблона исходящее неотправленное сообщение

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

  • PostMessage (V3) — отправляет сообщение

  • RecycleDraft — удаляет еще не утилизированные черновики

  • SendDraft — отправляет сообщение, созданное из черновика