Skip Navigation
  1. BlackBerry Docs
  2. BlackBerry AtHoc
  3. BlackBerry AtHoc SDKs and APIs 7.13
  4. SDK Specification
  5. Publish alert API
  6. Alert payload definition

Alert payload definition

XML format
See SDK envelope request section for detailed formatting specifications.
The payload type is INFOCASTING.
The payload content should be in the following format: 
<infocasting type="ALERT|ALERTNAME|ALERTSCENARIO" id="serviceId|serviceCommonName|serviceName|scenarioCommonName|scenarioId">
        
<!-- Alert Content, Delivery Devices, and other details -->

<alertData>
<channel>
<commonName>alert folder common name </commonName>
</channel>
<scenario>
<commonName> scenario common name </commonName>
</scenario>
<action>STANDBY|PUBLISH|UPDATE|APPEND|END </action>
<auid>a unique id generated by the alert creator</auid>
<header>alert header</header>
<body>alert body</body>
<url>url to use when clicking on alert</url>
<location>{"features":[{"geometry":{"coordinates":[[[-118.117335,34.103998],[-118.117335,33.929841],[-117.845423,33.929841],[-117.845423,34.103998],[-118.117335,34.103998]]],"type":"Polygon","bbox":[-118.117335,33.929841,-117.845423,34.103998]},"properties":{"status":"add"},"type":"Feature","bbox":[-118.117335,33.929841,-117.845423,34.103998]}],"type":"FeatureCollection"}</location>
<startDate>scheduled start date</startDate>
<liveDate>alert duration date</liveDate>
<UTCtimestamp>Y</UTCtimestamp>
<endDate>alert end date</endDate>
<type>Security</type>
<severity>High</severity>
<responseOptions>
<responseOption>
<responseId />
<responseText>I am joining conference now</responseText>
<callBridgePhoneNumber>800-455-4555X21344</callBridgePhoneNumber>
</responseOption>
<responseOption>
<responseId />
<responseText>I cannot join the conference</responseText>
</responseOption>
</responseOptions>
<metaStore/>
<metaStoreJSON/>
<notifierTemplate>desktop popup template id</notifierTemplate>
<audioId>desktop popup audio id</audioId>
<messagePriority>1</messagePriority>
<consolidateMessages>Y|N</consolidateMessages>
<!-- Specifying Delivery Devices -->
<deliverySettings type="SYS|OPR|USR">
<device commonname="DesktopPopup" />
<device commonname="phoneWork" deliveryPriority="2" />
</deliverySettings>
<!-- Specifying Delivery Devices Extended Options -->
<advancedDeliverySettings>
<AlertExtensions>
<AlertExtension ExtensionID="id" CommonName="common name">
<data>
<element id="id"/>
</data>
</AlertExtension>
</AlertExtensions>
</advancedDeliverySettings>
<origin type="CASCADING | FEED | RECURRING | MANUAL">
<system>Alert Origin System Name</system>
<provider>Origin Provider (organization) Name</provider>
<publisher>Originating Alert Publisher</publisher>
</origin>
</alertData>
<!-- Targeting Users by various mechanisms -->
<userData type="USR|IP" targetAll="Y|N" >
<!-- Targeting individual Users -->
<id isBlocked=”Y|N”>user id</id>
<id isBlocked=”Y|N”>user id</id>
<mid isBlocked=”Y|N”>mapping user id</mid>
<mid isBlocked=”Y|N”>mapping user id</mid>
<!-- Targeting by Groups -->
<groupId>group id</groupId>
<groupId isBlocked="Y" isGroupSet="N">group id</groupId>
<groupId isBlocked="N" isGroupSet="Y">groupset id</groupId>
<groupCommonName>group common name</groupCommonName>
<groupCommonName isBlocked="Y" isGroupSet="N">group common name</groupCommonName>
<groupCommonName isBlocked="N" isGroupSet="Y">groupset common name</groupCommonName>
<!-- Targeting by Org Hierarchy/Dist List Folders/IP List Folders -->
<hierarchyLocation commonname="Organizational Hierarchy|Dist Lists|IP Lists" >
<path isBlocked=”Y|N”>/Node1/Node12/Node121/</path>
<path isBlocked=”Y|N”>/Node2/</path>
</hierarchyLocation>
<!-- Targeting by individual Dist Lists -->
<distributionList commonname="List-A" type="STATIC|DYNAMIC|IP" isBlocked="N|Y" />
<!-- Targeting by Advanced Query -->
<attributeCondition id="UserAttributeId" name="AttributeName" commonname=" AttributeCommonName" >
<condition>EQUALS | NOT EQUALS | CONTAIN | DOES NOT CONTAIN | STARTS WITH | ENDS WITH | LESS THAN | GREATER THAN | LESS THAN EQUAL | GREATER THAN EQUAL | </condition>
<searchValues>
<value>Burlingame</value>
<value>94040</value>
</searchValues>
</attributeCondition>
<deviceCondition commonname="workEmail" id="2">
<condition>EQUALS</condition>
<searchValues>
<value>jsmith@acme.com</value>
</searchValues>
</deviceCondition>
</userData>
        
