API DTOs

Models


MessageResponseDto

Message Response DTO Class

NameTypeDescriptionRequired
CodeintegerResponse CodeNo
MessagestringResponse MessageNo
MessageDetailsMessageDetailsDtoReturned MessageNo

MessageDetailsDto

Message Details DTO Class

NameTypeDescriptionRequired
MessageNamestringMessage Name - used to be to easily identify the messageNo
MessageGroupIdlongMessage Grouping Id - used to be able group similar messages together for reporting purposesNo
ControlGroupstringControl Group. Valid values are: OFF / ON / TRUE / FALSENo
MessageStartDatelongMessage Valid from Start Date in EPOCH time valueNo
MessageEndDatelongMessage Valid from End Date in EPOCH time valueNo
AppList[ AppInfoDto ]List of Apps message valid forNo
ClientIdlongOpenBack Client Identifier - Provided by OpenBackNo
ClientMessageIdlongUnique Client Message Identifier. A unique type long for each message. This value will be required to update the message or too see reporting information for the messageNo
ClientKeystringOpenBack Client Key - Provided by OpenBackNo
MessageTypeMessageDtoMessage Type DTO - Used when Intelligent Routing is disabledNo
IntelligentRoutingIntelligentRoutingDtoIntelligent Routing - Used when message deliver escalations are requiredNo
RecurringDeliverySettingsDeliverySettingInfoDtoRecurring Delivery Settings - Used to define rules to show multiple times or just once off or what time period betweenNo
TriggersTriggersDtoRules to define when to deliver messageNo
IdentityInfo[ IdentityDto ]Identitiy Info is used to define which user get the messageNo
MessageStatusIdintegerMessage Status ID. Valid values are: 1= ACTIVE STATUS / 2= ARCHIVED STATUSNo
MessageIdlongMessage Id - used to be to easily identify the messageNo
ExpiryInfoExpiryInfoDtoExpiry Info -No
IgnoreIfTriggersNotAvailablebooleanOptional - Ignore If Trigger Not AvailableNo
AttributionTagstringOptional - AttributionTagNo
SensitivityFlagbooleanOptional - SensitivityFlag - do not show notification on locked screenNo
MessageEndDateOnGoingbooleanOptional - Message End Date OnGoing -No

AppInfoDto

App Info DTO Class

NameTypeDescriptionRequired
SdkAppcodestringUnique OpenBack App Code / IdentifierNo
AppTypestringType of App. Valid Values ANDROID / IOSNo
AndroidPackageNamestringAndroid Package NameNo
IosBundleIdstringIos App Bundle IdNo

MessageDto

Message DTO Class

NameTypeDescriptionRequired
ActiveMessageTypeintegerActive Message Type. Valid values are: OpenBackSmartNotification = 1 / InAppMessage=2 / SMS=3 / Email=4 / StandardPushNotification =5 / Wallpaper=6No
NotificationDtoNotificationDtoNotification MessageNo
InAppMessageDtoInAppMessageDtoIn-App MessageNo
SmsDtoSmsInfoDtoSMS MessageNo
EmailDtoEmailInfoDtoEmail MessageNo

IntelligentRoutingDto

Intelligent Routing DTO Class

NameTypeDescriptionRequired
PrimaryMessageEnabledbooleanIs Primary Intelligent Routing Message Enabled?No
PrimaryMessageMessageDtoPrimary Intelligent Routing Message TypeNo
PrimaryMessageExpiryTimeSecondslongPrimary Intelligent Routing Message Expiry Time after displaying in SecondsNo
SecondaryMessageEnabledbooleanIs Secondary Intelligent Routing Message Enabled?No
SecondaryMessageMessageDtoSecondary Intelligent Routing Message TypeNo
SecondaryMessageExpiryTimeSecondslongSecondary Intelligent Routing Expiry Time after displaying in SecondsNo
ThirdMessageEnabledbooleanIs Third Intelligent Routing Message Enabled?No
ThirdMessageMessageDtoThird Intelligent Routing Message TypeNo
ThirdMessageExpiryTimeSecondslongThird Intelligent Routing Message Expiry Time after displaying in SecondsNo

DeliverySettingInfoDto

DeliverySettingInfo DTO Class

NameTypeDescriptionRequired
MaxNumberOfInteractionintegerMaximum Number of Interactions Allowed before not displaying message againNo
MinTimeInSecondBetweenDisplayinglongMin Time In Seconds Between Displaying Message. Valid options are: 15 minutes=900 / 30 minutes=1800 / 45 minutes=2700 / 1 hour=3600 / 2 hours=7200 / 3 hours=10800 / 6 hours=21600 / 9 hours=32400 / 12 hours=43200 / 15 hours=54000 / 18 hours=64800 / 21 hours=75600 / 1 day=86400 / 2 days=172800 / 3 days=259200 / 4 days=345600/ 5 days=432000 / 6 days=518400 / 1 week=604800 / 2 weeks=1209600 / 3 weeks=1814400 / 1 month=2592000 / 2 months=5184000 / 3 months=7776000 / 4 months=10368000 / 5 months=12960000 / 6 months=15552000 / 1 year=31536000No
MaxNumberOfTimesToDisplayintegerMax Number of Times Message DisplayedNo
EnabledbooleanDelivery Settings Enabled?No
MinTimeInSecondBetweenInteractionslongMinimum time after interaction before displaying the message again in seconds. Valid options are: 15 minutes=900 / 30 minutes=1800 / 45 minutes=2700 / 1 hour=3600 / 2 hours=7200 / 3 hours=10800 / 6 hours=21600 / 9 hours=32400 / 12 hours=43200 / 15 hours=54000 / 18 hours=64800 / 21 hours=75600 / 1 day=86400 / 2 days=172800 / 3 days=259200 / 4 days=345600/ 5 days=432000 / 6 days=518400 / 1 week=604800 / 2 weeks=1209600 / 3 weeks=1814400 / 1 month=2592000 / 2 months=5184000 / 3 months=7776000 / 4 months=10368000 / 5 months=12960000 / 6 months=15552000 / 1 year=31536000No

