Skip to content

API DTOs

Models


CampaignBatchDto

Campaign Batch DTO Class

Name Type Description Required
CampaignRefId string Campaign Reference Id No
IdentityType integer Identity Type for user identity No
ListOfIds [ string ] list Of user Ids that campaign should apply for No
ClientId long ClientId No
ClientKey string ClientKey No
SdkAppCode string SdkAppCode No
BatchStartTimeTrigger BatchStartTimeTriggerDto BatchTimeTrigger - used to ovewrite the time trigger initial start date - typically for campaign templates No

BatchStartTimeTriggerDto

Batch Time Trigger DTO Class

Name Type Description Required
StartDay integer Start Day of month No
StartMonth integer Start Month of year No
StartYear integer Start year No

BasicResponseDto

Basic Response DTO Class

Name Type Description Required
Code integer Response Code No
Message string Response Message No

GroupInfoDto

Group Info DTO Class.

Name Type Description Required
GroupRefId long Group Reference Id No
GroupName string Group Name No
ClientId long Client Id No
ClientKey string OpenBack Client Key No
appcode string Unique App Code No

CampaignDetailsDto

Campaign Details DTO Class

Name Type Description Required
CampaignName string Campaign Name - used to be to easily identify the campaign No
CampaignGroupId long Campaign Group Id - used to be able group similar messages together for reporting purposes No
ControlGroup string Control Group. Valid values are: OFF / ON / TRUE / FALSE No
CampaignStartDate long Campaign Valid from Start Date in EPOCH time value No
CampaignEndDate long Campaign Valid from End Date in EPOCH time value No
AppList [ AppInfoDto ] List of Apps message valid for No
ClientId long OpenBack Client Identifier - Provided by OpenBack No
ClientCampaignRefId long Unique Client Campaign Reference Identifier. A unique type long for each campaign. This value will be required to update the campaign or too see reporting information for the campaign No
ClientKey string OpenBack Client Key - Provided by OpenBack No
MessageType MessageDto Message Type DTO - Used when Intelligent Routing is disabled No
IntelligentRouting IntelligentRoutingDto Intelligent Routing - Used when message deliever escalations are required No
RecurringDeliverySettings DeliverySettingInfoDto Recurring Delivery Settings - Used to define rules to show multiple times or just once off or what time period between No
Triggers TriggersDto Rules to define when to deliever campaign No
IdentityInfo [ IdentityDto ] Identitiy Info is used to define which user get the campaign No
CampaignStatusId integer Campaign Status Identifier. Valid values 0 to 10 No
campaignId long Campaign Name - used to be to easily identify the campaign No
CampaignExpiryInSeconds long Campaign Expiry In Seconds No
IgnoreIfTriggersNotAvailable boolean Optional - Ignore If Trigger Not Available No
AttributionTag string Optional - AttributionTag No
ApiTemplate boolean Optional - ApiTemplate No
ChildFlag boolean Optional - ChildFlag - No
SensitivityFlag boolean Optional - SensitivityFlag - do not show notification on locked screen No
CampaignEndDateOnGoing boolean Optional - Campaign End Date OnGoing - No

AppInfoDto

App Info DTO Class

Name Type Description Required
SdkAppcode string Unique OpenBack App Code / Identifier No
AppType string Type of App. Valid Values ANDROID / IOS No
AndroidPackageName string Android Package Name No
IosBundleId string Ios App Bundle Id No

MessageDto

Message DTO Class

Name Type Description Required
ActiveMessageType integer Active Message Type. Valid values are: OpenBackNotification = 1 / InteractiveDisplayMessage=2 / SMS=3 / Email=4 / StandardPushNotification =5 / Wallpaper=6 No
NotificationDTO NotificationDto Notification Message No
InteractiveDisplayMessageDTO InteractiveDisplayMessageDto Interactive Display Message No
SmsDTO SmsInfoDto SMS Message No
EmailDTO EmailInfoDto Email Message No

IntelligentRoutingDto

Intelligent Routing DTO Class