<!--Place Holders -->

<placeHolders>
<placeHolder>
<name>PlaceHolder name</name>
<value>PlaceHolder value</value>
</placeHolder>
</placeHolders>
</infocasting>
Mandatory nodes
<alertData> (mandatory for an alert message)
This node contains the data for an alert message, including the following alert-specific fields:
<ALERTDATA> Tags
Tag
Mandatory
Description
<action>
No
Optional action: STANDBY, PUBLISH, UPDATE, END. Defines the action to perform. If <action> is not specified, PUBLISH is the default action.
For UPDATE the <auid> node is mandatory; for END either <auid> node or <id> node is mandatory.
END of an alert moves it to the Ended.
STANDBY is used to put an alert in Standby mode, without publishing the alert.
PUBLISH publishes a new alert, or publishes an alert in Standby (use the same <auid> value.)
<channel>
No
Element:
commonName
—The alert folder common name. See the rules under <scenario> in this table.
<scenario>
No
Element:
commonName
—The alert template common name. Rules:
View Alert Folder
Y
N
Valid Alert Template
Y
Use given alert folder. Use given alert template.
User given alert template, and use the alert folder of the alert template.
N
Use given alert folder, use a new alert template.
Use new alert template, and use alert folder associated with this alert template.
<header>
Yes
Title; max size is 200 characters, longer will be truncated. The <header> tag is internationalization-enabled.
<body>
No
Notification body; max size is 4000 characters, longer will be truncated. The <body> tag is internationalization-enabled.
<url>
No
The notification target URL; max size is 1024 characters
<auid>
No
A unique ID per organization generated by the creator of the alert. This ID can be used by the client to track or end alerts.
If an incoming alert does not contain auid, the BlackBerry AtHoc will generate a unique GUID as the AUID and pass it back in the response payload.
<location>
No
This tag contains location information for an alert. The data format for this tag must be Geo Json.
<messagePriority>
No
Priority when used with deliverySettings = SYS, will be used to determine which system delivery preference to use for the alert. Priority can be a value between 1 and 3.
The default value is taken from the alert scenario or alert folder.
<deliverySettings>
No
Attribute:
type
—possible values: SYS, OPR
  • SYS—(default) use system defined device delivery preferences for a given message priority.
  • OPR—Use the device delivery preferences specified in the subnode <devices>
<metaStore>
No
XML-based additional information for the alert.
<metaStoreJSON>
No
JSON-based additional information for the alert. It is a best practice to include a client identifier and version in this payload because there may be alerts that were not sent by the same SDK client or version of that SDK client.
<advancedDeliverySettings>
No
Advanced options for device delivery, such as templates, alternate for options (Cloud services, giant voice, LMR, etc.)
<cap11>
No
Alert message specified in Common Alerting Protocol version 1.1 format that will be stored as is with other alert details.
<cdcPhin>
No
Alert message specified in CDC-PHIN format that will be stored as is with other alert details.
<audioId>
No
Desktop Popup Audio ID (taken from the Audio Files manager on the Management System). Default is taken from alert folder, if not specified.
<notifierTemplate>
No
Desktop popup template ID; if no template ID is specified, the alert folder default desktop popup template is used.
<UTCtimestamp>
No
When set to Y, the alert start, live and end dates mentioned below are considered in UTC time zone. Default value is N, which uses the local time zone.
<startDate>
No
When the notification will become live (distributed to end-users). If not specified, the notification becomes live immediately.
Format: yyyy-mm-ddThh:mm:ss
<liveDate>
No
Time to keep the alert message alive and display it in the alert history to end users. Cannot be earlier than startDate. If not specified, the default live date for the alert folder is used. If liveDate is specified for an existing alert along with the AUID, it updates the existing alert message.
Format: yyyy-mm-ddThh:mm:ss
<endDate>
No
Expiration date and time for the alert. After the expiration time, the alert will not be available to end users in the alert history. Cannot be earlier than liveDate. If not specified, the default end date for the alert template is used. If endDate is specified for an existing alert along with the AUID, it updates the existing alert message.
Format: yyyy-mm-ddThh:mm:ss
<type>
No
Type value for the alert. Expected values include:
  • CBRNE
  • Env
  • Fire
  • Geo
  • Health
  • Infra
  • Met
  • Rescue
  • Safety
  • Security
  • Transport