TriggersDto

Triggers Model

NameTypeDescriptionRequired
ActivityTriggerActivityTriggerDtoActivity Trigger - Type of movementNo
AeroplaneTriggerAeroplaneTriggerDtoAeroplane Mode TriggerNo
AllUsersTriggerAllUsersTriggerDtoAll Users TriggerNo
AppTriggerAppTriggerDtoApp TriggerNo
AppOpenTriggerAppOpenTriggerDtoApp Open TriggerNo
AppUsageTriggerAppUsageTriggerDtoApp Usage TriggerNo
PowerTriggerPowerTriggerDtoPower TriggerNo
BeaconTriggerBeaconTriggerDtoBeacon TriggerNo
BoredomTriggerBoredomTriggerDtoBoredom TriggerNo
BrightnessTriggerBrightnessTriggerDtoBrightness TriggerNo
CalendarTriggerCalendarTriggerDtoCalendar TriggerNo
ChangeTriggerChangeTriggerDtoChange TriggerNo
ConnectivityTriggerConnectivityTriggerDtoConnectivity TriggerNo
CustomApp1TriggerCustomDtoCustom App 1 TriggerNo
CustomApp2TriggerCustomDtoCustom App 2 TriggerNo
CustomApp3TriggerCustomDtoCustom App 3 TriggerNo
CustomApp4TriggerCustomDtoCustom App 4 TriggerNo
CustomApp5TriggerCustomDtoCustom App 5 TriggerNo
CustomApp6TriggerCustomDtoCustom App 6 TriggerNo
CustomApp7TriggerCustomDtoCustom App 7 TriggerNo
CustomApp8TriggerCustomDtoCustom App 8 TriggerNo
CustomApp9TriggerCustomDtoCustom App 9 TriggerNo
CustomApp10TriggerCustomDtoCustom App 10 TriggerNo
DelayTriggerDelayTriggerDtoDelay TriggerNo
DeviceDecisionsTriggerDeviceDecisionsTriggerDtoDeviceDecision TriggerNo
DeviceOrientationTriggerDeviceOrientationTriggerDtoDevice Orientation TriggerNo
DeviceTriggerDeviceTriggerDtoDevice TriggerNo
EventTriggerEventTriggerDtoEvent TriggerNo
FallbackTriggerFallbackTriggerDtoFallback TriggerNo
HeadphoneTriggerHeadphoneTriggerDtoHeadphone TriggerNo
LastOpenIdleTriggerIdleTriggerDtoLast Open Idle TriggerNo
InstallTriggerInstallTriggerDtoInstall TriggerNo
LanguageTriggerLanguageTriggerDtoLanguage TriggerNo
LocationTriggerLocationTriggerDtoLocation TriggerNo
MemoryTriggerMemoryTriggerDtoMemory TriggerNo
MobileOperatorTriggerMobileOperatorTriggerDtoMobile Operator TriggerNo
NoiseTriggerNoiseTriggerDtoNoise TriggerNo
NotificationTriggerNotificationTriggerDtoNotification TriggerNo
NowTriggerNowTriggerDtoNow TriggerNo
ProximityTriggerProximityTriggerDtoProximity TriggerNo
RootedTriggerRootedTriggerDtoRooted TriggerNo
RoamingTriggerRoamingTriggerDtoRoaming TriggerNo
SignalTriggerSignalTriggerDtoSignal TriggerNo
TimeTriggerTimeTriggerDtoTime TriggerNo
UnlockTriggerUnlockTriggerDtoUnlock TriggerNo
VersionTriggerVersionTriggerDtoVersion TriggerNo
VolumeTriggerVolumeTriggerDtoVolume TriggerNo
WeatherTriggerWeatherTriggerDtoWeather TriggerNo
WorkflowTriggerWorkflowTriggerDtoWorkflow TriggerNo

IdentityDto

Identity DTO Class

NameTypeDescriptionRequired
IdentiferTypeIdintegerIdentifer IdNo
IdentiferValuestringIdentity ValueNo

ExpiryInfoDto

ExpiryInfo DTO Class

