Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 8 Next »

The EzyStream platform can allow approved partners to send notifications into their app, or customers apps.

You'll need to use our API token to validate your request.

Please note that we will create a new topic if the topic you specify is not already available/doesn't exist. Topics are visible to end users to manage what they receive notifications about, so please keep this list to a minimum/manageable amount.


REQUEST URL 

https://vodapi.ezystream.com/v4/infoodle/notification


METHOD

POST


PARAMETERS 

tp     (length limit is 255)

Topic of the notificaiton

tt      (length limit is 255)

Title of the notification

ms   (max 4k)

Message of the notification

st

Send time, use Unix timestamp (UTC time, milliseconds from 1 Jan. 1970)

cpid

Channel Partner Id,   need to be encrypted using AES-256-CSC. Please generate encrypt key and secret from EzyAdmin Configuration.

uid (optional)

user ID


EXAMPLE RESPONSE - SUCCESS

{

"message": "success" 


EXAMPLE RESPONSE - NO ACCESS PERMITTED

Encryption not setup.

{

"error": 403, 
"message": “Please setup your api request in ezystream admin!" 

Channel ID not exist

{

"error": 403, 
"message": “The channel is not exist!" 

EXAMPLE RESPONSE - ERROR 

{

"error": 500, 
"message": “System Error, the notification cannot be send!" 

}


Google Payload Limit

Google has a 2kb payload restriction for the message body. We generally recommend that 2-3 sentences max as it's important to remember people are probably reading it from their notification screen on their OS.




  • No labels