<severity>
No
Severity value for the alert. Expected values include:
  • High
  • Moderate
  • Low
  • Informational
  • Unknown
<reponseOptions>
No
These options can be specified to obtain a response from end users upon message delivery. This response is tracked in the system and is available through alert tracking reports. The <responseOptions> tag is internationalization-enabled.
<origin>
No
This node provides additional visibility into the alert being published within the BlackBerry AtHoc system. If specified, the originating details about the alert are maintained along with the alert definition, and are displayed in Sent Alerts.
Origin node has following sub nodes:
  • Attribute:
    type
    —possible values: CASCADING, FEED, RECURRING, MANUAL (default is MANUAL)
  • Sub Node:
    system
    —name of the physical system where the alert originated.
  • Sub Node:
    provider
    —name of the organization where the alert originated.
  • Sub Node:
    publisher
    —name of the publisher who published this alert at the original location.
<consolidateMessages>
No
This node controls the consolidation of messages for a shared phone or email address into one message.
Possible values: Y or N, Default value: Y
Note that under consolidation mode, the phone messages with Pin or validate recipient requirements will not be delivered.
The date and time parameters should be specified in absolute time, using the server time zone and formatted as XML dateTime:
yyyy-m-dThh:mm:ss.
For example,
2003-9-10T15:7:00.
Optional nodes
<userData> (optional)
  • The userData node is used for targeting content to individual users or groups of users.
  • The following types of user identification can be used:
<USERDATA> Tags
Tag
Mandatory
Description
type
 (attribute)
No
Values are:
USR
,
IP
USR—(Default) User based alerting.
IP—IP based alerting.
targetAll
 (attribute)
No
Values are:
Y
,
N
Y: Target all user base. This can be used along with blocked groups and users.
N: (Default) Do not target all user base.
<Id>
or
<mid>
No
These identifiers can be used when a specific user needs to be alerted.
ID
is the internal AtHoc numeric user ID.
mid
is the user mapping ID (alias).
Alerting a large number of individual users in this manner is not recommended for performance reasons. Distribution lists should be used in this case.
<groupId>
or
<groupCommonName>
No
Group ID
 or
Group Common Name
 for the group to be targeted. The term group is used to represent custom attributes of end users with the following attribute types:
  • Single PickList
  • Multi Picklist
  • CheckBox or Boolean
Other optional targeting options:
  • isBlocked
    : Whether to block a certain group (Default value is targeted if this attribute is not specified)
  • isGroupSet
    : Whether the specified group is a GroupSet or a Group (Default value is Group, if this attribute is not specified)
<hierarchyLocation>
No
If an alert is targeted by hierarchy, specify the hierarchy common name (from Management System) and path to the targeted node.
HierarchyLocation
can also be used to target distribution list folder nodes.
If more than one
hierarchyLocation
is specified, users belonging to any of the specified paths will be targeted.
<distributionList>
No
If an alert is targeted to specific distribution lists (Static, Dynamic or IP), specify their common name or Id number.
If more than one distributionList node is specified, users belonging to either of these lists will be targeted (inclusive).
<attributeCondition>
No
If an alert is targeted using an advanced search query on user attributes, specify the user attribute ID, common name or name and search condition and value. If the search is on pick list based attributes, the <value> node within <searchValues> can contain either the pick list value ID or common name.
If more than one value is specified for one attribute, the search will be inclusive (Boolean OR) of all values within the given attribute condition.
If more than one attribute condition is specified, the search will be exclusive (Boolean AND) across these conditions.
<deviceCondition>
No
Same as attributeCondition except this is used to target users based upon queries on their device addresses. For example, target all users whose email address ends with yahoo.com using the following search condition: 
<deviceCondition commonName="homeEmail">
            <condition>ENDS WITH</condition>
            <searchValues>
            <value>yahoo.com</value>
            </searchValues>
            </deviceCondition>