NameTypeDescriptionRequired
ExpiryTypestringExpiryType - Valid options are: DEVICE-TIME / AFTER-NOTIFICATION-DELIVERED / UTC-TIMENo
ExpiryValuelongExpiryValue - EPOCH Time in seconds - if Expiry Type=AFTER-NOTIFICATION-DELIVERED valid options are: Valid options are: 15 minutes=900 / 30 minutes=1800 / 45 minutes=2700 / 1 hour=3600 / 2 hours=7200 / 3 hours=10800 / 6 hours=21600 / 9 hours=32400 / 12 hours=43200 / 15 hours=54000 / 18 hours=64800 / 21 hours=75600 / 1 day=86400 / 2 days=172800 / 3 days=259200 / 4 days=345600/ 5 days=432000 / 6 days=518400 / 1 week=604800 / 2 weeks=1209600 / 3 weeks=1814400 / 1 month=2592000 / 2 months=5184000 / 3 months=7776000 / 4 months=10368000 / 5 months=12960000 / 6 months=15552000 / 1 year=31536000No

NotificationDto

Notification DTO Class

NameTypeDescriptionRequired
MessageTypestringNotification Message Type. Valid values are: URL / MESSAGENo
MessageTitle[ LocaleTextDto ]Notification Message title - LocalizedNo
MessageContent[ LocaleTextDto ]Notification Message body - LocalizedNo
MessageUrl[ LocaleTextDto ]Notification URL - On click opens URL - including Deep Links - LocalizedNo
RichNotificationBigIconUrlstringOptional - Rich Notification Big Icon URL. Valid URL's must start with (https:// or http://) and end with (.png / jpg / jpeg)No

InAppMessageDto

In-App Message DTO Class

NameTypeDescriptionRequired
TypeIdintegerIn-App Message Type Id. Valid values are: Url = 1 / AppInstall=2 / Image=3 / Video=4 / Custom=5 / Inbox=6 / Other=7No
Title[ LocaleTextDto ]In-App Message titleNo
Content[ LocaleTextDto ]In-App Message ContentNo
Url[ LocaleTextDto ]In-App Message URL - Opens URL on clickNo
AppInstall[ LocaleTextDto ]In-App Message - Opens App Store URL on ClickNo
Image[ LocaleTextDto ]In-App Message Image URL - LocalizedNo
Video[ LocaleTextDto ]In-App Message Video URL - LocalizedNo
Html[ LocaleTextDto ]In-App Message HTML - LocalizedNo
DeliverWithSmartPushbooleanDeliver with Smart Push - Lead with notificationNo
MessagePayloadstringIn-App Message PayloadNo
AddToInboxbooleanAdd to InboxNo

SmsInfoDto

SmsInfo DTO Class

NameTypeDescriptionRequired
SmsProviderIdlongSmsProviderIdNo
SmsLinkIdlongSmsLinkIdNo
SmsContent[ LocaleTextDto ]SMS ContentNo

EmailInfoDto

EmailInfo DTO Class

NameTypeDescriptionRequired
EmailProviderIdlongEmailProviderIdNo
EmailSubject[ LocaleTextDto ]Email SubjectNo
EmailLinkIdlongEmailLinkIdNo
EmailBody[ LocaleTextDto ]Email bodyNo
EmailCcAddressstringEmail CC AddressNo
EmailBccAddressstringEmail BCC AddressNo

ActivityTriggerDto

ActivityTrigger DTO Class

NameTypeDescriptionRequired
EnabledbooleanIs Activity Trigger EnabledNo
ActivityTypestringType of activity. Valid values: STILL / WALKING / RUNNING / CYCLING / IN_VECHICLENo
ActivityOperatorstringOperator for type of activity. EQUALS / NOT_EQUALSNo

AeroplaneTriggerDto

AeroplaneTrigger DTO Class

NameTypeDescriptionRequired
EnabledbooleanIs Aeroplane Mode Trigger Enabled?No
AeroplaneModeActivebooleanIs Aeroplane Mode Active. Valid options are: TRUE / FALSENo

AllUsersTriggerDto

AllUsersTriggerDto DTO Class

NameTypeDescriptionRequired
EnabledbooleanAll Users Trigger EnabledNo
AllUsersbooleanAll Users Trigger - For standard push onlyNo
IndividualUserbooleanIndividual User NotificationNo
UserTokenstringUserToken for individual user notificationNo

AppTriggerDto

App Trigger DTO Class

NameTypeDescriptionRequired
EnabledbooleanApp Trigger EnabledNo
AppActionTypestringApp action type. Valid values are: INSTALLED / NOT_INSTALLEDNo
AppNamestringApp Name for the name of app identifier determining if app installed or not installedNo
AppPackageUrlstringApp Package Url / Bundle IDNo
AppPackageUrls[ AppPackageInfoDto ]List of AppPackageUrlsNo

AppOpenTriggerDto

App Open Trigger DTO Class

NameTypeDescriptionRequired
EnabledbooleanIs App Open Trigger Enabled?No
OpenStatestringIs Mobile App Open or closed? Valid options are: FOREGROUND / BACKGROUNDNo
OpenCountOperatorstringOpenApp Count Operator? Valid options are: EQUALS / NOT_EQUALS / LESS_THAN / LESS_THAN_OR_EQUALS_TO / GREATER_THAN / GREATER_THAN_OR_EQUALS_TONo
OpenCountlongOpenApp OpenCount - number of times app was in the foregroundNo
OpenCountTypestringOpenApp OpenCountType - type of open to countNo

AppUsageTriggerDto

AppUsageTriggerDto DTO Class

