Send Direct Push Message
This API send a direct push message to consumer
Attributes
Attribute
|
Value
|
---|---|
Path | /v3/consumers/{consumerIdentity}/directpushmessage |
Support Formats | JSON, XML |
HTTP Method | POST |
Authorisation | Private Application Key |
Secure | Yes |
Rate Limited | No |
Cache Timeout | TBC |
HTTP Codes |
|
Request
The following table contains the details of a typical HTTP Request for this service:
Type
|
Value
|
---|---|
Header |
Content-Type: application/json
|
Body |
{ |
Notes:
ConsumerIdentity could be a consumerId (Guid) or externalConsumerIdToken.
Successful Response
The following table contains the details of a typical successful HTTP Request for this service.
Type
|
Value
|
---|---|
Header |
|
Body |
|
Unsuccessful Response
The following table contains the details of a typical successful HTTP Request for this service.
Type
|
Value
|
---|---|
Header |
|
Body |
{ "error":"Message is not valid to send.", "errorDescription":null, "innerException":null } |
Notes:
- When consumer does not exist, message does not exist, message is expired or not published or not a direct push message type, it is within the push message blackout period, the request id and message id exist in DirectPushMessageLog or the consumer not found in Notification Hub.
- DirectPushMessageRequestLog should be created to record for each request if the request Id and messageId has not exist in DirectPushMessageRequestLog table.
- DirectPushMessageLog should record the result of push message sent with error if it failed.
0 Comments