Multiple identity criteria for a single identity type can be specified. In these cases, the alert is sent to all users who meet the criteria. Note that identity criteria types cannot be mixed. For example, individual user IDs and group IDs cannot be targeted in the same INFOCASTING call. If no userData is specified, the alert is distributed to all users specified in the alert template.
<placeHolders> (optional)
  • The placeHolders node contains one or more Place Holder nodes.
  • Place Holders in Alert text (header, body, URL, response options, and alert extensions) are searched by placeholder tag and replaced with the provided value.
  • Syntax: [[Place Holder name]] or [[Place Holder name=default value]]
<PLACEHOLDER> Tags
Tags
Mandatory
Description
Name
Yes
Name of the Place Holder. For system place holders, one of the reserved names:
PublishDate, PublishTime, Timezone, VirtualSystemName, OperatorFullName, OperatorEmail,
 or
SystemName.
For custom place holders, the name must be unique within the organization, and cannot include square brackets - [[ ]] or names reserved for system place holders. The place holder name must match a pre-defined custom place holder name.
Value
Yes, for custom placeholders
Replacement value for the custom place holder.
For custom placeholders, the value can be one of the following types:
  • Text: a text string
  • Date: a date value that is compatible with .NET requirements¹
  • Time: a time value that is compatible with .NET requirements¹
  • DateTime: a datetime value compatible with .NET¹ requirements.
  • Single-selection: a node value that matches one of the pre-defined values for the placeholder.
    <value>value1</value>
  • Multiple-selection: one or more node values that matches one or more pre-defined placeholder values.
    <value>value1</value>
    <value>value2</value>
    <value>value3</value>
¹ See the .NET Date and Time format string examples on the Microsoft.com Web site.
Place holder examples
The following two examples show how you can specify place holders.
Type: Time
The following example displays a custom placeholder that specifies a time value. 
<placeHolders>
<placeHolder>
<name>Meeting Time</name>
<value>1:00:00</value>
</placeHolder>
…
</placeHolders>
Type: multiple-selection
The following example displays a custom placeholder that specifies multiple selections from previously specified values. 
<placeHolders>
<placeHolder>
<name>Colors</name>
<value>Red</value>
<value>Blue</value>
<value>Yellow</value>
</placeHolder>
…
</placeHolders>
Advanced delivery settings
These extensions usually require services or hardware from other vendors. The mandatory tags are all required when using alert extensions.
<ALERTEXTENSIONS> Tags
Tag
Mandatory
Description
<AlertExtension>
Yes
AlertExtension node has the following attributes:
  • Attribute
    ExtensionId
    : Valid values depend on what the system has been configured with.
  • Attribute
    CommonName
    : The common name of the alert extension.
<data>
Yes
Container for the element extension properties.
<element>
Yes
Elements describe extension properties. Attribute id – distinguishes one element from another. See Sample Extensions below.
Sample extensions
 
<advancedDeliverySettings>
<AlertExtensions>
<!--Example Telephony Extension-->
<AlertExtension ExtensionID="" CommonName="TELEPHONY-EXTENSIONS">
<data>
<element id="AlertExtension.DeviceGroup.Telephony.DeliveryType">Custom</element>
<element id="AlertExtension.DeviceGroup.Telephony.DeliveryType.Custom.StopCalling.Criteria">Answered</element>
<element id="AlertExtension.DeviceGroup.Telephony.DeliveryType.Custom.CallOption.ValidateRecipients" />
<element id="AlertExtension.DeviceGroup.Telephony.DeliveryType.Custom.CallOption.RequirePIN" />
<element id="AlertExtension.DeviceGroup.Telephony.DeliveryType.Custom.CallOption.ReplayMessage" />
<element id="AlertExtension.DeviceGroup.Telephony.DeliveryType.Custom.CallOption.LeaveMessage" />
<element id="AlertExtension.DeviceGroup.Telephony.DeliveryType.Custom.CallOption.LeaveCallback" />
<element id="AlertExtension.DeviceGroup.Telephony.ContactCycle.Count">1</element>
<element id="AlertExtension.DeviceGroup.Telephony.ContactCycle.Delay">00:05</element>
</data>
</AlertExtension>
<!--Example GiantVoice Extension-->
<AlertExtension ExtensionID=""  CommonName="GV-EXTENSIONS">
<data>
<element id="AlertExtension.DeviceGroup.LandMobileRadio.ContentSource">TextToSpeech</element>
<element id="AlertExtension.DeviceGroup.LandMobileRadio.ContentSource.Audio.AudioID" />
<element id="AlertExtension.DeviceGroup.GiantVoice.ContentSource.Key.KeyID" />
<element id="AlertExtension.DeviceGroup.LandMobileRadio.ContentSource.TextToSpeech.TTSSource">MessageHeader</element>
<element id="AlertExtension.DeviceGroup.LandMobileRadio.ContentSource.TextToSpeech.TTSSource.CustomText.Value"/>
</data>
</AlertExtension>
<!--Example Cisco Extension -->
<AlertExtension  ExtensionID="" CommonName="CISCO-UAP-EXTENSIONS">
<data>
<element id="AlertExtension.DeviceGroup.UCM.Visual.DisplayImage">CustomURL</element>
<element id="AlertExtension.DeviceGroup.UCM.Visual.DisplayImage.Image.File" />
<element id="AlertExtension.DeviceGroup.UCM.Visual.DisplayImage.CustomURL.Path">http://athoc.com/logo.gif</element>
<element id="AlertExtension.DeviceGroup.UCM.Ringtone.Source">Custom</element>
<element id="AlertExtension.DeviceGroup.UCM.Ringtone.Source.Custom.File">|ClockShop.raw</element>
<element id="AlertExtension.DeviceGroup.UCM.Audio.Source">Body</element>
<element id="AlertExtension.DeviceGroup.UCM.Audio.Source.Custom.Value" />
<element id="AlertExtension.DeviceGroup.UCM.Audio.RepeatAudio">on</element>
<element id="AlertExtension.DeviceGroup.UCM.Audio.RepeatAudio.RepeatAudioValue">3</element>
</data>
</AlertExtension>
<!--Example Email Extension -->
<AlertExtension ExtensionID="1010" CommonName="SMTP-EXTENSIONS">
<data>
<element id="AlertExtension.DeviceGroup.Template.TemplateType">Custom|Default</element>
<element id="AlertExtension.DeviceGroup.Template.TemplateType.Custom.Id"><template ID></element>
<element id="AlertExtension.DeviceGroup.EMail.Source">HeaderBody|Custom</element>
<element id="AlertExtension.DeviceGroup.EMail.Source.Custom.Title">Body Text</element>
<element id="AlertExtension.DeviceGroup.EMail.Source.Custom.Body">Custom body text</element>
</data>
</AlertExtension>
</AlertExtensions>
</advancedDeliverySettings>
ExtensionId: 1001,  CommonName: TELEPHONY-EXTENSIONS
Element ID: AlertExtension.DeviceGroup.Telephony.DeliveryType
Values:
  • Informational
  • emergency
    (default)
  • Secure
  • Custom
Element ID: AlertExtension.DeviceGroup.Telephony.ContactCycle.Delay
Values:
  • hh:mm (default = 00:10)
Element ID: AlertExtension.DeviceGroup.Telephony.ContactCycle.Count
Values:
  • Numeric (default = 1)
Element ID: AlertExtension.DeviceGroup.Telephony.DeliveryType.Custom.StopCalling.Criteria
Values:
  • Listened
  • Acknowledged
  • Voice Mail
Element ID: AlertExtension.DeviceGroup.Telephony.DeliveryType.Custom.CallOption.RequirePIN
Values:
  • On
  • Empty
Element ID: AlertExtension.DeviceGroup.Telephony.DeliveryType.Custom.CallOption.validateRecipients
Values:
  • On
  • Empty
Element ID: AlertExtension.DeviceGroup.Telephony.DeliveryType.Custom.CallOption.ReplayMessage
Values:
  • On
  • Empty
Element ID: AlertExtension.DeviceGroup.Telephony.DeliveryType.Custom.CallOption.LeaveMessage
  • On
  • Empty