NameTypeDescriptionRequired
EnabledbooleanIs App Usage Trigger Enabled?No

PowerTriggerDto

Power Trigger DTO Class

NameTypeDescriptionRequired
EnabledbooleanIs Power Trigger Enabled?No
BatteryLevelstringRequired Battery Level. Valid values are: NORMAL / GOOD / LOW / IGNOREDNo
IsChargingstringIs device charging. Valid values are: NOT_SELECTED / CHARGING / NOT_CHARGINGNo
ChargingTypestringType of device charging. Value values are: USB / ACNo
PowerOperatorstringPowerOperator - Valid values are: EQUALS / NOT_EQUALSNo

BeaconTriggerDto

BeaconTrigger DTO Class

NameTypeDescriptionRequired
EnabledbooleanIs Beacon Trigger enabled?No
BeaconOperatorstringBeacon Operator - Valid options are EQUALS / NOT_EQUALSNo
MajorintegerBeacons Major IdentifierNo
MinorintegerBeacons Minor IdentifierNo
ProximityintegerBeacon ProximityNo
UuidstringBeacons Unique User IdentifierNo

BoredomTriggerDto

BoredomTrigger DTO Class

NameTypeDescriptionRequired
EnabledbooleanIs Boredom Trigger enabled?No
BoredomValuestringBoredom ValueNo
BoredomOperatorstringBoredom Operator. Valid values: EQUALS / NOT-EQUALSNo

BrightnessTriggerDto

BrightnessInfo DTO Class

NameTypeDescriptionRequired
EnabledbooleanIs Brightness Trigger Enabled?No
OperatorstringBrightness Operator. Valid options are: BETWEEN / NOT_BETWEENNo
LevelstringBrightness Level. Valid options are: IS_BRIGHT / DAYLIGHT / TWILIGHT / IS_DARKNo

CalendarTriggerDto

CalendarTriggerDto DTO Class

NameTypeDescriptionRequired
EnabledbooleanIs Calendar Trigger Enabled?No

ChangeTriggerDto

ChangeTriggerDto DTO Class

NameTypeDescriptionRequired
EnabledbooleanIs Change Trigger Enabled?No

ConnectivityTriggerDto

ConnectivityTrigger DTO Class

NameTypeDescriptionRequired
EnabledbooleanIs Connectivity Trigger Enabled?No
WifiStatusstringWIFI Status/State. Valid options are: IGNORED / DISABLED / ENABLED / CONNECTED / DISCONNECTEDNo
WifiOperatorstringWifi Operator. Valid Options are: EQUALS / NOT_EQUALSNo
WifiSsidNamestringWifi SSID NameNo
WifiSsidOperatorstringWIFI SSID Operator. Valid Options are: CONNECTED / AVAILABLE / EQUALS / NOT_EQUALSNo
BluetoothStatusstringBluetooth status/state. Valid options are: IGNORED / DISABLED / ENABLEDNo
BluetoothOperatorstringBluetooth Operator. Valid Options are: EQUALS / NOT_EQUALSNo
DataConnectionStatusstringData Connection Type status. Valid Option are: IGNORED / AVAILABLE / NOT-AVAILABLENo
DataConnectionOperatorstringDataConnection Operator. Valid Options are: EQUALS / NOT_EQUALSNo
GpsStatusstringGPS State. Valid Options are: IGNORED / ENABLED / DISABLEDNo
GpsOperatorstringGps Operator. Valid Options are: EQUALS / NOT_EQUALSNo
WifiNames[ string ]List of WifiNamesNo
WifiAvailableSsids[ string ]List of TrigWifiAvailableSsidsNo

CustomDto

Custom DTO Class

NameTypeDescriptionRequired
EnabledbooleanIs Custom Value Enabled?No
ValuestringCustom ValueNo
TypestringCustom Type. Valid values are: STRING / INTEGER / FLOATNo
OperatorstringCustom Operator. Valid values are: EQUALS / NOT_EQUALS /LESS_THAN / LESS_THAN_OR_EQUALS_TO / GREATER_THAN / GREATER_THAN_OR_EQUALS_TO / LIKE / NOT_LIKENo
LabelstringCustom LabelNo

DelayTriggerDto

DelayTrigger DTO Class

NameTypeDescriptionRequired
EnabledbooleanEnabledNo
DelayValuelongDelay ValueNo

DeviceDecisionsTriggerDto

Device Decisions Trigger DTO Class

NameTypeDescriptionRequired
EnabledbooleanDeviceDecisionsTrigger enabled?No
GoalsOptimizedEnabledbooleanGoalsOptimizedEnabledNo
GoalsOptimizedDeadlinelongGoals Optimized Deadline IdNo
GoalsOptimizedDeadlineTypestringGoals Optimized Deadline Type - valid options include: DEVICE / UTCNo
InteractionsOptimizedEnabledbooleanInteractionsOptimizedEnabledNo
InteractionsOptimizedDeadlinelongInteractions Optimized Deadline IdNo
InteractionsOptimizedDeadlineTypestringInteractions Optimized Deadline Type - valid options include: DEVICE / UTCNo
ClicksOptimizedEnabledbooleanClicksOptimizedEnabledNo
ClicksOptimizedDeadlinelongClicks Optimized Deadline IdNo
ClicksOptimizedDeadlineTypestringClicks Optimized Deadline Type Type - valid options include: DEVICE / UTCNo

