SALES: 1-800-867-1380

Delete Message

Updated: August 13, 2014

This operation completes the processing of a locked message and deletes it from the queue or subscription. This operation should only be called after successfully processing a previously locked message, in order to maintain At-Least-Once delivery assurances.

 

Method Request URI HTTP Version

DELETE

http{s}://{serviceNamespace}.servicebus.windows.net/{queuePath}/messages/{messageId|sequenceNumber}/{lockToken}

or

http{s}://{serviceNamespace}.servicebus.windows.net/{topicPath}/subscriptions/{subscriptionName}/messages/{messageId|sequenceNumber}/{lockToken}

HTTP/1.1

The URI is provided in the Location header of the peeked message, or you can construct it from the parts described in the following table.

 

Parameter Description

messageId

The ID of the message to be deleted as returned in BrokerProperties{MessageId} by the Peek Message operation.

sequence-number

The sequence number of the message to be deleted as returned in BrokerProperties{SequenceNumber} by the Peek Message operation.

lockToken

The token of the lock of the message to be deleted as returned by the Peek Message operation in BrokerProperties{LockToken}.

The following table describes required and optional request headers. In addition to the listed properties, the header can contain custom properties. See the example.

 

Request Header Description

Authorization

Specifies one of the following:

  • A WRAPv0.9.7.2 token containing a SimpleWebToken acquired from ACS. Set to WRAP access_token=”{swt}”.

  • A SAS token.

The response includes an HTTP status code, a set of response headers, and the response body.

 

Code Description

200

Message successfully deleted.

401

Authorization failure.

404

No message was found with the specified MessageId or LockToken.

410

Specified queue or subscription does not exist.

500

Internal error.

For information about status codes, see Status and Error Codes.

 

Response Header Description

Content-Type

Set to application/atom+xml;type=entry;charset=utf-8.

The following HTTP request deletes a message from a queue:

DELETE https://your-namespace.servicebus.windows.net/HttpClientSampleQueue/messages/31907572-1647-43c3-8741-631acd554d6f/7da9cfd5-40d5-4bb1-8d64-ec5a52e1c547?timeout=60 HTTP/1.1
Authorization: SharedAccessSignature sr=rukochbay&sig=rg9iGsK0ZyYlvhIqyH5IS5tqmeb08h8FstjHLPj3%2f8g%3d&se=1404265946&skn=RootManageSharedAccessKey
Host: your-namespace.servicebus.windows.net
Content-Length: 0

Service Bus returns the following response:

HTTP/1.1 200 OK
Transfer-Encoding: chunked
Content-Type: application/xml; charset=utf-8
Server: Microsoft-HTTPAPI/2.0
Date: Tue, 01 Jul 2014 23:00:35 GMT

0

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft