Add New Notification API

Require Authentication

This API is used to add new Notification for the company based on combination of deviceID and token.

URL

api/notifications/add

Required parameter (POST)

deviceID
token
notificationName «contains Notification name»
notificationType «contains notification/alert Type. Content must contain either one of "notification" or "alert"»

Optional parameter (POST)

emergency «Mandatory for "notification" notificationType. Contains emergency type for notification. Content must contain "Y" for immediate type or "N" for scheduled type»
emergencyIntervalSeconds «Mandatory for "Notification" notificationType with emergency "Y". Contains MINUTES to to resend notification every selected minutes»
sendingtime «Mandatory for "Notification" notificationType with emergency "N". Contains array with time format i.e ["02:00 AM","12:00 AM"]»
notifType «Mandatory for "Notification" notificationType. Contains array that consist sensor data filters and the order must correspond to "valueAlertType" and "valueAlert". Available value:'fill_level','ultrasound','temperatureValue','batteryLevel''batteryLevel','temperatureOkay','signal_bar','signalStrength_rssi_dbm','signalStrength_bitErrorRate','accelerometer_x','accelerometer_y','accelerometer_z','historical_collection_calendar'»
valueAlertType «Mandatory for "notification" notificationType. Contains "min" (for >=),"exact" (for =), and "max" (for <=) »
valueAlert «Mandatory for "notification" notificationType. Contains value to compare with notifType »
sendType «Mandatory for "notification" notificationType. Contains send notification type (daily,weekly,monthly)»
sendDay «Optional for "notification" notificationType. Contains send day for weekly send type(1-7 ; as 1 for Monday and 7 for Sunday)»
sendDate «Optional for "notification" notificationType. Contains send date for monthly send type (1-31)»
alertSensorTriggerSecond «Mandatory for "alert" notificationType. Contains HOURS to Trigger alert when last sensor data seen is past the hours set»
frequencyalert «Mandatory for "alert" notificationType. Contains hour/s to to resend alert every selected hours»
emailSubject
emailContent
smsMessage
customPhone «must contains "+" sign in front and is followed by country code before mobile phone number with no space. i.e: +6135467897»
projectID «contains string of one or multiple projectID separated by ',' as a Notification parameter. If projectID is exist, projectID value must exist in Get Available Zones.»
projectgroupID «contains string of one or multiple projectgroupID separated by ',' as a Notification parameter. If projectgroupID is exist, projectgroupID value must exist in Get Available Groups.»
pinstagsID «contains string of one or multiple pinstagsID separated by ',' as a Notification parameter. If pinstagsID is exist, pinstagsID value must exist in Get Available Tags.»
pinstypesID «contains string of one or multiple pinstypesID separated by ',' as a Notification parameter. If pinstypesID is exist, pinstypesID value must exist in Get Available Asset Types.»
userID «contains recipient userID. If userID is exist, userID value must exist in Get Available Users in Company.»
customEmail
sendingMethod

contains array of sending method per userID of the recipient. i.e.["198",["email", "mobile", "sms", "web"]]

Example JSON Payload

{
	"notificationName":"test notification",
	"notificationType":"notification",
	"emergency":"Y",
	"emergencyIntervalSeconds":"-1",
	"emailSubject":"",
	"emailContent":"",
	"smsMessage":"",
	"notifType":["fill_level"],
	"valueAlertType":["min"],
	"valueAlert":["80"],
	"userID":[198],
	"sendType":"weekly",
	"sendDay":"1",
	"sendDate":"",
	"customEmail":["wilson@smartsensor.com.au"],
	"customPhone":["+123123123"],
	"sendingMethod":[ ["198",["email", "mobile", "sms", "web"]]],

	"deviceID": "B22B9969-5652-4C8D-8BC8-B4C87E3B815D",
	"token": "5c2c0a50a9306524b1b7d9e46d5640c4"
}

Possible return HTTP status code

Return message, contains newly created project

{
    "status": "success",
    "message": [
        "Notification Settings has been added."
    ]
}

Superfy Platform API Documentation