DeviceOrientationTriggerDto

Device Orientation Trigger DTO Class

NameTypeDescriptionRequired
EnabledbooleanIs Device Orientation Trigger Enabled?No
DeviceOrientationTypestringDevice Orientation Type. Valid Values are: UP / DOWN / SIDE / UPSIDEDOWN / FACEUP / FACEDOWNNo
DeviceOrientationOperatorstringDevice Orientation Operator. Valid Values are: EQUALS / NOT_EQUALSNo

DeviceTriggerDto

DeviceTrigger DTO Class

NameTypeDescriptionRequired
EnabledbooleanIs Device Trigger Enabled?No
HandsetModelstringHandset Model Type. Valid values are available in the API portalNo
HandsetModelOperatorstringHandset Model Operator. Valid values are: EQUALS / NOT_EQUALSNo
HandsetBrandstringHandset Brand Type. Valid values are available in the API portalNo
HandsetBrandOperatorstringHandset Brand Operator. Valid values are EQUALS / NOT_EQUALSNo
HandsetScreenSizestringHandset Screen Size Type. Valid options are available in the API portalNo
HandsetScreenSizeOperatorstringHandset Screen Size Operator. Valid values are: EQUALS / NOT_EQUALSNo

EventTriggerDto

EventTrigger DTO Class

NameTypeDescriptionRequired
EnabledbooleanIs Event Trigger Enabled?No
EventTypestringEvent Type. Defined by App DevelopersNo
EventOperatorstringEvent Operator. Valid options are EQUALS / NOT_EQUALSNo
DefaultDelaylongEvent Type Default Delay in secondsNo

FallbackTriggerDto

FallbackTrigger DTO Class

NameTypeDescriptionRequired
EnabledbooleanEnabledNo
ServerFallbackServerFallbackTriggerDtoServerFallbackNo
DeviceFallbackDeviceFallbackTriggerDtoDeviceFallbackNo

HeadphoneTriggerDto

HeadphoneTrigger DTO Class

NameTypeDescriptionRequired
EnabledbooleanHeadphones EnabledNo
HeadphonesConnectedbooleanHeadphones ConnectedNo

IdleTriggerDto

IdleTrigger DTO Class

NameTypeDescriptionRequired
EnabledbooleanIs Idle Trigger Enabled?No
IdleValuelongMinimum Idle Time required to be considered as idleNo
IdleOperatorstringIdle Operator Valid values are: GREATER_THAN_OR_EQUALSNo

InstallTriggerDto

InstallTrigger DTO Class

NameTypeDescriptionRequired
EnabledbooleanIs Install Trigger enabled?No
FirstTypestringFirst Type. Valid values are: INSTALL / RUNNo
FirstOperatorstringFirst Operator. Valid values are: EQUALS / NOT_EQUALSNo

LanguageTriggerDto

LanguageTrigger DTO Class

NameTypeDescriptionRequired
EnabledbooleanIs Language Trigger Enabled?No
RegionstringLanguage Region Value. Valid values are available in the API portalNo
RegionOperatorstringRegion Operator. Valid values are: EQUALS / NOT_EQUALSNo
LanguagestringLocale Language value. Valid values are available in the API portalNo
LanguageOperatorstringLanguage Operator. Valid values are: EQUALS / NOT_EQUALSNo
LocaleLanguages[ string ]List of LocaleLanguagesNo
LocaleRegions[ string ]List of LocaleRegionsNo

LocationTriggerDto

LocationTrigger DTO Class

NameTypeDescriptionRequired
EnabledbooleanIs Location Trigger Enabled?No
LocationTypestringLocation Type. Valid Values are: COUNTRY / EXACT / HOME / WORKNo
CountrystringLocation CountryNo
CountryIsostringCountry Iso CodeNo
UserHomebooleanUserHomeNo
HomeOperatorstringHomeOperator. Valid option are: EQUALS / NOT_EQUALSNo
UserWorkbooleanUserWorkNo
WorkOperatorstringWorkOperator. Valid option are: EQUALS / NOT_EQUALSNo
ExactAddressstringLocation Exact address, includes street address, county, country, etc..No
ExactRangeintegerValid Range Distance in KMNo
ExactLongitudefloatLocation Exact LongitudeNo
ExactLatitudefloatLocation Exact LatitudeNo
CellIdstringCellIdNo
LocationOperatorstringLocation Operator. Valid values are: EQUALS / NOT_EQUALSNo
LocationCountries[ string ]List of Location Countries - Country ISO CodeNo

MemoryTriggerDto

MemoryTrigger DTO Class

NameTypeDescriptionRequired
EnabledbooleanMemory Trigger Enabled?No
StoragelongAvailable Device Storage. Valid Values are: -1 / 0 / 50 / 100 / 250 / 500 / 1024 / 2048No
StorageOperatorstringDevice Storage Operator. Valid values are: NOT_SELECTED / LESS_THAN_OR_EQUALS_TO / GREATER_THAN_OR_EQUALS_TONo
MemorylongAvailable Device Memory. Valid Values are: -1 / 0 / 50 / 100 / 250 / 500 / 1024 / 2048No
MemoryOperatorstringDevice Memory Operator. Valid values are: NOT_SELECTED / LESS_THAN_OR_EQUALS_TO / GREATER_THAN_OR_EQUALS_TONo