Name Type Description Required
PrimaryMessageEnabled boolean Is Primary Intelligent Routing Message Enabled? No
PrimaryMessage MessageDto Primary Intelligent Routing Message Type No
PrimaryMessageExpiryTimeSeconds long Primary Intelligent Routing Message Expiry Time after displaying in Seconds No
SecondaryMessageEnabled boolean Is Secondary Intelligent Routing Message Enabled? No
SecondaryMessage MessageDto Secondary Intelligent Routing Message Type No
SecondaryMessageExpiryTimeSeconds long Secondary Intelligent Routing Expiry Time after displaying in Seconds No
ThirdMessageEnabled boolean Is Third Intelligent Routing Message Enabled? No
ThirdMessage MessageDto Third Intelligent Routing Message Type No
ThirdMessageExpiryTimeSeconds long Third Intelligent Routing Message Expiry Time after displaying in Seconds No

DeliverySettingInfoDto

DeliverySettingInfo DTO Class

Name Type Description Required
MessageAllowedSeenBefore boolean Is notification allowed to be seen before No
MaxNumberOfInteraction integer Maximum Number of Interactions Allowed before not displaying message again No
MinTimeInSecondBetweenDisplaying long Min Time In Seconds Between Displaying Message No
MaxNumberOfTimesToDisplay integer Max Number of Times Message Displayed No
Enabled boolean Delivery Settings Enabled? No
MinTimeInSecondBetweenInteractions long Minimum time after interaction before displaying the message again in seconds No

TriggersDto

Triggers Model

Name Type Description Required
ActivityTrigger ActivityTriggerDto Activity Trigger - Type of movement No
AeroplaneTrigger AeroplaneTriggerDto Aeroplane Mode Trigger No
AllUsersTrigger AllUsersTriggerDto All Users Trigger No
AppTrigger AppTriggerDto Other App Trigger No
AppOpenTrigger AppOpenTriggerDto App Open Trigger No
PowerTrigger PowerTriggerDto Power Trigger No
BeaconTrigger BeaconTriggerDto Beacon Trigger No
BluetoothTrigger BluetoothTriggerDto Bluetooth Trigger No
BoredomTrigger BoredomTriggerDto Boredom Trigger No
BrightnessTrigger BrightnessTriggerDto Brightness Trigger No
ConnectivityTrigger ConnectivityTriggerDto Connectivity Trigger No
CustomAppTrigger CustomTriggerDto Custom App Trigger No
DataConnectionTrigger DataConnectionTriggerDto Data Connection Trigger No
DelayTrigger DelayTriggerDto Delay Trigger No
DeviceOrientationTrigger DeviceOrientationTriggerDto Device Orientation Trigger No
DeviceTrigger DeviceTriggerDto Device Trigger No
EventTrigger EventTriggerDto Event Trigger No
FallbackTrigger FallbackTriggerDto Fallback Trigger No
GpsTrigger GpsTriggerDto Gps Trigger No
HeadphoneTrigger HeadphoneTriggerDto Headphone Trigger No
IdleTrigger IdleTriggerDto Idle Trigger No
InstallTrigger InstallTriggerDto Install Trigger No
LanguageTrigger LanguageTriggerDto Language Trigger No
LocationTrigger LocationTriggerDto Location Trigger No
MemoryTrigger MemoryTriggerDto Memory Trigger No
MobileOperatorTrigger MobileOperatorTriggerDto Mobile Operator Trigger No
NoiseTrigger NoiseTriggerDto Noise Trigger No
NotificationTrigger NotificationTriggerDto Notification Trigger No
NumberTrigger NumberTriggerDto Recent Call Or SMS Number Trigger No
ProximityTrigger ProximityTriggerDto Proximity Trigger No
RoamingTrigger RoamingTriggerDto Roaming Trigger No
SignalTrigger SignalTriggerDto Signal Trigger No
TimeTrigger TimeTriggerDto Time Trigger No
UnlockTrigger UnlockTriggerDto Unlock Trigger No
VersionTrigger VersionTriggerDto Version Trigger No
VolumeTrigger VolumeTriggerDto Volume Trigger No
WifiTrigger WifiTriggerDto Wifi Trigger No
WeatherTrigger WeatherTriggerDto Weather Trigger No
WorkflowTrigger WorkflowTriggerDto Workflow Trigger No