Element ID: AlertExtension.DeviceGroup.Telephony.DeliveryType.Custom.CallOption.LeaveCallback
Values:
  • On
  • Empty
ExtensionId: 1002, CommonName: GV-EXTENSIONS
Element ID: AlertExtension.DeviceGroup.LandMobileRadio.ContentSource
Values:
  • TextToSpeech
  • Audio
  • Key
Element ID: AlertExtension.DeviceGroup.LandMobileRadio.ContentSource.Audio.AudioID
Values (Depends on ContentSource):
  • TextToSpeech: empty
  • Audio: the full url to csi/getAudio.asp?id=audio Id
Element ID: AlertExtension.DeviceGroup.GiantVoice.ContentSource.Key.KeyID
Values:
  • Numeric (predefined GV Key Id)
  • Empty
Element ID: AlertExtension.DeviceGroup.LandMobileRadio.ContentSource.TextToSpeech.TTSSource
Values:
  • Full
  • Header
  • Body
  • Custom
Element ID: AlertExtension.DeviceGroup.LandMobileRadio.ContentSource.TextToSpeech.TTSSource.CustomText.Value
Values:
  • Unstructured text
ExtensionId: 1003, CommonName: LMR-EXTENSIONS
Element ID: AlertExtension.DeviceGroup.LandMobileRadio.ContentSource
Values:
  • TextToSpeech
  • Audio
  • Key
Element ID: AlertExtension.DeviceGroup.LandMobileRadio.ContentSource.Audio.AudioID
Valued (depends on ContentSouce):
  • TextToSpeech: empty
  • Audio: the full url to csi/getAudio.asp?id=audio Id
Element ID: AlertExtension.DeviceGroup.LandMobileRadio.ContentSource.TextToSpeech.TTSSource
Values:
  • Full
  • Header
  • Body
  • Custom
Element ID: AlertExtension.DeviceGroup.LandMobileRadio.ContentSource. TextToSpeech. TTSSource.Custom.Value
Valuees:
  • Unstructured text
ExtensionId: 1004, CommonName: CISCO-UAP-EXTENSIONS
Element ID: AlertExtension.DeviceGroup.UCM.Audio.Source
Values:
  • None
  • HeaderBody
  • Header
  • Body
  • Custom
Element ID: AlertExtension.DeviceGroup.UCM.Audio.Source.Custom.Value
Values:
  • unstructured text, minimum: 10 characters, maximum: 3000 characters
Element ID: AlertExtension.DeviceGroup.UCM.Audio.RepeatAudio
Values:
  • on
  • empty
Element ID: AlertExtension.DeviceGroup.UCM.Audio.RepeatAudio.RepeatAudioValue
Values: Numeric (Default =3)
Element ID: AlertExtension.DeviceGroup.UCM.Ringtone.Source
Values:
  • None
  • empty (use .Custom.File)
Element ID: AlertExtension.DeviceGroup.UCM.Ringtone.Source.Custom.File
Values: —
Element ID: AlertExtension.DeviceGroup.UCM.Visual.DisplayImage
Values:
  • Image
  • Camera
  • CustomURL
Element ID: AlertExtension.DeviceGroup.UCM.Visual.DisplayImage.Image.File
Values: —
Element ID:  AlertExtension.DeviceGroup.UCM.Visual.DisplayImage.CustomURL.Path
Values: —
ExtensionId: 1010, CommonName: EMAIL-EXTENSIONS
Element ID: AlertExtension.DeviceGroup.Template.TemplateType
Values:
  • Custom
    —The Custom delivery template
  • Default: Uses the Other default email template.
Element ID: AlertExtension.DeviceGroup.Template.TemplateType.Custom.Id
Values:
  • Delivery template ID is required.
  • When the TemplateType is Default, specify ?
  • When TemplateType is Custom, enter the templateID of your choice.
Element ID: AlertExtension.DeviceGroup.EMail.Source
Values:
  • HeaderBody
    —Use the alert text.
  • Custom
    —Use custom text.
Element ID: AlertExtension.DeviceGroup.EMail.Source.Custom.Title
Values: Custom title text just for email.
Element ID: AlertExtension.DeviceGroup.EMail.Source.Custom.Body
Values: Custom title text just for email.
ExtensionId: 1028, CommonName: SMS-EXTENSIONS
Element ID: AlertExtension.DeviceGroup.ShortMessageService.Source
Values:
  • Header
  • Body
  • HeaderBody
    (Default)
  • Custom