MobileOperatorTriggerDto

MobileOperatorTrigger DTO Class

NameTypeDescriptionRequired
EnabledbooleanIs Mobile Operator Trigger Enabled?No
MobileOperatorNamestringMobileOperatorNameNo
MobileOperatorOperatorstringMobile Operator Operator. Valid Values are: EQUALS / NOT_EQUALSNo
MobileOperatorMccstringMobile Operator MccNo
MobileOperatorMncstringMobile Operator Mcc MncNo
MpoCodestringOpenBack Mobile Operator Code - As mobile operators code can be owned multiple MNC codesNo
MobileOperatorMccMncs[ MobileOperatorMccMncInfoDto ]List of MobileOperatorMccMncsNo

NoiseTriggerDto

NoiseTrigger DTO Class

NameTypeDescriptionRequired
EnabledbooleanEnabledNo
NoiseOperatorstringNoise OperatorNo
NoiseLevelstringNoise Level - Different level types are available in the portalNo

NotificationTriggerDto

NotificationInfo DTO Class

NameTypeDescriptionRequired
EnabledbooleanNotification Trigger EnabledNo
ValueintegerNotification ValueNo
OperatorstringNotification OperatorNo
NotificationOptionstringNotification Option types. Valid options are ALLOWEDBLOCKED

NowTriggerDto

Now Trigger DTO Class

NameTypeDescriptionRequired
EnabledbooleanNow Trigger enabled?No
SendNowbooleanSendNowNo
NumberOfSecondsValidForintegerNumber Of Seconds Now Trigger Valid For. Valid options are: 15 minutes=900 / 30 minutes=1800 / 1 hour=3600 / 2 hours=7200 / 4 hours=14400 / 8 hours=28800 / 12 hours=43200 / 1 day=86400No
StandardPushAudiencestringStandardvPush AudienceNo
TokenstringRegular Push TokenNo
SendTypestringSend Type - Valid options: SMART-PUSH / STANDARD-PUSHNo

ProximityTriggerDto

ProximityTrigger DTO Class

NameTypeDescriptionRequired
EnabledbooleanIs Proximity Trigger Enabled?No
InHandbooleanIs Proximity sensor in hand/covered. Valid values are: TRUE / FALSENo

RootedTriggerDto

RootedTrigger DTO Class

NameTypeDescriptionRequired
EnabledbooleanIs Rooted Trigger Enabled?No

RoamingTriggerDto

RoamingTrigger DTO Class

NameTypeDescriptionRequired
EnabledbooleanIs Roaming Trigger enabled?No
IsRoamingbooleanIs device currently Roaming?No

SignalTriggerDto

SignalInfo DTO Class

NameTypeDescriptionRequired
EnabledbooleanEnabledNo
Signal TypestringSignal type(strenght). Valid values are: NO_SIGNAL / 2G / 2.5G / 3G / 3.5G / 4GNo
SignalOperatorstringSignal Operator. Valid values are: EQUALS / NOT_EQUALS / GREATER_THAN / LESS_THANNo

TimeTriggerDto

TimeTrigger DTO Class

NameTypeDescriptionRequired
EnabledbooleanEnableNo
RepeatingbooleanRepeating Time TypeNo
DayintegerDay of month. Valid values are: 1 - 31 depending on the monthNo
MonthintegerMonth of year. Valid values are: 1 - 12No
YearintegerYear. Valid values from todays date to 2 years into the futureNo
HourintegerHour of day. Valid values are: 0 - 23No
MinuteintegerMinute of Hour. Valid values are: 0-59No
SecondintegerSecond of minute. Valid values are: 0 - 59No
ValidTimeOperatorstringValidTimeOperatorNo
TimeRangeValuelongLenght of time value. Valid values are greater than 0No
IsUtcbooleanTime is UTC time instead of device timeNo
FrequencyTypestringRepeat Frequency Type. Valid Values are: YEARLY / MONTHLY / WEEKLY / DAILYNo

UnlockTriggerDto

UnlockTrigger DTO Class

NameTypeDescriptionRequired
EnabledbooleanIs Unlock Trigger enabled?No
UnlockedbooleanUnlocked statusNo

VersionTriggerDto

VersionTrigger DTO Class

NameTypeDescriptionRequired
EnabledbooleanIs Version Trigger enabled?No
OsstringVersion OS ValueNo
OsOperatorstringVersion OS OperatorNo
AppstringVersion App ValueNo
AppOperatorstringVersion App OperatorNo

VolumeTriggerDto

VolumeTrigger DTO Class

NameTypeDescriptionRequired
EnabledbooleanEnabledNo
RingerlongDevices Ringer/Ringing volume level. Valid values are: 100 / 90 / 80 / 70 / 60 / 50 / 40 / 30 / 20 / 10 / 0No
RingerOperatorstringRinger Volume Operator. Valid values are: EQUALS / NOT_EQUALS / GREATER_THAN / GREATER_THAN_OR_EQUALS_TO / LESS_THAN / LESS_THAN_OR_EQUALS_TONo
MedialongDevices Media volume level. Valid values are: 100 / 90 / 80 / 70 / 60 / 50 / 40 / 30 / 20 / 10 / 0No
MediaOperatorstringMedia Volume Operator. Valid values are: EQUALS / NOT_EQUALS / GREATER_THAN / GREATER_THAN_OR_EQUALS_TO / LESS_THAN / LESS_THAN_OR_EQUALS_TONo