IdentityDto

Identity DTO Class

Name Type Description Required
IdentiferTypeId integer Identifer Id No
IdentiferValue string Identity Value No

NotificationDto

Notification DTO Class

Name Type Description Required
MessageType string Notification Message Type. Valid values are: URL / MESSAGE No
MessageTitle [ LocaleTextDto ] Notification Message title - Localised No
MessageContent [ LocaleTextDto ] Notification Message body - Localised No
MessageUrl [ LocaleTextDto ] Notification URL - On click opens URL - including Deep Links - Localised No

InteractiveDisplayMessageDto

Interactive Display Message DTO Class

Name Type Description Required
TypeId integer Interactive Display Message Type Id. Valid values are: Url = 1 / AppInstall=2 / Image=3 / Video=4 / Custom=5 / Other=6 No
Title [ LocaleTextDto ] Interactive Display Message title No
Content [ LocaleTextDto ] Interactive Display Message Content No
Url [ LocaleTextDto ] Interactive Display Message URL - Opens URL on click No
AppInstall [ LocaleTextDto ] Interactive Display Message - Opens App Store URL on Click No
Image [ LocaleTextDto ] Interactive Display Message Image URL - Localised No
Video [ LocaleTextDto ] Interactive Display Message Video URL - Localised No
Html [ LocaleTextDto ] Interactive Display Message HTML - Localised No

SmsInfoDto

SmsInfo DTO Class

Name Type Description Required
SmsProviderId long SmsProviderId No
SmsLinkId long SmsLinkId No
SmsContent [ LocaleTextDto ] SMS Content No

EmailInfoDto

EmailInfo DTO Class

Name Type Description Required
EmailProviderId long EmailProviderId No
EmailSubject [ LocaleTextDto ] Email Subject No
EmailLinkId long EmailLinkId No
EmailBody [ LocaleTextDto ] Email body No
EmailCcAddress string Email CC Address No
EmailBccAddress string Email BCC Address No

ActivityTriggerDto

ActivityTrigger DTO Class

Name Type Description Required
Enabled boolean Is Activity Trigger Enabled No
ActivityType string Type of activity. Valid values: STILL / WALKING / RUNNING / CYCLING / IN_VECHICLE No
ActivityOperator string Operator for type of activity. EQUALS / NOT_EQUALS No

AeroplaneTriggerDto

AeroplaneTrigger DTO Class

Name Type Description Required
Enabled boolean Is Aeroplane Mode Trigger Enabled? No
AeroplaneModeActive boolean Is Aeroplane Mode Active. Valid options are: TRUE / FALSE No

AllUsersTriggerDto

AllUsersTriggerDto DTO Class

Name Type Description Required
Enabled boolean All Users Trigger Enabled No
AllUsers boolean All Users Trigger - For standard push only No
IndividualUser boolean Individual User Notification No
UserToken string UserToken for individual user notificiation No

AppTriggerDto

App Trigger DTO Class

Name Type Description Required
Enabled boolean App Trigger Enabled No
AppActionType string App action type. Valid values are: INSTALLED / NOT_INSTALLED No
AppName string App Name for the name of app identifier determining if app installed or not installed No
AppPackageUrl string App Package Url / Bundle ID No

AppOpenTriggerDto

App Open Trigger DTO Class

Name Type Description Required
Enabled boolean Is App Open Trigger Enabled? No
OpenType string Is Mobile App Open or closed? Valid options are: OPENED / CLOSED No
OpenOperator string OpenApp Operator? Valid options are: EQUALS / NOT-EQUALS No

PowerTriggerDto

Power Trigger DTO Class

Name Type Description Required
Enabled boolean Is Power Trigger Enabled? No
BatteryLevel string Required Battery Level. Valid values are: NORMAL / GOOD / LOW / IGNORED No
IsCharging string Is device charging. Valid values are: NOT_SELECTED / CHARGING / NOT_CHARGING No
ChargingType string Type of device charging. Value values are: USB / AC No
PowerOperator string PowerOperator - Valid values are: EQUALS / NOT_EQUALS No

BeaconTriggerDto

BeaconTrigger DTO Class