Element ID: AlertExtension.DeviceGroup.ShortMessageService.Source.Custom.Value
Values: Unstructured text, minimum 10 characters, maximum 3000 characters.
ExtensionId: 1029, CommonName: SMTP-EXTENSIONS
Element ID: AlertExtension.DeviceGroup.Email.Source
Values: Custom
Element ID: AlertExtension.DeviceGroup.Email.Source.Custom.Title
Values: Unstructured text, minimum 10 characters, maximum 3000 characters.
Element ID: AlertExtension.DeviceGroup.EMail.Source.Custom.Body
Values: Unstructured text, minimum 10 characters, maximum 3000 characters.
Publish alert response
The response format is defined in the SDK Envelope Response section of this guide. The response payload will also contain the Alert ID for an alert created within the BlackBerry AtHoc system, in the following format: 
<responsePayload>
<alert>
<id>1036472</id>
<auid>8660A541-D666-4F7D-BFA7-6A1E410BF5A8</auid>
</alert>
</responsePayload>
The specific error and warning codes are listed in the following tables.
Error Code
Message
Description
1000
Missing Infocasting XML
Payload request infocasting action is missing.
1001
ID missing in Infocasting node
The ID in the Infocasting node or the common alert template name has not been provided.
1002
This service is not slotted in the button.
Service should be slotted in the button to be available for publishing.
1003
Unknown Infocasting type
Invalid infocasting type.
1101
Invalid AlertName
AlertName was not found.
1103
Missing AUID
AUID is not available. AUID is necessary for END and UPDATE action.
1104
No Alert Found for AUID
AUID is invalid as no alert exist for the AUID.
1105
Invalid/Unknown Action
Action is not recognized. Valid actions are PUBLISH, UPDATE, and END.
1109
Error creating alert
Alert was not created due to some error. The <moreData> node provides additional explanation.
1111
Invalid AlertScenarioName. Could not resolve into Scenario ID
The alert template was not found for the specified organization.
1112
Missing AlertScenarioName
The alert template was not found as part of the payload.
1113
Group Attribute defined incorrectly
The attribute “isBlocked” is not defined correctly for target groups of the alert.
1114
isBlocked attribute has wrong value
The group attribute “isBlocked” can only have “Y” or “N”.
1201
Invalid ServiceId
Service ID passed in the id attribute is not valid.
1202
Invalid FeedName
Feed Name passed in the id attribute is not valid.
1203
Web Listener is not enabled for this feed
Web Listener needs to be enabled for a feed to allow it be published using SDK. Value is controlled from the management system.
1204
Failed to Update Raw Content
Raw Content could not be updated for managed feed.
1205
Start Date occurs in the past.
The start date specified occurs in the past.
1206
Live Date occurs before Start Date.
Live date cannot occur before the alert publish date.
1207
Expiration Date occurs before Start Date.
Expiration date cannot occur before the alert publish date.
1208
Expiration Date occurs before Live Date.
Expiration date cannot occur before the Live date.
1209
No Service Information found
No Service Information was found for the given ID.
2301
Failed to Create Personal Alert
Personal alert was note created. The <moreData> node provides additional explanation.
2302
No User Information found for Personal Alert
The Link ID did not return any information about the owner of the service.
2303
The user of this Personal Service does not belong to the calling Provider
The organization making the SDK call does not have ownership over the service it is trying to publish.
2401
Failed to Update Gdum Content
Failed to update Raw Content for personal feed. The <moreData> node provides additional explanation.
2402
Failed to Generate Result
Failed to process the raw content. The <moreData> node provides additional explanation.
Warning Code
Message
Description
2101
Update failed
Update fails if Alert has already ended or expired. The <moreData> node provides additional explanation.
2201
Content is empty
Incoming Content was empty and the feed has been updated with it.
2202
Failed to Update Raw Content for User
Raw Content was not updated for a user for personalized managed feeds. The <moreData> node provides additional explanation.
2203
Could not resolve MID
The MID could not be resolved into a userId for personalized managed feeds.
2204
Raw Content not updated as it was same as before
Raw Content is only updated if there is a change from the previous update.
2205
Long Data
Data too long, truncation will be performed.