WeatherTriggerDto

WeatherTrigger DTO Class

NameTypeDescriptionRequired
EnabledbooleanIs Weather Trigger Enabled?No
TemperatureTypestringTemperature Type. Valid values are: IGNORED / FREEZING / COLD / WARM / HOTNo
TemperatureOperatorstringTemperature Operator. Valid values are: BETWEEN / NOT_BETWEENNo
HumidityTypestringHumidity Type. Valid values are: IGNORED / VERY_WET / WET / DAMP / DRY / VERY_DRYNo
HumidityOperatorstringHumidity Operator. Valid values are: BETWEEN / NOT_BETWEENNo

WorkflowTriggerDto

WorkflowInfo DTO Class

NameTypeDescriptionRequired
EnabledbooleanIs Workflow Trigger enabled?No
PreviousMessageIdlongPrevious Message IdNo
WorkFlowOperatorstringWorkflow OperatorNo
DeadlineDatelongWorkflow Deadline Date in EPOCH timeNo

LocaleTextDto

Locale Text DTO Class

NameTypeDescriptionRequired
MessageTextstringMessage TextNo
LanguageIsostringLanguage ISO. Valid Language ISO codesNo
LanguagePositionintegerLanguage PositionNo

AppPackageInfoDto

AppTriggerDto DTO Class

NameTypeDescriptionRequired
AppActionTypestringApp action type. Valid values are: INSTALLED / NOT_INSTALLEDNo
AppNamestringApp Name for the name of app identifier determining if app installed or not installedNo
AppPackageUrlstringApp Package Url / Bundle IDNo

ServerFallbackTriggerDto

Server FallbackTrigger DTO Class

NameTypeDescriptionRequired
EnabledbooleanEnabledNo
ValuelongServer Fallback ValueNo
TypestringServer Fallback Type - Valid options are: END-DATE / START-DATE / UPDATE-DATENo
TimeValuelongServer Fallback Time ValueNo

DeviceFallbackTriggerDto

Device FallbackTrigger DTO Class

NameTypeDescriptionRequired
EnabledbooleanEnabledNo
ValuelongDevice Fallback Value in secondsNo
TypestringDevice Fallback Type - Valid values: END-DATE / START-DATENo
IsUtcbooleanDevice Fallback IsUtc TimeNo

MobileOperatorMccMncInfoDto

MobileOperatorMccMncInfoDto DTO Class

NameTypeDescriptionRequired
MobileOperatorMccstringMobile Operator MCCNo
MobileOperatorMncstringMobile Operator MNCNo
MpoCodestringMPO CodeNo
MobileOperatorNamestringMobile Operator NameNo

BasicResponseDto

Basic Response DTO Class

NameTypeDescriptionRequired
CodeintegerResponse CodeNo
MessagestringResponse MessageNo

AppReportResponseDto

App Report Response DTO Class

NameTypeDescriptionRequired
CodeintegerResponse CodeNo
MessagestringResponse MessageNo
AppSummaryReport[ AppSummaryReportDto ]App Summary ReportNo

AppSummaryReportDto

App Summary Report DTO Class

NameTypeDescriptionRequired
SdkAppCodestringApp CodeNo
AppNamestringApp NameNo
AppStatusstringApp StatusNo
OsTypestringOS TypeNo
ActivelongNumber of Active AppsNo
DisengagedlongNumber of Disengaged AppsNo
TriggerslongNumber of TriggersNo
DeliveredMessageslongNumber of Delivered MessagesNo
ReportDatelongGenerated Report Date - EPOCH TIMENo
CurrentNotificationsBlockedlongNumber of users that have notifications blocked/turned off and have your app installedNo
TotalNotificationsBlockedlongNumber of users that have notifications blocked/turned off and have every had your app installed with the OpenBack library installedNo
NotificationsAllowedlongNumber of users that have notifications allowed/turned onNo
NewUsersInLast30DayslongNew Users In Last 30 DaysNo
TotalNumberOfAllTimeInstallslongTotal Number Of All Time Installs (with OpenBack library installed)No

MessageListResponseDto

Message List Response DTO Class

NameTypeDescriptionRequired
CodeintegerResponse CodeNo
MessagestringResponse MessageNo
MessageList[ MessageDetailsDto ]Messages ReturnedNo

MessageReportResponseDto

Message Report Response DTO Class

NameTypeDescriptionRequired
CodeintegerResponse CodeNo
MessagestringResponse MessageNo
MessageSummaryReport[ MessageSummaryReportDto ]Message Summary ReportNo

MessageSummaryReportDto

Message Summary Report DTO Class