Name Type Description Required
Enabled boolean Is Beacon Trigger enabled? No
BeaconOperator string Beacon Operator - Valid options are EQUALS / NOT_EQUALS No
Major integer Beacons Major Identifier No
Minor integer Beacons Minor Identifier No
Proximity integer Beacon Proximity No
Uuid string Beacons Unique User Identifier No

BluetoothTriggerDto

BluetoothTrigger DTO Class

Name Type Description Required
Enabled boolean Bluetooth Enabled No
Value string Bluetooth Value No
Operator string Bluetooth Operator - Valid options are EQUALS / NOT_EQUALS No

BoredomTriggerDto

BoredomTrigger DTO Class

Name Type Description Required
Enabled boolean Is Boredom Trigger enabled? No
BoredomValue string Boredom Value No
BoredomOperator string Boredom Operator. Valid values: EQUALS / NOT_EQUALS No

BrightnessTriggerDto

BrightnessInfo DTO Class

Name Type Description Required
Enabled boolean Is Brightness Trigger Enabled? No
Operator string Brightness Operator. Valid options are: BETWEEN / NOT_BETWEEN No
Level string Brightness Level. Valid options are: IS_BRIGHT / DAYLIGHT / TWILIGHT / IS_DARK No

ConnectivityTriggerDto

ConnectivityTrigger DTO Class

Name Type Description Required
Enabled boolean Is Connectivity Trigger Enabled? No
WifiStatus string WIFI Status/State. Valid options are: IGNORED / DISABLED / ENABLED / CONNECTED / DISCONNECTED No
WifiOperator string Wifi Operator. Valid Options are: EQUALS / NOT_EQUALS No
WifiSsidName string Wifi SSID Name No
WifiSsidOperator string WIFI SSID Operator. Valid Options are: CONNECTED / AVAILABLE / EQUALS / NOT_EQUALS No
BluetoothStatus string Bluetooth status/state. Valid options are: IGNORED / DISABLED / ENABLED No
BluetoothOperator string Bluetooth Operator. Valid Options are: EQUALS / NOT_EQUALS No
DataConnectionStatus string Data Connection Type status. Valid Option are: IGNORED / AVAILABLE / NOT-AVAILABLE No
DataConnectionOperator string DataConnection Operator. Valid Options are: EQUALS / NOT_EQUALS No
GpsStatus string GPS State. Valid Options are: IGNORED / ENABLED / DISABLED No
GpsOperator string Gps Operator. Valid Options are: EQUALS / NOT_EQUALS No

CustomTriggerDto

CustomTrigger DTO Class

Name Type Description Required
Enabled boolean Is Custom App Trigger Enabled? No
CustomValue1 CustomDto Custom Value 1 No
CustomValue2 CustomDto Custom Value 2 No
CustomValue3 CustomDto Custom Value 3 No
CustomValue4 CustomDto Custom Value 4 No
CustomValue5 CustomDto Custom Value 5 No
CustomValue6 CustomDto Custom Value 6 No
CustomValue7 CustomDto Custom Value 7 No
CustomValue8 CustomDto Custom Value 8 No
CustomValue9 CustomDto Custom Value 9 No
CustomValue10 CustomDto Custom Value 10 No

DataConnectionTriggerDto

DataConnection DTO Class

Name Type Description Required
Enabled boolean Enabled No
Value string DataConnection Value No
Operator string DataConnection Operator No

DelayTriggerDto

DelayTrigger DTO Class

Name Type Description Required
Enabled boolean Enabled No
DelayValue long Delay Value No

DeviceOrientationTriggerDto

Device Orientation Trigger DTO Class

Name Type Description Required
Enabled boolean Is Device Orientation Trigger Enabled? No
DeviceOrientationType string Device Orientation Type. Valid Values are: UP / DOWN / SIDE / UPSIDEDOWN / FACEUP / FACEDOWN No
DeviceOrientationOperator string Device Orientation Operator. Valid Values are: EQUALS / NOT_EQUALS No

DeviceTriggerDto

DeviceTrigger DTO Class

