Send a Windows Push Notification Service (WNS) native notification

2023-05-25

Sends a WNS native notification through a notification hub.

Request

Method	Request URI	HTTP version
POST	`https://{namespace}.servicebus.windows.net/{NotificationHub}/messages/?api-version=2015-01`	HTTP/1.1

Request headers

The following table describes required and optional request headers.

Request header	Description
Authorization	SAS token generated as specified in Shared Access Signature Authentication with Service Bus.
Content-Type	Set to `application/json;charset=utf-8` or `application/xml`. If the notification type (`X-WNS-Type`) is `wns/raw`, set to `application/octet-stream`.
ServiceBusNotification-Tags	`{single tag identifier}` (optional)
ServiceBusNotification-Format	Set to `windows`
X-WNS-	All headers starting with X-WNS will be forwarded to WNS.

Request body

The request body is an XML document as specified by WNS. If the notification is of type "wns/raw", the body is any text up to 5 Kb. For example:

<?xml version="1.0" encoding="utf-8" ?>
<toast>
    <visual lang="en-US">
        <binding template="ToastText01">
            <text id="1">
                This is my toast message for Win8!
            </text>
        </binding>
    </visual>
</toast>

Response

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

Response codes

Code	Description
200	Message successfully sent.
400	The request is malformed (for example, not valid routing headers, not valid content-type, message exceeds size, bad message format).
401	Authorization failure. The access key was incorrect.
403	Quota exceeded or message too large; message was rejected.
404	No message branch at the URI.
413	Requested entity too large. The message size cannot be over 64 Kb.

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

Response headers

Response header	Description
Location	This header is only available for Standard tier Notification Hubs. This header will contain the Notification Message ID. It's used with per message telemetry and correlating PNS Feedback. The ___location header uses the following format: `https://{your namespace}.servicebus.windows.net/{your hub name}/messages/{notification message id}?api-version=2015-04`

Response body

None.

Share via