NameTypeDescriptionRequired
MessageIdlongMessage IdNo
ClientMessageIdlongClient Message IdentiferNo
MessageNamestringMessage NameNo
MessageStatusstringMessage StatusNo
AppCodestringSDK App CodeNo
MessageTypestringMessage TypeNo
StartDateRangelongStart Date Range - EPOCHNo
StartDateRangeDescstringStart Date Range - Human Readable - UTC TimeNo
EndDateRangelongEnd Date Range - EPOCHNo
EndDateRangeDescstringEnd Date Range - Human Readable - UTC TimeNo
DeliveredlongMessage DeliveredNo
OpenedlongOpened MessagesNo
OpenedRatedoubleOpened Message PercentageNo
InteractedlongInteracted MessagesNo
InterRatedoubleInteracted Message PercentageNo
AllowedlongNotification AllowedNo
BlockedlongNotification BlockedNo
IRMessageslongIntelligent Routed MessagesNo
IRSmslongIntelligent Routed SMSNo
IREmaillongIntelligent Routed EmailNo
ReportDatelongGenerated Report Date - EPOCH TIMENo
GoalslongNumber of GoalsNo
DismisseslongNumber of DismissesNo

MessageGroupResponseDto

Message Group Response DTO Class

NameTypeDescriptionRequired
CodeintegerResponse CodeNo
MessagestringResponse MessageNo
MessageGroupList[ MessageGroupInfoDto ]Message Group ListNo

MessageGroupInfoDto

Message Group Info DTO Class.

NameTypeDescriptionRequired
MessageGroupIdlongMessage Group IdNo
GroupNamestringMessage Group NameNo
ClientIdlongClient IdNo
ClientKeystringOpenBack Client KeyNo
AppCodestringUnique App CodeNo

TrackingIdResponseDto

TrackingId Response DTO Class

NameTypeDescriptionRequired
CodeintegerResponse CodeNo
MessagestringResponse MessageNo
ListTrackingIds[ string ]List Tracking IdsNo

MessageBatchDto

Message Batch DTO Class

NameTypeDescriptionRequired
ClientMessageIdlongClient Message IdentifierNo
IdentityTypeintegerIdentity Type for user identityNo
ListOfIds[ string ]list Of user Ids that message should apply forNo
ClientIdlongClientIdNo
ClientKeystringClientKeyNo
AppCodestringAppCodeNo
BatchStartTimeTriggerBatchStartTimeTriggerDtoBatchTimeTrigger - used to overwrite the start date - templatesNo
TimeTriggerTimeTriggerDtoTimeTrigger - used to overwrite the time trigger in the templateNo
FallbackTriggerFallbackTriggerDtoFallbackTrigger - used to overwrite the fallback trigger in the templateNo
MessageStatusIdintegerMessage Status ID. Valid values are: 1= ACTIVE STATUS / 2= ARCHIVED STATUSNo

BatchStartTimeTriggerDto

Batch Time Trigger DTO Class

NameTypeDescriptionRequired
StartDayintegerStart Day of monthNo
StartMonthintegerStart Month of yearNo
StartYearintegerStart yearNo

ReportRequestDto

App Summary Report DTO Class

NameTypeDescriptionRequired
AppCodestringApp CodeNo
ClientIdlongClient IDNo
ClientKeystringClient KeyNo
MessageGroupIdlongClient Group Reference IdNo
ClientMessageIdlongClient Message Reference IdNo
PeriodTypestringTime Period Type. Valid Values DAY / MONTH / YEAR / DATE / RANGENo
DayOfMonthintegerReport Day Of MonthNo
MonthOfYearintegerReport Month Of YearNo
YearintegerReport YearNo
RangeStartDatelongReport Range Start Date in Epoch TimeNo
RangeEndDatelongReport Range End Date in Epoch TimeNo
GoalCodestringGoal CodeNo

GdprRequestDto

GdprRequest DTO Class

NameTypeDescriptionRequired
ClientIdstringSdk App CodeNo
ClientKeystringClientKeyNo
SdkAppCodelongClient IdNo
IdentityTypestringIdentity TypeNo
IdentityValuestringApn Certificate File NameNo
UsernamestringUsernameNo

GoalReportResponseDto

Goal Report Response DTO Class

NameTypeDescriptionRequired
CodeintegerResponse CodeNo
MessagestringResponse MessageNo
GoalSummaryReport[ GoalSummaryReportDto ]Goal Summary ReportNo

GoalSummaryReportDto

Goal Summary Report DTO Class

NameTypeDescriptionRequired
ReportTimestamplongTimestamp of goal report summaryNo
GoalNamestringAppNameNo
GoalDescriptionstringMessage NameNo
StatusTextstringStatus TextNo
ClientIdlongClient IdNo
StartDatestringStart DateNo
EndDatestringEnd DateNo
GoalValuedoubleGoal ValueNo
DirectGoalslongTotal number of direct goalsNo
TotalGoalsWithinTimeframelongTotal number of goals within timeframeNo
TotalGoalsOutsideOfTimeframelongTotal number of goals outside of timeFrameNo
NoOfStepsintegerNoOfStepsNo
GoalCodestringGoal CodeNo
TotalNumberOfGoalslongTotalGoalsNo
TotalGoalValuedoubleTotal Goal ValueNo
DirectGoalsValuedoubleDirect Goals ValueNo
WithinGoalTimeFrameValuedoubleNumber of goals within time frameNo
OutsideGoalTimeFrameValuedoubleGoals outside of Time Frame ValueNo
ActualGoalValuedoubleActual Goal Value - values passed into the SDKNo