Name Type Description Required
Enabled boolean Is Device Trigger Enabled? No
HandsetModel string Handset Model Type. Valid values are available in the API portal No
HandsetModelOperator string Handset Model Operator. Valid values are: EQUALS / NOT_EQUALS No
HandsetBrand string Handset Brand Type. Valid values are available in the API portal No
HandsetBrandOperator string Handset Brand Operator. Valid values are EQUALS / NOT_EQUALS No
HandsetScreenSize string Handset Screen Size Type. Valid options are available in the API portal No
HandsetScreenSizeOperator string Handset Screen Size Operator. Valid values are: EQUALS / NOT_EQUALS No

EventTriggerDto

EventTrigger DTO Class

Name Type Description Required
Enabled boolean Is Device Event Trigger Enabled? No
EventType string Device Event Type. Valid values are: POST_CALL_EVENT / SMS_EVENT No
EventOperator string Device Event Operator. Valid options are EQUALS / NOT_EQUALS No

FallbackTriggerDto

FallbackTrigger DTO Class

Name Type Description Required
Enabled boolean Enabled No
FallbackValue long Fallback Value No
FallbackOperator string Fallback Operator No
FallbackType string Fallback Type No
FallbackTimeValue long Fallback Time Value No

GpsTriggerDto

GpsTrigger DTO Class

Name Type Description Required
Enabled boolean Gps Trigger Enabled No
GpsValue string Gps Value No
GpsOperator string Gps Operator No

HeadphoneTriggerDto

HeadphoneTrigger DTO Class

Name Type Description Required
Enabled boolean Headphones Enabled No
HeadphonesConnected boolean Headphones Connected No

IdleTriggerDto

IdleTrigger DTO Class

Name Type Description Required
Enabled boolean Is Idle Trigger Enabled? No
IdleValue long Minimum Idle Time required to be considered as idle No
IdleOperator string Idle Operator Valid values are: EQUALS / NOT_EQUAL No

InstallTriggerDto

InstallTrigger DTO Class

Name Type Description Required
Enabled boolean Is Install Trigger enabled? No
FirstType string First Type. Valid values are: INSTALL / RUN No
FirstOperator string First Operator. Valid values are: EQUALS / NOT_EQUALS No

LanguageTriggerDto

LanguageTrigger DTO Class

Name Type Description Required
Enabled boolean Is Language Trigger Enabled? No
Region string Language Region Value. Valid values are available in the API portal No
RegionOperator string Region Operator. Valid values are: EQUALS / NOT_EQUALS No
Language string Locale Language value. Valid values are available in the API portal No
LanguageOperator string Language Operator. Valid values are: EQUALS / NOT_EQUALS No

LocationTriggerDto

LocationTrigger DTO Class

Name Type Description Required
Enabled boolean Is Location Trigger Enabled? No
LocationType string Location Type. Valid Values are: COUNTRY / EXACT / HOME / WORK No
Country string Location Country No
CountryIso string Country Iso Code No
UserHome boolean UserHome No
HomeOperator string HomeOperator. Valid option are: EQAULS / NOT_EQUALS No
UserWork boolean UserWork No
WorkOperator string WorkOperator. Valid option are: EQAULS / NOT_EQUALS No
ExactAddress string Location Exact address, includes street address, county, country, etc.. No
ExactRange integer Valid Range Distance in KM No
ExactLongitude float Location Exact Longitude No
ExactLatitude float Location Exact Latitude No
CellId string CellId No
LocationOperator string Location Operator. Valid values are: EQUALS / NOT_EQUALS No

MemoryTriggerDto

MemoryTrigger DTO Class

Name Type Description Required
Enabled boolean Memory Trigger Enabled? No
Storage long Available Device Storage. Valid Values are: -1 / 0 / 50 / 100 / 250 / 500 / 1024 / 2048 No
StorageOperator string Device Storage Operator. Valid values are: NOT_SELECTED / LESS_THAN_OR_EQUALS_TO / GREATER_THAN_OR_EQUALS_TO No
Memory long Available Device Memory. Valid Values are: -1 / 0 / 50 / 100 / 250 / 500 / 1024 / 2048 No
MemoryOperator string Device Memory Operator. Valid values are: NOT_SELECTED / LESS_THAN_OR_EQUALS_TO / GREATER_THAN_OR_EQUALS_TO No

