SendMessage

Метод для отправки сообщения в указанную очередь. В теле сообщения можно передавать только XML, JSON и неформатированный текст.

Запрос

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

Параметр Тип Обязательный параметр Описание
DelaySeconds integer Нет Время в секундах, на которое сообщение будет скрыто после отправки. Возможные значения: от 0 до 900. Если параметр не указан, используется значение параметра из очереди. Параметр не работает для сообщений, отправляемых в очереди FIFO — в этом случае используется параметр из очереди.
MessageAttributeName.N
MessageAttributeValue.N
array Нет Массив имен и соответствующих им значений пользовательских атрибутов сообщения. См. тип данных Message.
QueueUrl string Да URL очереди, в которой находится сообщение.
MessageBody string Да Тело отправляемого сообщения. Максимальный размер — 256 КБ. Может содержать структуры XML, JSON и неформатированный текст. Поддерживаются следующие символы Unicode:
  • #x9
  • #xA
  • #xD
  • от #x20 до #xD7FF
  • от #xE000 до #xFFFD
  • от #x10000 до #x10FFFF

Параметры очередей FIFO

Параметр Тип Обязательный параметр Описание
MessageDeduplicationId string Нет Идентификатор токена для дедупликации сообщений, используется в очередях FIFO. Каждое сообщение должно иметь уникальный MessageDeduplicationId. Если MessageDeduplicationId не указан, отправка сообщения в очередь не будет выполнена. Максимальная длина — 128 символов. Разрешено использование цифр, больших и маленьких латинских букв и знаков пунктуации. Подробнее см. Дедупликация.
MessageGroupId string Нет Идентификатор группы сообщений, используется в очередях FIFO. Максимальная длина — 128 символов. Разрешено использование цифр, больших и маленьких латинских букв и знаков пунктуации. Подробнее см. Дедупликация.

Ответ

Поля успешного ответа

Поле Тип Описание
MD5OfMessageAttributes string MD5-хэш строки атрибута.
MD5OfMessageBody string MD5-хэш тела сообщения.
MessageId string Идентификатор отправленного сообщения.
SequenceNumber string Номер сообщения, используется в очередях FIFO в рамках группы сообщений с одинаковым MessageGroupId. Длина номера — 128 бит, SequenceNumber наращивается в пределах группы с одинаковым MessageGroupId.

Ошибки SendMessage

Перечень общих для всех методов ошибок смотрите в разделе Стандартные ошибки.

Код HTTP Идентификатор ошибки Описание
400 UnsupportedOperation Неподдерживаемая операция.
400 InvalidMessageContents В сообщении есть запрещенные символы.

Пример запроса

Action=SendMessage
&Version=2012-11-05
&QueueUrl=https://message-queue.api.cloud.yandex.net/b1g8ad42m6he1ooql78r/dj600000000000le07ol/sample-queue
&MessageBody=Hello+world

Подробнее о формировании запросов см. в разделе Общий вид запросов к API.

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

<SendMessageResponse>
    <SendMessageResult>
        <MD5OfMessageBody>3e25960a79dbc69b674cd4ec67a72c62</MD5OfMessageBody>
        <MessageId>cddcbbe4-b0571f5c-d7b94ce4-1523191</MessageId>
    </SendMessageResult>
    <ResponseMetadata>
        <RequestId>75eb03b2-fba0e60e-b1c5641-12f7a5bc-2bf4e677831c06c5f9d7ea1063ffeb3f</RequestId>
    </ResponseMetadata>
</SendMessageResponse>