Direct Send
Sends a notification directly to a device handle (a valid token as expressed by the Notification type). Users of this API do not need to use Registrations or Installations. Instead, users of this API manage all devices on their own and use Azure Notification Hub solely as a pass through service to communicate with the various Push Notification Services.
Request
Method |
Request URI |
HTTP Version |
---|---|---|
POST |
https://{namespace}.servicebus.windows.net/{NotificationHub}/messages/?direct&api-version=2015-04 |
HTTP/1.1 |
Request Headers
The following table describes required and optional request headers.
Request Header |
Description |
---|---|
Authorization |
Token generated as specified in Shared Access Signature Authentication with Service Bus, or Service Bus authentication and authorization with Microsoft Azure Active Directory Access Control (also known as Access Control Service or ACS). |
Content-Type |
Set the Content-Type header based on the target platform notification service below:
|
ServiceBusNotification-DeviceHandle |
The PNS device handle. |
ServiceBusNotification-Tags |
{single tag identifier} (optional) |
ServiceBusNotification-Format |
Set to a valid PlatformType value
|
x-ms-version |
2015-04 (Supported by 2015-01 and later) |
Request Body
Based on the platform type, the request body formats will change. Refer to the body formats for each individual platform in native Send REST APIs.
Response
The response includes an HTTP status code and a set of response headers. Response body is returned on success.
Response Codes
Code |
Description |
---|---|
201 |
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 64Kb. |
For information about status codes, see Status and Error Codes.
Response Headers
Response Header |
Description |
---|---|
Content-Type |
application/xml; charset=utf-8 |
Location |
This header is only available for Standard tier Notification Hubs. This header will contain the Notification Message ID. This is used with Per Message Telemetry: Get Notification Message Telemetry and correlating PNS Feedback. The location header uses the following format:
|
Response Body
None.
See Also
Direct Batch Send
Send an APNS Native Notification
Send a GCM Native Notification
Send an MPNS Native Notification
Send a WNS Native Notification