MobileOperatorTriggerDto

MobileOperatorTrigger DTO Class

Name Type Description Required
Enabled boolean Is Mobile Operator Trigger Enabled? No
MobileOperatorName string MobileOperatorName No
MobileOperatorOperator string Mobile Operator Operator. Valid Values are: EQUALS / NOT_EQUALS No
MobileOperatorMcc string Mobile Operator Mcc No
MobileOperatorMnc string Mobile Operator Mcc Mnc No
MpoCode string OpenBack Mobile Operator Code - As mobile operators code can be owned multiple MNC codes No

NoiseTriggerDto

NoiseTrigger DTO Class

Name Type Description Required
Enabled boolean Enabled No
NoiseOperator string Noise Operator No
NoiseLevel string Noise Level - Different level types are available in the portal No

NotificationTriggerDto

NotificationInfo DTO Class

Name Type Description Required
Enabled boolean Notification Trigger Enabled No
Value integer Notification Value No
Operator string Notification Operator No
NotificationOption string Notification Option types. Valid options are ALLOWED BLOCKED

NumberTriggerDto

NumberTrigger DTO Class

Name Type Description Required
Enabled boolean Is Recent Call Or SMS Trigger Enabled? No
Direction string Direction of call or SMS. Valid options are: INCOMING / OUTGOING No
Country string Country of incoming or outgoing Communication No
CountryCode string Number Country Code No
MinNumberOfEvents integer Number Min Number of events No
CommunicationType string Type of communication. Valid options are: CALL / SMS / BOTH No
PhoneNumber string Phone Number of communication No
PhoneNumberType string Phone Number Type, Exact number or number begins with. Valid Options are: EXACT / BEGINS-WITH No
PhoneNumberAmount integer Minimum Number of Calls or SMS required No

ProximityTriggerDto

ProximityTrigger DTO Class

Name Type Description Required
Enabled boolean Is Proximity Trigger Enabled? No
InHand boolean Is Proximity sensor in hand/covered. Valid values are: TRUE / FALSE No

RoamingTriggerDto

RoamingTrigger DTO Class

Name Type Description Required
Enabled boolean Is Roaming Trigger enabled? No
IsRoaming boolean Is device currently Roaming? No

SignalTriggerDto

SignalInfo DTO Class

Name Type Description Required
Enabled boolean Enabled No
Signal Type string Signal type(strenght). Valid values are: NO_SIGNAL / 2G / 2.5G / 3G / 3.5G / 4G No
SignalOperator string Signal Operator. Valid values are: EQUALS / NOT_EQUALS / GREATER_THAN / LESS_THAN No

TimeTriggerDto

TimeTrigger DTO Class

Name Type Description Required
Enabled boolean Enable No
Repeating boolean Repeating Time Type No
Day integer Day of month. Valid values are: 1 - 31 depending on the month No
Month integer Month of year. Valid values are: 1 - 12 No
Year integer Year. Valid values from todays date to 2 years into the future No
Hour integer Hour of day. Valid values are: 0 - 23 No
Minute integer Minute of Hour. Valid values are: 0-59 No
Second integer Second of minute. Valid values are: 0 - 59 No
TimeRangeUnit string Valid Time Range Unit. Window of time the trigger is still active for. Valid values are: DAY / HOUR No
ValidTimeOperator string ValidTimeOperator No
TimeRangeValue long Lenght of time value. Valid values are greater than 0 No
IsGmt boolean Time is GMT time instead of device time No
FrequencyType string Repeat Frequency Type. Valid Values are: YEARLY / MONTHLY / WEEKLY / DAILY No

UnlockTriggerDto

UnlockTrigger DTO Class

Name Type Description Required
Enabled boolean Is Unlock Trigger enabled? No
Unlocked boolean Unlocked status No

VersionTriggerDto

VersionTrigger DTO Class

Name Type Description Required
Enabled boolean Is Version Trigger enabled? No
Os string Version OS Value No
OsOperator string Version OS Operator No
App string Version App Value No
AppOperator string Version App Operator No

VolumeTriggerDto

VolumeTrigger DTO Class

