Yandex.Cloud
  • Services
  • Why Yandex.Cloud
  • Pricing
  • Documentation
  • Contact us
Get started
Yandex Message Queue
  • Getting started
    • Quick start
    • Supported tools
    • Code samples
      • Node.js
      • PHP
      • JMS
      • Laravel
      • Terraform
  • Step-by-step instructions
    • Overview
    • Creating a new message queue
    • Sending messages
    • Receiving and deleting messages
    • Deleting a message queue
  • Concepts
    • Overview
    • Message queues
    • Messages
    • Deduplication
    • Visibility timeout
    • Long Polling
    • Dead Letter Queue
    • Delay queues
    • Quotas and limits
  • Access management
  • Pricing policy
  • Yandex Message Queue API
    • Overview
    • Queue
      • CreateQueue
      • DeleteQueue
      • GetQueueAttributes
      • GetQueueUrl
      • ListQueues
      • PurgeQueue
      • SetQueueAttributes
    • Message
      • ChangeMessageVisibility
      • ChangeMessageVisibilityBatch
      • DeleteMessage
      • DeleteMessageBatch
      • ReceiveMessage
      • SendMessage
      • SendMessageBatch
    • Data types
      • BatchResultErrorEntry
      • ChangeMessageVisibilityBatchRequestEntry
      • ChangeMessageVisibilityBatchResultEntry
      • DeleteMessageBatchRequestEntry
      • DeleteMessageBatchResultEntry
      • Message
      • MessageAttributeValue
      • SendMessageBatchRequestEntry
      • SendMessageBatchResultEntry
    • Common errors
  • Questions and answers
  1. Yandex Message Queue API
  2. Message
  3. DeleteMessageBatch

DeleteMessageBatch

  • Request
    • Request parameters
  • Response
    • Successful response fields
    • DeleteMessageBatch errors
  • Sample request
  • Response example

Method for deleting multiple messages from a queue. You can delete up to 10 messages at once.

The result of changing each message's visibility timeout is reported individually in the response. Since a message can be deleted successfully or this action may fail, you should check all the results, even if code 200 is returned in response to the DeleteMessageBatch method call.

Request

Request parameters

Parameter Type Required parameter Description
QueueUrl string Yes URL of the queue where the message is placed.
DeleteMessageBatchRequestEntry.N array Yes The DeleteMessageBatchRequestEntry array that contains the ReceiptHandleparameters of the messages to be deleted.

Response

Successful response fields

Field Type Description
BatchResultErrorEntry.N array The BatchResultErrorEntry array with request result error descriptions.
DeleteMessageBatchResultEntry.N array The DeleteMessageBatchResultEntry array with the IDs of the messages that have been deleted.

DeleteMessageBatch errors

For a list of errors common for all methods, see Common errors.

HTTP code Error ID Description
400 BatchEntryIdsNotDistinct Two or more batch entries in the request have the same ID.
400 EmptyBatchRequest The batch request doesn't contain any entries.
400 InvalidBatchEntryId The ID of a batch entry is invalid.
400 TooManyEntriesInBatchRequest Too many entries in a batch.

Sample request

Action=DeleteMessageBatch
&Version=2012-11-05
&QueueUrl=https://message-queue.api.cloud.yandex.net/b1g8ad42m6he1ooql78r/dj600000000000le07ol/sample-queue
&DeleteMessageBatchRequestEntry.1.Id=dd2dd32b-eb1e7a37-f6b7a725-1555483
&DeleteMessageBatchRequestEntry.1.ReceiptHandle=EAEg89fvhogtKAM
&DeleteMessageBatchRequestEntry.2.Id=7e0e07f6-5c9a0a72-d304102f-1532995
&DeleteMessageBatchRequestEntry.2.ReceiptHandle=EAEgq5vvhogtKAI

For more information about forming requests, see General API request format.

Response example

<DeleteMessageBatchResponse>
    <DeleteMessageBatchResult>
        <DeleteMessageBatchResultEntry>
            <Id>dd2dd32b-eb1e7a37-f6b7a725-1555483</Id>
        </DeleteMessageBatchResultEntry>
        <DeleteMessageBatchResultEntry>
            <Id>7e0e07f6-5c9a0a72-d304102f-1532995</Id>
        </DeleteMessageBatchResultEntry>
    </DeleteMessageBatchResult>
    <ResponseMetadata>
        <RequestId>e02ca0b-5e6b6d98-cef0a99c-150a53b3-07ee55365ba1b6fd876875f0ae18068e</RequestId>
    </ResponseMetadata>
</DeleteMessageBatchResponse>
In this article:
  • Request
  • Request parameters
  • Response
  • Successful response fields
  • DeleteMessageBatch errors
  • Sample request
  • Response example
Language
Careers
Privacy policy
Terms of use
© 2021 Yandex.Cloud LLC