Recapture IT - Notifications

Documentation

isregistered.ashx
register.ashx
send.ashx
sendmulti.ashx
unregister.ashx
unsend.ashx

isregistered.ashx

Check is a device is registered in Recapture IT Notifications

Parameter	Type	Optional	Description
deviceid	string	No	ID of device in notification service (external)
key	string	No	Key to identify customer
service	string	No	Notification service to use. Accepted values: apns, fcm
userid	string	No	ID of user in customer system

register.ashx

Registered a device in Recapture IT Notifications

Parameter	Type	Optional	Description
data.*	string	Yes	NOT IN USE! Extra information about the device/user. Multiple values possible. E.g. &data.key1=value1&data.key2=value2
deviceid	string	No	ID of device in notification service (external)
key	string	No	Key to identify customer
platform	string	Yes	Device platform. Accepted values: android, ios
service	string	No	Notification service to use. Accepted values: apns, fcm
userid	string	No	ID of user in customer system

send.ashx

Send a push notification to a user's device(s)

Parameter	Type	Optional	Description
badge	integer (32)	Yes (only for send)	Badge number
data.*	string	Yes (only for send)	Extra information sent to device. Multiple values possible. E.g. &data.key1=value1&data.key2=value2
id	string	No (only for update)	ID of message (when updating item)
key	string	No	Key to identify customer
message	string	No (only for send)	Message to send
platform	string	Yes (only for send)	Send only to specific platform. Accepted values: android, ios
priority	integer (32)	Yes (only for send)	Message priority. Accepted values: 0 (Normal), 1 (High), 2 (Critical)
return	string	Yes	Return ID of message. Example response "success.1234567890" instead of "success". Accepted value: id
scheduleutc	string	Yes	Schedule sending of message. Date & time in UTC. Send in "id" and "scheduleutc" to update schedule. Accepted format: yyyy-MM-ddTHH:mm
title	string	Yes (only for send)	Title to send
userid	string	No (only for send)	ID of user in customer system

sendmulti.ashx

Send push notification to multiple users and their device(s). Content-Type header must be "application/json". Send JSON data using HTTP POST. For property details see send.ashx

Request JSON
{ "key": "", "notifications": [ { "badge": 0, "data.key1": "", "data.key2": "", "id": "", "message": "Test", "platform": "", "return": "", "scheduleutc": "", "title": "", "userid": "UserId1" }, { "badge": 0, "data.key1": "", "data.key2": "", "id": "", "message": "Test", "platform": "", "return": "", "scheduleutc": "", "title": "", "userid": "UserId2" } ] }

Request JSON

{
    "key": "",
    "notifications": [
        {
            "badge": 0,
            "data.key1": "",
            "data.key2": "",
            "id": "",
            "message": "Test",
            "platform": "",
            "return": "",
            "scheduleutc": "",
            "title": "",
            "userid": "UserId1"
        },
        {
            "badge": 0,
            "data.key1": "",
            "data.key2": "",
            "id": "",
            "message": "Test",
            "platform": "",
            "return": "",
            "scheduleutc": "",
            "title": "",
            "userid": "UserId2"
        }
    ]
}

Response JSON
{ "response": "success", "notifications": [ { "badge": 0, "data.key1": "", "data.key2": "", "id": "", "message": "Test", "platform": "", "return": "", "scheduleutc": "", "title": "", "userid": "UserId1", "response": "success" }, { "badge": 0, "data.key1": "", "data.key2": "", "id": "", "message": "Test", "platform": "", "return": "", "scheduleutc": "", "title": "", "userid": "UserId2", "response": "failure" } ] }

Response JSON

{
    "response": "success",
    "notifications": [
        {
            "badge": 0,
            "data.key1": "",
            "data.key2": "",
            "id": "",
            "message": "Test",
            "platform": "",
            "return": "",
            "scheduleutc": "",
            "title": "",
            "userid": "UserId1",
            "response": "success"
        },
        {
            "badge": 0,
            "data.key1": "",
            "data.key2": "",
            "id": "",
            "message": "Test",
            "platform": "",
            "return": "",
            "scheduleutc": "",
            "title": "",
            "userid": "UserId2",
            "response": "failure"
        }
    ]
}

unregister.ashx

Unregistered a device in Recapture IT Notifications

Parameter	Type	Optional	Description
deviceid	string	Yes (required if userid is empty)	ID of device in notification service (external)
key	string	No	Key to identify customer
service	string	No	Notification service to use. Accepted values: apns, fcm
userid	string	Yes (required if deviceid is empty)	ID of user in customer system. If no device ID is passed then all devices are unregistered for specific user.

unsend.ashx

Cancel sending of a push notification (for scheduled messages)

Parameter	Type	Optional	Description
id	string	No	ID of message
key	string	No	Key to identify customer