Name Type Description Required
Enabled boolean Enabled No
Ringer long Devices Ringer/Ringing volme level. Valid values are: 100 / 90 / 80 / 70 / 60 / 50 / 40 / 30 / 20 / 10 / 0 No
RingerOperator string Ringer Volume Operator. Valid values are: EQUALS / NOT_EQUALS / GREATER_THAN / GREATER_THAN_OR_EQUALS_TO / LESS_THAN / LESS_THAN_OR_EQUALS_TO No
Media long Devices Media volme level. Valid values are: 100 / 90 / 80 / 70 / 60 / 50 / 40 / 30 / 20 / 10 / 0 No
MediaOperator string Media Volume Operator. Valid values are: EQUALS / NOT_EQUALS / GREATER_THAN / GREATER_THAN_OR_EQUALS_TO / LESS_THAN / LESS_THAN_OR_EQUALS_TO No

WifiTriggerDto

WifiTrigger DTO Class

Name Type Description Required
Enabled boolean Wifi Trigger Enabled? No
StatusType string Wifi Status Type. Valid options are: CONNECTED / DISCONNECTED / ENABLED / DISABLED No
StatusTypeOperator string Wifi Status Type Operator No
SsidName string SSID Name No
SsidOperator string SSID Operator No
AvailableSsid string Available SSID No
AvailableSsidOperator string Available SSID Operator No

WeatherTriggerDto

WeatherTrigger DTO Class

Name Type Description Required
Enabled boolean Is Weather Trigger Enabled? No
TemperatureType string Temperature Type. Valid values are: IGNORED / FREEZING / COLD / WARM / HOT No
TemperatureOperator string Temperature Operator. Valid values are: BETWEEN / NOT_BETWEEN No
HumidityType string Humidity Type. Valid values are: IGNORED / VERY_WET / WET / DAMP / DRY / VERY_DRY No
HumidityOperator string Humidity Operator. Valid values are: BETWEEN / NOT_BETWEEN No

WorkflowTriggerDto

WorkflowInfo DTO Class

Name Type Description Required
Enabled boolean Is Workflow Trigger enabled? No
PreviousCampaignId long Previous Campaign Id No
WorkFlowOperator string Workflow Operator No
DeadlineDate long Workflow Deadline Date in EPOCH time No

LocaleTextDto

Locale Text DTO Class

Name Type Description Required
MessageText string Message Text No
LanguageIso string Language ISO. Valid Language ISO codes No
LanguagePosition integer Language Position No

CustomDto

Custom DTO Class

Name Type Description Required
Enabled boolean Is Custom Value Enabled? No
Value string Custom Value No
Type string Custom Type. Valid values are: STRING / INTEGER / FLOAT No
Operator string Custom Operator. Valid values are: EQUALS / NOT_EQUALS /LESS_THAN / LESS_THAN_OR_EQUALS_TO / GREATER_THAN / GREATER_THAN_OR_EQUALS_TO / LIKE / NOT_LIKE No
Label string Custom Label No

ReportRequestDto

App Summary Report DTO Class

Name Type Description Required
SdkAppCode string App Code No
ClientId long Client ID No
ClientKey string Client Key No
GroupRefId long Client Group Reference Id No
ClientCampaignRefId long Client Campaign Reference Id No
PeriodType string Time Period Type. Valid Values DAY / MONTH / YEAR / DATE / RANGE No
DayOfMonth integer Report Day Of Month No
MonthOfYear integer Report Month Of Year No
Year integer Report Year No
RangeStartDate long Report Range Start Date in Epoch Time No
RangeEndDate long Report Range End Date in Epoch Time No
GoalCode string Goal Code No

GdprRequestDto

GdprRequest DTO Class

Name Type Description Required
ClientId string Sdk App Code No
ClientKey string ClientKey No
SdkAppCode long Client Id No
IdentityType string Identity Type No
IdentityValue string Apn Certificate File Name No
Username string Username No

AppReportResponseDto

App Report Response DTO Class

Name Type Description Required
Code integer Response Code No
Message string Response Message No
AppSummaryReport [ AppSummaryReportDto ] App Summary Report No

AppSummaryReportDto

App Summary Report DTO Class

