Test push notification data message

Test with push notification message

post

This is a test method to push a notification message to the given device tokens.

Query parameters

projectIdstringRequired

The id of the project in the notification app.

privateKeystringRequired

The privateKey in the notification app.

clientEmailstringRequired

The clientEmail in the notification app.

titlestringRequired

The title of the notification.

bodystringRequired

The body of the notification.

tokensstring[]Required

The list tokens.

Header parameters

Brand-URLstringRequired

The brand URL of the request. This is used to identify the brand.

Example: YOUR_BRAND_URL

Auth-KeystringRequired

Auth-Key is required to authenticate the request. If missing, the server will return 401 Unauthorized.

Example: YOUR_AUTH_KEY

Responses

200

The request was successful.

application/json

This provides interfaces for API responses with data.

successbooleanRead-onlyRequired

This is the flag to indicate whether the API call is successful or not.

statusCodeinteger · int32Read-onlyRequired

This is the HTTP status code. This is used to determine the status code to be returned to the client.

messagestring · min: 1Read-onlyRequired

This is the message to be displayed to the user.

401

The user is not authorized to access the requested resource. The request is missing the required Auth-Key header.

application/json

429

API call exceeded rate limit due to too many requests.

application/json

post

/api/v1/notifications/push-notification-messages/test

HTTPcURLJavaScriptPython

POST /api/v1/notifications/push-notification-messages/test?projectId=text&privateKey=text&clientEmail=text&title=text&body=text&tokens=text HTTP/1.1
Host: protocol.jframework.io
Brand-URL: text
Auth-Key: text
Accept: */*

{
  "success": true,
  "statusCode": 200,
  "message": "The request was successful.",
  "data": {
    "countSuccess": 10
  },
  "errors": []
}