RESTful API

PUSH Types

The Campaign Manager will send to your app a variety of PUSH's types, in some cases to raise a visible/audible notification, but in other cases it will be silent, this is the mechanism how the app and the Campaign Manager will keep in touch about what is happening between them and the phone's surroundings.

Our SDK will handle all this messages for you.

Type: GEO_LOC

As String: <MESSAGE_ID>:<LATITUDE>:<LONGITUDE>:<RADIO>
Parameter Description
MESSAGE_ID Message's ID to query & deliver
LATITUDE The point latitude Number (decimal notation)
LONGITUDE The point longitude Number (decimal notation)
RADIO The circle radius. Use meters for this value

Type: GET_LOC

As String: <LOCATION_REQUEST_ID>
Parameter Description
LOCATION_REQUEST_ID The request's ID you need to update with your current location

Type: CRT_REGION

As String: <REGION_ID>:<LATITUDE>:<LONGITUDE>:<RADIO>:<EVENT_TYPE>:<REGION_NAME>
Parameter Description
REGION_ID New Region's ID
LATITUDE The point latitude Number (decimal notation)
LONGITUDE The point longitude Number (decimal notation)
RADIO The circle radius. Use meters for this value
EVENT_TYPE Which event must be notified ENTER, EXIT or ENTER-EXIT
REGION_NAME Region's name to display

Type: UPDT_REGION

As String: <REGION_ID>:<LATITUDE>:<LONGITUDE>:<RADIO>:<EVENT_TYPE>:<REGION_NAME>
Parameter Description
REGION_ID Region's ID to update
LATITUDE The point latitude Number (decimal notation)
LONGITUDE The point longitude Number (decimal notation)
RADIO The circle radius. Use meters for this value
EVENT_TYPE Which event must be notified ENTER, EXIT or ENTER-EXIT
REGION_NAME Region's name to update

Type: DLT_REGION

As String: <REGION_ID>
Parameter Description
REGION_ID Region's ID to delete

Type: BEACON

As String: <REGION_MESSAGE_CONTENT>
Parameter Description
REGION_MESSAGE_CONTENT Message's content

Type: GEOFENCE

As String: <REGION_MESSAGE_CONTENT>
Parameter Description
REGION_MESSAGE_CONTENT Message's content

Type: CRT_BEACON

As String: <REGION_ID>:<UUID>:<MAJOR>:<MINOR>:<MANUFACTURER>:<DISTANCE>:<EVENT_TYPE>:<REGION_NAME>
Parameter Description
REGION_ID New Region's ID
UUID Beacon's UUID
MAJOR Beacon's MAJOR value
MINOR Beacon's MINOR value
MANUFACTURER Beacon's manufacturer
DISTANCE Beacon's distance to trigger the event
EVENT_TYPE Event type to fire the event. ENTER, EXIT or ENTER-EXIT
REGION_NAME Region's name

Type: DLT_BEACON

As String: <REGION_ID>
Parameter Description
REGION_ID Region's ID to delete

Type: UPDT_BEACON

As String: <REGION_ID>:<UUID>:<MAJOR>:<MINOR>:<MANUFACTURER>:<DISTANCE>:<EVENT_TYPE>:<REGION_NAME>
Parameter Description
REGION_ID Region's ID to update
UUID New beacon's UUID
MAJOR New beacon's MAJOR value
MINOR New beacon's MINOR value
MANUFACTURER New beacon's manufacturer
DISTANCE New beacon's distance to trigger the event
EVENT_TYPE New event type to fire the event. ENTER, EXIT or ENTER-EXIT
REGION_NAME New region's name

Type: GEO_PUSH

As String: <MESSAGE_CONTENT>
Parameter Description
MESSAGE_CONTENT Message's content