Name Type Description Required
SdkAppCode string App Code No
AppName string App Name No
AppStatus string App Status No
OsType string OS Type No
Active long Number of Active Apps No
Disengaged long Number of Disengaged Apps No
Triggers long Number of Triggers No
DeliveredMessages long Number of Delivered Messages No
ReportDate long Generated Report Date - EPOCH TIME No
CurrentNotificationsBlocked long Number of users that have notifications blocked/turned off and have your app installed No
TotalNotificationsBlocked long Number of users that have notifications blocked/turned off and have every had your app installed with the OpenBack library installed No
NotificationsAllowed long Number of users that have notifications allowed/turned on No
NewUsersInLast30Days long New Users In Last 30 Days No
TotalNumberOfAllTimeInstalls long Total Number Of All Time Installs (with OpenBack library installed) No

CampaignListResponseDto

Campaign List Response DTO Class

Name Type Description Required
Code integer Response Code No
Message string Response Message No
CampaignList [ CampaignDetailsDto ] Campaigns Returned No

CampaignReportResponseDto

Campaign Report Response DTO Class

Name Type Description Required
Code integer Response Code No
Message string Response Message No
CampaignSummaryReport [ CampaignSummaryReportDto ] Campaign Summary Report No

CampaignSummaryReportDto

Campaign Summary Report DTO Class

Name Type Description Required
SdkCampaignId long Campaign Id No
ClientCampaignRefId long Client Campaign Ref Id No
CampaignName string Campaign Name No
CampaignStatus string Campaign Status No
SdkAppCode string SDK App Code No
MessageType string Message Type No
StartDateRange long Start Date Range - EPOCH No
StartDateRangeDesc string Start Date Range - Human Readable - UTC Time No
EndDateRange long End Date Range - EPOCH No
EndDateRangeDesc string End Date Range - Human Readable - UTC Time No
Delivered long Message Delivered No
Opened long Opened Messages No
OpenedRate double Opened Message Percentage No
Interacted long Interacted Messages No
InterRate double Interacted Message Percentage No
Allowed long Notification Allowed No
Blocked long Notification Blocked No
IRMessages long Intelligent Routed Messages No
IRSms long Intelligent Routed SMS No
IREmail long Intelligent Routed Email No
ReportDate long Generated Report Date - EPOCH TIME No
Goals long Number of Goals No
Dismisses long Number of Dismisses No

CampaignResponseDto

Campaign Response DTO Class

Name Type Description Required
Code integer Response Code No
Message string Response Message No
Campaign CampaignDetailsDto Returned Campaign No

GroupResponseDto

Group Response DTO Class

Name Type Description Required
Code integer Response Code No
Message string Response Message No
GroupList [ GroupInfoDto ] Group List No

TrackingIdResponseDto

TrackingId Response DTO Class

Name Type Description Required
Code integer Response Code No
Message string Response Message No
ListTrackingIds [ string ] List Tracking Ids No

GoalReportResponseDto

Goal Report Response DTO Class

Name Type Description Required
Code integer Response Code No
Message string Response Message No
GoalSummaryReport [ GoalSummaryReportDto ] Goal Summary Report No

GoalSummaryReportDto

Goal Summary Report DTO Class

Name Type Description Required
ReportTimestamp long Timestamp of goal report summary No
GoalName string AppName No
GoalDescription string Campaign Name No
StatusText string Status Text No
ClientId long Client Id No
StartDate string Start Date No
EndDate string End Date No
GoalValue double Goal Value No
DirectGoals long Total number of direct goals No
TotalGoalsWithinTimeframe long Total number of goals within timeframe No
TotalGoalsOutsideOfTimeframe long Total number of goals outside of timeFrame No
NoOfSteps integer NoOfSteps No
GoalCode string Goal Code No
TotalNumberOfGoals long TotalGoals No
TotalGoalValue double Total Goal Value No
DirectGoalsValue double Direct Goals Value No
WithinGoalTimeFrameValue double Number of goals within time frame No
Cpa double Cost per acquisition No
Roas string Return on ad spend No
OutsideGoalTimeFrameValue double Goals outside of Time Frame Value No
ActualGoalValue double Actual Goal Value - values passed into the SDK No