Skip to main content
API docs by Redocly

AST Services (3.0.3)

Download OpenAPI specification:Download

License: Commercial

Push

getPushToken

Retrieves push token information for the specified tenantId and astClientId. The actual push token is excluded from the response for security reasons.

Authorizations:
BearerAuth
path Parameters
tenantId
required
string
Examples: vertx

Tenant unique id

astClientId
required
string
Examples: 01G9CKX0QGA840G610MXMMF22K

Unique id of device (ast client id)

Responses

Response samples

Content type
application/json
{
  • "appName": "clientBackend",
  • "pushProvider": "FCM",
  • "isValid": true,
  • "assignedUsers": [
    ]
}

sendPushNotification

Send push notification message to:

  • either a specific astClient of a user
  • or all astClients of a user
  • or all astClients of all users in a tenant using broadcast (topic-based) messaging
Authorizations:
BearerAuth
path Parameters
tenantId
required
string
Examples: vertx

Tenant unique id

Request Body schema: application/json
required
category
required
string
Enum: "chat" "payment" "tms"

The type of category

required
Recipient (object) or Recipient (object) or Recipient (object) (Recipient)

The recipient information, to whom the push notification is to be sent.

required
object (Payload)

The payload of Push notification.

object (Sender)

Sender of push notification

silent
boolean
Default: false

Indicates whether the push notification is silent or not.

Responses

Request samples

Content type
application/json
{
  • "category": "tms",
  • "recipient": {
    },
  • "payload": {
    },
  • "silent": false
}

Response samples

Content type
application/json
[
  • {
    }
]