/v1/activation-groups

Attributes

Name Type Required Doc
id
time-uuid
false Id of the activation group
name
string
true Name of activation group
endpointIds
array[time-uuid]
true Endpoints responsible for activating devices. In priority order.
priority
integer
true Devices are only allowed in one Activation Group. Lower numeral priorities are higher priority.
filterType
option: OR, AND, ACCEPT, REJECT, LOGICAL_EXPRESSION
false Type of the activation group
logicalExpression
string
false Logical Expression when using LOGICAL_EXPRESSION filterType
additionIds
array[string]
false Device Additions
exclusionIds
array[string]
false Exclusions
filters
json
false Filter of the device group
Get one resource by id or an array of resources by filtering attribute with GET.
GET /resource

GET

                  
Create a new resource with a POST.
(required)
Copy (required)
(required)
POST /resource
POST

                  
Update a resource with PUT.
(required)
PUT /resource
PUT

                  
Delete a resource with DELETE.
(required)
DELETE /resource
DELETE

                  

/v1/areas-of-interest

Geographic Areas of Interest

Attributes

Name Type Required Doc
id
time-uuid
false TimeUUID identifier of area of interest
name
string
true Area of interest name
geometryType
option: circle
true Geometry of area
geometryValue[type]
string
false The type of geojson
geometryValue[geometry][type]
string
false The type of feature
geometryValue[geometry][coordinates]
array[string]
false The coordinates of the feature
geometryValue[properties][radiusInM]
integer
false The radius in meters
Get one resource by id or an array of resources by filtering attribute with GET.
GET /resource

GET

                  
Create a new resource with a POST.
(required)
(required)
POST /resource
POST

                  
Update a resource with PUT.
(required)
PUT /resource
PUT

                  
Delete a resource with DELETE.
(required)
DELETE /resource
DELETE

                  

/v1/areas-of-interest/:areaOfInterestId/boundary-triggers

Attributes

Name Type Required Doc
id
time-uuid
false ID of the boundary trigger
name
string
true Name of the boundary trigger
action
option: entered, exited, both
true Indicates if a notification should be sent out either when someone has entered or exited an area of interest.
perUserThrottlingInSecs
integer
true The amount of time that must pass before another boundary trigger will fire for that user.
notificationAction
option: send-to-none, send-to-user, send-to-message-template-recipients
true Indicates if a notification should be sent out either when someone has entered or exited an area of interest.
distributionListIds
array[uuid]
false When anyone from these distribution lists crosses an area of interest, trigger this action.
userIds
array[uuid]
false When anyone from these distribution lists crosses an area of interest, trigger this action.
messageTemplateId
time-uuid
false The ID of the message template to use when this trigger is created
subject
string
false The subject override of the message template
body
string
false The body override of the message template
Get one resource by id or an array of resources by filtering attribute with GET.
GET /resource

GET

                  
Create a new resource with a POST.
(required)
(required)
(required)
(required)
(required)
POST /resource
POST

                  
Update a resource with PUT.
(required)
(required)
PUT /resource
PUT

                  
Delete a resource with DELETE.
(required)
(required)
DELETE /resource
DELETE

                  

/v1/areas-of-interest/:areaOfInterestId/boundary-triggers/:boundaryTriggerId/activities

Attributes

Name Type Required Doc
id
time-uuid
false ID of the boundary trigger activity
reason
option: entered, exited
true Indicates why the activity was created. Can be from an enter or exit event.
status
option: success, no-recipients
true Indicates whether the activity was a success
Get one resource by id or an array of resources by filtering attribute with GET.
GET /resource

GET

                  
Create a new resource with a POST.
(required)
(required)
(required)
(required)
POST /resource
POST

                  
Update a resource with PUT.
(required)
(required)
(required)
PUT /resource
PUT

                  
Delete a resource with DELETE.
(required)
(required)
(required)
DELETE /resource
DELETE

                  

/v1/bell-schedules

Bell Schedules

Attributes

Name Type Required Doc
id
time-uuid
false TimeUUID identifier of bell schedule
name
string
true Bell schedule name
numWeeks
integer
true Number of weeks in the ring list pattern
startDate
date
true Start date for the bell schedule
endDate
date
true End date for the bell schedule
description
string
false Bell schedule description
timeZone
option: Africa/Abidjan, Africa/Accra, Africa/Addis_Ababa, Africa/Algiers, Africa/Asmara, Africa/Asmera, Africa/Bamako, Africa/Bangui, Africa/Banjul, Africa/Bissau, Africa/Blantyre, Africa/Brazzaville, Africa/Bujumbura, Africa/Cairo, Africa/Casablanca, Africa/Ceuta, Africa/Conakry, Africa/Dakar, Africa/Dar_es_Salaam, Africa/Djibouti, Africa/Douala, Africa/El_Aaiun, Africa/Freetown, Africa/Gaborone, Africa/Harare, Africa/Johannesburg, Africa/Juba, Africa/Kampala, Africa/Khartoum, Africa/Kigali, Africa/Kinshasa, Africa/Lagos, Africa/Libreville, Africa/Lome, Africa/Luanda, Africa/Lubumbashi, Africa/Lusaka, Africa/Malabo, Africa/Maputo, Africa/Maseru, Africa/Mbabane, Africa/Mogadishu, Africa/Monrovia, Africa/Nairobi, Africa/Ndjamena, Africa/Niamey, Africa/Nouakchott, Africa/Ouagadougou, Africa/Porto-Novo, Africa/Sao_Tome, Africa/Timbuktu, Africa/Tripoli, Africa/Tunis, Africa/Windhoek, America/Adak, America/Anchorage, America/Anguilla, America/Antigua, America/Araguaina, America/Argentina/Buenos_Aires, America/Argentina/Catamarca, America/Argentina/ComodRivadavia, America/Argentina/Cordoba, America/Argentina/Jujuy, America/Argentina/La_Rioja, America/Argentina/Mendoza, America/Argentina/Rio_Gallegos, America/Argentina/Salta, America/Argentina/San_Juan, America/Argentina/San_Luis, America/Argentina/Tucuman, America/Argentina/Ushuaia, America/Aruba, America/Asuncion, America/Atikokan, America/Atka, America/Bahia, America/Bahia_Banderas, America/Barbados, America/Belem, America/Belize, America/Blanc-Sablon, America/Boa_Vista, America/Bogota, America/Boise, America/Buenos_Aires, America/Cambridge_Bay, America/Campo_Grande, America/Cancun, America/Caracas, America/Catamarca, America/Cayenne, America/Cayman, America/Chicago, America/Chihuahua, America/Coral_Harbour, America/Cordoba, America/Costa_Rica, America/Creston, America/Cuiaba, America/Curacao, America/Danmarkshavn, America/Dawson, America/Dawson_Creek, America/Denver, America/Detroit, America/Dominica, America/Edmonton, America/Eirunepe, America/El_Salvador, America/Ensenada, America/Fort_Nelson, America/Fort_Wayne, America/Fortaleza, America/Glace_Bay, America/Godthab, America/Goose_Bay, America/Grand_Turk, America/Grenada, America/Guadeloupe, America/Guatemala, America/Guayaquil, America/Guyana, America/Halifax, America/Havana, America/Hermosillo, America/Indiana/Indianapolis, America/Indiana/Knox, America/Indiana/Marengo, America/Indiana/Petersburg, America/Indiana/Tell_City, America/Indiana/Vevay, America/Indiana/Vincennes, America/Indiana/Winamac, America/Indianapolis, America/Inuvik, America/Iqaluit, America/Jamaica, America/Jujuy, America/Juneau, America/Kentucky/Louisville, America/Kentucky/Monticello, America/Knox_IN, America/Kralendijk, America/La_Paz, America/Lima, America/Los_Angeles, America/Louisville, America/Lower_Princes, America/Maceio, America/Managua, America/Manaus, America/Marigot, America/Martinique, America/Matamoros, America/Mazatlan, America/Mendoza, America/Menominee, America/Merida, America/Metlakatla, America/Mexico_City, America/Miquelon, America/Moncton, America/Monterrey, America/Montevideo, America/Montreal, America/Montserrat, America/Nassau, America/New_York, America/Nipigon, America/Nome, America/Noronha, America/North_Dakota/Beulah, America/North_Dakota/Center, America/North_Dakota/New_Salem, America/Ojinaga, America/Panama, America/Pangnirtung, America/Paramaribo, America/Phoenix, America/Port-au-Prince, America/Port_of_Spain, America/Porto_Acre, America/Porto_Velho, America/Puerto_Rico, America/Punta_Arenas, America/Rainy_River, America/Rankin_Inlet, America/Recife, America/Regina, America/Resolute, America/Rio_Branco, America/Rosario, America/Santa_Isabel, America/Santarem, America/Santiago, America/Santo_Domingo, America/Sao_Paulo, America/Scoresbysund, America/Shiprock, America/Sitka, America/St_Barthelemy, America/St_Johns, America/St_Kitts, America/St_Lucia, America/St_Thomas, America/St_Vincent, America/Swift_Current, America/Tegucigalpa, America/Thule, America/Thunder_Bay, America/Tijuana, America/Toronto, America/Tortola, America/Vancouver, America/Virgin, America/Whitehorse, America/Winnipeg, America/Yakutat, America/Yellowknife, Antarctica/Casey, Antarctica/Davis, Antarctica/DumontDUrville, Antarctica/Macquarie, Antarctica/Mawson, Antarctica/McMurdo, Antarctica/Palmer, Antarctica/Rothera, Antarctica/South_Pole, Antarctica/Syowa, Antarctica/Troll, Antarctica/Vostok, Arctic/Longyearbyen, Asia/Aden, Asia/Almaty, Asia/Amman, Asia/Anadyr, Asia/Aqtau, Asia/Aqtobe, Asia/Ashgabat, Asia/Ashkhabad, Asia/Atyrau, Asia/Baghdad, Asia/Bahrain, Asia/Baku, Asia/Bangkok, Asia/Barnaul, Asia/Beirut, Asia/Bishkek, Asia/Brunei, Asia/Calcutta, Asia/Chita, Asia/Choibalsan, Asia/Chongqing, Asia/Chungking, Asia/Colombo, Asia/Dacca, Asia/Damascus, Asia/Dhaka, Asia/Dili, Asia/Dubai, Asia/Dushanbe, Asia/Famagusta, Asia/Gaza, Asia/Harbin, Asia/Hebron, Asia/Ho_Chi_Minh, Asia/Hong_Kong, Asia/Hovd, Asia/Irkutsk, Asia/Istanbul, Asia/Jakarta, Asia/Jayapura, Asia/Jerusalem, Asia/Kabul, Asia/Kamchatka, Asia/Karachi, Asia/Kashgar, Asia/Kathmandu, Asia/Katmandu, Asia/Khandyga, Asia/Kolkata, Asia/Krasnoyarsk, Asia/Kuala_Lumpur, Asia/Kuching, Asia/Kuwait, Asia/Macao, Asia/Macau, Asia/Magadan, Asia/Makassar, Asia/Manila, Asia/Muscat, Asia/Nicosia, Asia/Novokuznetsk, Asia/Novosibirsk, Asia/Omsk, Asia/Oral, Asia/Phnom_Penh, Asia/Pontianak, Asia/Pyongyang, Asia/Qatar, Asia/Qyzylorda, Asia/Rangoon, Asia/Riyadh, Asia/Saigon, Asia/Sakhalin, Asia/Samarkand, Asia/Seoul, Asia/Shanghai, Asia/Singapore, Asia/Srednekolymsk, Asia/Taipei, Asia/Tashkent, Asia/Tbilisi, Asia/Tehran, Asia/Tel_Aviv, Asia/Thimbu, Asia/Thimphu, Asia/Tokyo, Asia/Tomsk, Asia/Ujung_Pandang, Asia/Ulaanbaatar, Asia/Ulan_Bator, Asia/Urumqi, Asia/Ust-Nera, Asia/Vientiane, Asia/Vladivostok, Asia/Yakutsk, Asia/Yangon, Asia/Yekaterinburg, Asia/Yerevan, Atlantic/Azores, Atlantic/Bermuda, Atlantic/Canary, Atlantic/Cape_Verde, Atlantic/Faeroe, Atlantic/Faroe, Atlantic/Jan_Mayen, Atlantic/Madeira, Atlantic/Reykjavik, Atlantic/South_Georgia, Atlantic/St_Helena, Atlantic/Stanley, Australia/ACT, Australia/Adelaide, Australia/Brisbane, Australia/Broken_Hill, Australia/Canberra, Australia/Currie, Australia/Darwin, Australia/Eucla, Australia/Hobart, Australia/LHI, Australia/Lindeman, Australia/Lord_Howe, Australia/Melbourne, Australia/NSW, Australia/North, Australia/Perth, Australia/Queensland, Australia/South, Australia/Sydney, Australia/Tasmania, Australia/Victoria, Australia/West, Australia/Yancowinna, Brazil/Acre, Brazil/DeNoronha, Brazil/East, Brazil/West, CET, CST6CDT, Canada/Atlantic, Canada/Central, Canada/Eastern, Canada/Mountain, Canada/Newfoundland, Canada/Pacific, Canada/Saskatchewan, Canada/Yukon, Chile/Continental, Chile/EasterIsland, Cuba, EET, EST5EDT, Egypt, Eire, Etc/GMT, Etc/GMT+0, Etc/GMT+1, Etc/GMT+10, Etc/GMT+11, Etc/GMT+12, Etc/GMT+2, Etc/GMT+3, Etc/GMT+4, Etc/GMT+5, Etc/GMT+6, Etc/GMT+7, Etc/GMT+8, Etc/GMT+9, Etc/GMT-0, Etc/GMT-1, Etc/GMT-10, Etc/GMT-11, Etc/GMT-12, Etc/GMT-13, Etc/GMT-14, Etc/GMT-2, Etc/GMT-3, Etc/GMT-4, Etc/GMT-5, Etc/GMT-6, Etc/GMT-7, Etc/GMT-8, Etc/GMT-9, Etc/GMT0, Etc/Greenwich, Etc/UCT, Etc/UTC, Etc/Universal, Etc/Zulu, Europe/Amsterdam, Europe/Andorra, Europe/Astrakhan, Europe/Athens, Europe/Belfast, Europe/Belgrade, Europe/Berlin, Europe/Bratislava, Europe/Brussels, Europe/Bucharest, Europe/Budapest, Europe/Busingen, Europe/Chisinau, Europe/Copenhagen, Europe/Dublin, Europe/Gibraltar, Europe/Guernsey, Europe/Helsinki, Europe/Isle_of_Man, Europe/Istanbul, Europe/Jersey, Europe/Kaliningrad, Europe/Kiev, Europe/Kirov, Europe/Lisbon, Europe/Ljubljana, Europe/London, Europe/Luxembourg, Europe/Madrid, Europe/Malta, Europe/Mariehamn, Europe/Minsk, Europe/Monaco, Europe/Moscow, Europe/Nicosia, Europe/Oslo, Europe/Paris, Europe/Podgorica, Europe/Prague, Europe/Riga, Europe/Rome, Europe/Samara, Europe/San_Marino, Europe/Sarajevo, Europe/Saratov, Europe/Simferopol, Europe/Skopje, Europe/Sofia, Europe/Stockholm, Europe/Tallinn, Europe/Tirane, Europe/Tiraspol, Europe/Ulyanovsk, Europe/Uzhgorod, Europe/Vaduz, Europe/Vatican, Europe/Vienna, Europe/Vilnius, Europe/Volgograd, Europe/Warsaw, Europe/Zagreb, Europe/Zaporozhye, Europe/Zurich, GB, GB-Eire, GMT, GMT0, Greenwich, Hongkong, Iceland, Indian/Antananarivo, Indian/Chagos, Indian/Christmas, Indian/Cocos, Indian/Comoro, Indian/Kerguelen, Indian/Mahe, Indian/Maldives, Indian/Mauritius, Indian/Mayotte, Indian/Reunion, Iran, Israel, Jamaica, Japan, Kwajalein, Libya, MET, MST7MDT, Mexico/BajaNorte, Mexico/BajaSur, Mexico/General, NZ, NZ-CHAT, Navajo, PRC, PST8PDT, Pacific/Apia, Pacific/Auckland, Pacific/Bougainville, Pacific/Chatham, Pacific/Chuuk, Pacific/Easter, Pacific/Efate, Pacific/Enderbury, Pacific/Fakaofo, Pacific/Fiji, Pacific/Funafuti, Pacific/Galapagos, Pacific/Gambier, Pacific/Guadalcanal, Pacific/Guam, Pacific/Honolulu, Pacific/Johnston, Pacific/Kiritimati, Pacific/Kosrae, Pacific/Kwajalein, Pacific/Majuro, Pacific/Marquesas, Pacific/Midway, Pacific/Nauru, Pacific/Niue, Pacific/Norfolk, Pacific/Noumea, Pacific/Pago_Pago, Pacific/Palau, Pacific/Pitcairn, Pacific/Pohnpei, Pacific/Ponape, Pacific/Port_Moresby, Pacific/Rarotonga, Pacific/Saipan, Pacific/Samoa, Pacific/Tahiti, Pacific/Tarawa, Pacific/Tongatapu, Pacific/Truk, Pacific/Wake, Pacific/Wallis, Pacific/Yap, Poland, Portugal, ROK, Singapore, SystemV/AST4, SystemV/AST4ADT, SystemV/CST6, SystemV/CST6CDT, SystemV/EST5, SystemV/EST5EDT, SystemV/HST10, SystemV/MST7, SystemV/MST7MDT, SystemV/PST8, SystemV/PST8PDT, SystemV/YST9, SystemV/YST9YDT, Turkey, UCT, US/Alaska, US/Aleutian, US/Arizona, US/Central, US/East-Indiana, US/Eastern, US/Hawaii, US/Indiana-Starke, US/Michigan, US/Mountain, US/Pacific, US/Pacific-New, US/Samoa, UTC, Universal, W-SU, WET, Zulu, EST, HST, MST, ACT, AET, AGT, ART, AST, BET, BST, CAT, CNT, CST, CTT, EAT, ECT, IET, IST, JST, MIT, NET, NST, PLT, PNT, PRT, PST, SST, VST
false The time zone of the ring list expression.
bellScheduleEntries
array[json]
false Bell Schedule Entries
bellScheduleExceptions
array[json]
false Bell Schedule Exceptions
Get one resource by id or an array of resources by filtering attribute with GET.
GET /resource

GET

                  
Create a new resource with a POST.
(required)
(required)
(required)
(required)
POST /resource
POST

                  
Update a resource with PUT.
(required)
PUT /resource
PUT

                  
Delete a resource with DELETE.
(required)
DELETE /resource
DELETE

                  

/v1/collaboration-groups

Collaboration Group Definition

Attributes

Name Type Required Doc
id
time-uuid
false ID of the collaboration group
name
string
true Name of the collaboration group
type
string
true The type of collaboration group that will be initiated; must match the device-type value of an existing collaboration extension
distributionListIds
array[uuid]
false Distribution lists to join in the collaboration group
userIds
array[uuid]
false Users to join in the collaboration group
properties
json
false The collaboration group properties specific to the collaboration group type
Get one resource by id or an array of resources by filtering attribute with GET.
GET /resource

GET

                  
Create a new resource with a POST.
(required)
(required)
POST /resource
POST

                  
Update a resource with PUT.
(required)
PUT /resource
PUT

                  
Delete a resource with DELETE.
(required)
DELETE /resource
DELETE

                  

/v1/confirmation-requests

Confirmation Request Definition

Attributes

Name Type Required Doc
id
time-uuid
false ID of the Confirmation Request
name
string
true Name of the Confirmation Request
options
array[string]
true Confirmation Response options
expirationPeriod
integer
false Number of seconds to accept responses
initiateTrackingOptions
array[boolean]
false Array of values to indicate which 'options' responses should trigger a tracking event.
Get one resource by id or an array of resources by filtering attribute with GET.
GET /resource

GET

                  
Create a new resource with a POST.
(required)
Copy (required)
POST /resource
POST

                  
Update a resource with PUT.
(required)
PUT /resource
PUT

                  
Delete a resource with DELETE.
(required)
DELETE /resource
DELETE

                  

/v1/confirmation-requests/:confirmationRequestId/escalation-rules

Attributes

Name Type Required Doc
id
time-uuid
false ID of the escalation rule
delay
integer
true Seconds after notification was sent
optionLabel
string
true Label of the option value that will be compared to the comparison value
comparison
option: GT, LT, EQ, NE
true How the option response count is compared to the comparison value
comparisonValue
integer
true The value the test-variable is compared to
subject
string
true The subject of the escalation notification
distributionListIds
array[uuid]
false The distribution list recipients of the escalation notification
deviceGroupIds
array[uuid]
false The device group recipients of the escalation notification
areaOfInterestIds
array[uuid]
false The area of interest recipients of the escalation notification
userIds
array[uuid]
false The user recipients of the escalation notification
collaborationGroupIds
array[uuid]
false The collaboration group recipients of the escalation notification
body
string
false The body of the escalation notification
image
file
false The image of the escalation
audio
file
false The audio of the escalation
Get one resource by id or an array of resources by filtering attribute with GET.
GET /resource

GET

                  
Create a new resource with a POST.
(required)
(required)
(required)
(required)
(required)
(required)
POST /resource
POST

                  
Update a resource with PUT.
(required)
(required)
PUT /resource
PUT

                  
Delete a resource with DELETE.
(required)
(required)
DELETE /resource
DELETE

                  

/v1/device-groups

Attributes

Name Type Required Doc
id
time-uuid
false Id of the device group
name
string
true Name of device group
filterType
option: OR, AND, ACCEPT, REJECT, LOGICAL_EXPRESSION
false Type of the device group
logicalExpression
string
false Logical Expression when using LOGICAL_EXPRESSION filterType
baseDeviceGroupIds
array[time-uuid]
false Device Groups to base this device group on
additionIds
array[string]
false Device Additions
exclusionIds
array[string]
false Exclusions
filters
json
false Filter of the device group
Get one resource by id or an array of resources by filtering attribute with GET.
GET /resource

GET

                  
Create a new resource with a POST.
(required)
POST /resource
POST

                  
Update a resource with PUT.
(required)
PUT /resource
PUT

                  
Delete a resource with DELETE.
(required)
DELETE /resource
DELETE

                  

/v1/devices

Endpoint for querying devices with Filters

Attributes

Name Type Required Doc
name
string
false Name of device
deviceGroupId
time-uuid
false Device group to filter devices with
deviceGroup
json
false Ad-hoc device group for filtering devices
types
json
false Device types by which to partition
attributes
json
false Device Attributes
Get one resource by id or an array of resources by filtering attribute with GET.
GET /resource

GET

                  
Create a new resource with a POST.
POST /resource
POST

                  
Update a resource with PUT.
PUT /resource
PUT

                  
Delete a resource with DELETE.
(required)
DELETE /resource
DELETE

                  

/v1/distribution-lists

The Distribution Lists

Attributes

Name Type Required Doc
id
time-uuid
false Distribution List ID
name
string
true Distribution List name
campaign[welcomeMessage]
string
false Campaign welcome message
campaign[inactiveMessage]
string
false Campaign inactive message
campaign[url]
string
false Campaign's enrollment url
campaign[subscribeTag]
string
false Campaign's subscribe tag
campaign[defaultNotificationDays]
integer
false Campaign's default notification days
campaign[enrollmentEndDate]
timestamp
false Campaign's enrollment end date
Get one resource by id or an array of resources by filtering attribute with GET.
GET /resource

GET

                  
Create a new resource with a POST.
(required)
POST /resource
POST

                  
Update a resource with PUT.
(required)
PUT /resource
PUT

                  
Delete a resource with DELETE.
(required)
DELETE /resource
DELETE

                  

/v1/distribution-lists/:distributionListId/domains

Domains to which the Distribution List belongs

Attributes

Name Type Required Doc
id
time-uuid
false Domain ID
demote
boolean
false Required to be true when adding a domain that will replace a parent
promote
boolean
false Required to be true when adding a domain that will replace one or more descendants
name
string
false Filter list results by matching on name
Get one resource by id or an array of resources by filtering attribute with GET.
GET /resource

GET

                  
Create a new resource with a POST.
(required)
POST /resource
POST

                  
Update a resource with PUT.
(required)
(required)
PUT /resource
PUT

                  
Delete a resource with DELETE.
(required)
(required)
DELETE /resource
DELETE

                  

/v1/distribution-lists/:distributionListId/user-subscriptions

Attributes

Name Type Required Doc
id
time-uuid
false User Subscription ID
userId
time-uuid
true User ID
subscriptionEndDate
timestamp
false What time the subscription ends
Get one resource by id or an array of resources by filtering attribute with GET.
GET /resource

GET

                  
Create a new resource with a POST.
(required)
(required)
POST /resource
POST

                  
Update a resource with PUT.
(required)
(required)
PUT /resource
PUT

                  
Delete a resource with DELETE.
(required)
(required)
DELETE /resource
DELETE

                  

/v1/domains

Provides support for hierarchical resource administration.

Attributes

Name Type Required Doc
id
time-uuid
false ID of the Domain
name
string
true Name of the Domain
parentId
time-uuid
false ID of parent Domain, set on creation only
path
string
false Internal path of the Domain, read-only
namePath
string
false Human-readable path of the Domain, read-only
Get one resource by id or an array of resources by filtering attribute with GET.
GET /resource

GET

                  
Create a new resource with a POST.
(required)
POST /resource
POST

                  
Update a resource with PUT.
(required)
PUT /resource
PUT

                  
Delete a resource with DELETE.
(required)
DELETE /resource
DELETE

                  

/v1/domains/:domainId/distribution-lists

The Distribution Lists which are members of the Domain

Attributes

Name Type Required Doc
id
time-uuid
false Distribution List ID
demote
boolean
false Required to be true when adding a domain that will replace a parent
promote
boolean
false Required to be true when adding a domain that will replace one or more descendants
name
string
false Filter list results by matching on name
Get one resource by id or an array of resources by filtering attribute with GET.
GET /resource

GET

                  
Create a new resource with a POST.
(required)
POST /resource
POST

                  
Update a resource with PUT.
(required)
(required)
PUT /resource
PUT

                  
Delete a resource with DELETE.
(required)
(required)
DELETE /resource
DELETE

                  

/v1/domains/:domainId/load-definitions

The User Loaders which are members of the Domain

Attributes

Name Type Required Doc
id
time-uuid
false User Loader ID
demote
boolean
false Required to be true when adding a domain that will replace a parent
promote
boolean
false Required to be true when adding a domain that will replace one or more descendants
name
string
false Filter list results by matching on name
Get one resource by id or an array of resources by filtering attribute with GET.
GET /resource

GET

                  
Create a new resource with a POST.
(required)
POST /resource
POST

                  
Update a resource with PUT.
(required)
(required)
PUT /resource
PUT

                  
Delete a resource with DELETE.
(required)
(required)
DELETE /resource
DELETE

                  

/v1/domains/:domainId/scenarios

The Scenarios which are members of the Domain

Attributes

Name Type Required Doc
id
time-uuid
false Scenario ID
demote
boolean
false Required to be true when adding a domain that will replace a parent
promote
boolean
false Required to be true when adding a domain that will replace one or more descendants
name
string
false Filter list results by matching on name
Get one resource by id or an array of resources by filtering attribute with GET.
GET /resource

GET

                  
Create a new resource with a POST.
(required)
POST /resource
POST

                  
Update a resource with PUT.
(required)
(required)
PUT /resource
PUT

                  
Delete a resource with DELETE.
(required)
(required)
DELETE /resource
DELETE

                  

/v1/domains/:domainId/security-group-permissions

The open-ended Security Group permissions which are constrained to affect this Domain and its descendants

Attributes

Name Type Required Doc
id
time-uuid
false ID of the permission
verb
string
false Verb of the permission
spec
string
false Resource spec of the permission
domainId
time-uuid
false Domain scope of the permission
securityGroupId
time-uuid
false Security Group to which this permission applies
Get one resource by id or an array of resources by filtering attribute with GET.
GET /resource

GET

                  
Create a new resource with a POST.
(required)
POST /resource
POST

                  
Update a resource with PUT.
(required)
(required)
PUT /resource
PUT

                  
Delete a resource with DELETE.
(required)
(required)
DELETE /resource
DELETE

                  

/v1/domains/:domainId/security-groups

The Security Groups which are members of the Domain

Attributes

Name Type Required Doc
id
time-uuid
false Security Group ID
demote
boolean
false Required to be true when adding a domain that will replace a parent
promote
boolean
false Required to be true when adding a domain that will replace one or more descendants
name
string
false Filter list results by matching on name
Get one resource by id or an array of resources by filtering attribute with GET.
GET /resource

GET

                  
Create a new resource with a POST.
(required)
POST /resource
POST

                  
Update a resource with PUT.
(required)
(required)
PUT /resource
PUT

                  
Delete a resource with DELETE.
(required)
(required)
DELETE /resource
DELETE

                  

/v1/domains/:domainId/site-roles

The Site Roles which are members of the Domain

Attributes

Name Type Required Doc
id
time-uuid
false Site Role ID
demote
boolean
false Required to be true when adding a domain that will replace a parent
promote
boolean
false Required to be true when adding a domain that will replace one or more descendants
name
string
false Filter list results by matching on name
Get one resource by id or an array of resources by filtering attribute with GET.
GET /resource

GET

                  
Create a new resource with a POST.
(required)
POST /resource
POST

                  
Update a resource with PUT.
(required)
(required)
PUT /resource
PUT

                  
Delete a resource with DELETE.
(required)
(required)
DELETE /resource
DELETE

                  

/v1/domains/:domainId/sites

The Sites which are members of the Domain

Attributes

Name Type Required Doc
id
time-uuid
false Site ID
demote
boolean
false Required to be true when adding a domain that will replace a parent
promote
boolean
false Required to be true when adding a domain that will replace one or more descendants
name
string
false Filter list results by matching on name
Get one resource by id or an array of resources by filtering attribute with GET.
GET /resource

GET

                  
Create a new resource with a POST.
(required)
POST /resource
POST

                  
Update a resource with PUT.
(required)
(required)
PUT /resource
PUT

                  
Delete a resource with DELETE.
(required)
(required)
DELETE /resource
DELETE

                  

/v1/domains/:domainId/user-permissions

The open-ended User permissions which are constrained to affect this Domain and its descendants

Attributes

Name Type Required Doc
id
time-uuid
false ID of the permission
verb
string
false Verb of the permission
spec
string
false Resource spec of the permission
domainId
time-uuid
false Domain scope of the permission
userId
time-uuid
false User to which this permission applies
Get one resource by id or an array of resources by filtering attribute with GET.
GET /resource

GET

                  
Create a new resource with a POST.
(required)
POST /resource
POST

                  
Update a resource with PUT.
(required)
(required)
PUT /resource
PUT

                  
Delete a resource with DELETE.
(required)
(required)
DELETE /resource
DELETE

                  

/v1/domains/:domainId/users

The Users which are members of the Domain

Attributes

Name Type Required Doc
id
time-uuid
false User ID
demote
boolean
false Required to be true when adding a domain that will replace a parent
promote
boolean
false Required to be true when adding a domain that will replace one or more descendants
name
string
false Filter list results by matching on name
Get one resource by id or an array of resources by filtering attribute with GET.
GET /resource

GET

                  
Create a new resource with a POST.
(required)
POST /resource
POST

                  
Update a resource with PUT.
(required)
(required)
PUT /resource
PUT

                  
Delete a resource with DELETE.
(required)
(required)
DELETE /resource
DELETE

                  

/v1/extensions

InformaCast Mobile Extensions

Attributes

Name Type Required Doc
id
time-uuid
false ID of the extension
name
string
true Name of the extension
type
option: device, device-filter, endpoint-proxy, collaboration, report
false Type of extension
deviceType
string
false Device type that this extension pushes to, for extensions whose type=device, or collaboration group type it works with when type=collaboration
config
json
false Configuration object that is validated by extension
globalDisabled
boolean
false True if the extension is disabled. This overrides the disabled property when set to true.
disabled
boolean
false True if the extension is disabled
deviceLimit
integer
false Number of devices allowed per user, for extensions whose type=device
failureCode
string
false Notification activity type created when the extension cannot be reached while sending
Get one resource by id or an array of resources by filtering attribute with GET.
GET /resource

GET

                  
Create a new resource with a POST.
POST /resource
POST

                  
Update a resource with PUT.
(required)
PUT /resource
PUT

                  
Delete a resource with DELETE.
(required)
DELETE /resource
DELETE

                  

/v1/extensions/:extensionId/attachments

Binary attachments for a given extension

Attributes

Name Type Required Doc
id
time-uuid
false ID of attachment
file
file
false Binary attachment
Get one resource by id or an array of resources by filtering attribute with GET.
GET /resource

GET

                  
Create a new resource with a POST.
(required)
POST /resource
POST

                  
Update a resource with PUT.
(required)
(required)
PUT /resource
PUT

                  
Delete a resource with DELETE.
(required)
(required)
DELETE /resource
DELETE

                  

/v1/extensions/:extensionId/endpoints

Endpoints this extension will proxy

Attributes

Name Type Required Doc
id
time-uuid
false ID of endpoint
name
string
false Name of endpoint
devices
json
false Device object that can store any arbitrary data
config
json
false Configuration object that is validated by extension
Get one resource by id or an array of resources by filtering attribute with GET.
GET /resource

GET

                  
Create a new resource with a POST.
(required)
POST /resource
POST

                  
Update a resource with PUT.
(required)
(required)
PUT /resource
PUT

                  
Delete a resource with DELETE.
(required)
(required)
DELETE /resource
DELETE

                  

/v1/extensions/:extensionId/endpoints/:endpointId/activities

Attributes

Name Type Required Doc
id
time-uuid
false ID of the extension endpoint activity
type
option: recipient-group-delete, recipient-group-create, recipient-group-update, recipient-group-sync, recipient-group-dependency-sync, message-delete, message-skipped, message-create, message-update, message-sync, message-dependency-sync, scheduled-broadcast-create, scheduled-broadcast-update, scheduled-broadcast-delete, scheduled-broadcast-sync, scheduled-broadcast-skipped, broadcast-pending, broadcast-complete, broadcast-failed, activation-group-sync, phone-cache-distribute, phone-auth-url-update, phone-cache-rebuild, phone-reset-pending, fusion-server-broadcast-config-change, full-resync, upgrade, upgrade-all, syncer-startup, log-message, phone-cache-update, phone-cache-partial-update, device-sync, restart, backup, firedoor-event
true Type of activity
value
json
false The extension activity value
referenceType
option: message-template, distribution-list, scheduled-notifications
false Type for IC Mobile object this activity relates to.
referenceId
time-uuid
false ID of the IC Mobile object this activity relates to.
state
option: pending, fail, success
false State of replication operation of this activity
severity
option: debug, info, warn, error
false Severity level of this activity.
Get one resource by id or an array of resources by filtering attribute with GET.
GET /resource

GET

                  
Create a new resource with a POST.
(required)
(required)
(required)
POST /resource
POST

                  
Update a resource with PUT.
(required)
(required)
(required)
PUT /resource
PUT

                  
Delete a resource with DELETE.
(required)
(required)
(required)
DELETE /resource
DELETE

                  

/v1/extensions/:extensionId/endpoints/:endpointId/devices

Endpoint for updating/querying devices with filters

Attributes

Name Type Required Doc
id
time-uuid
false Id of the device
endpointId
time-uuid
true The endpoint the device belongs to
extensionId
time-uuid
true The extension the device belongs to
deviceIdentifier
string
true The device's unique identifier
description
string
true The description of the device
type
option: phones, speakers, plugins, idns
true The type of the device. Can be one of phones, speakers, plugins, or idns.
attributes
json
false Device Attributes
defunct
boolean
false Whether the device is currently defunct
deviceGroupId
time-uuid
false Device group to filter devices with
deviceGroup
json
false Ad-hoc device group for filtering devices
Get one resource by id or an array of resources by filtering attribute with GET.
GET /resource

GET

                  
Create a new resource with a POST.
(required)
(required)
(required)
(required)
(required)
(required)
(required)
POST /resource
POST

                  
Update a resource with PUT.
(required)
(required)
(required)
PUT /resource
PUT

                  
Delete a resource with DELETE.
(required)
(required)
(required)
DELETE /resource
DELETE

                  

/v1/extensions/:extensionId/endpoints/:endpointId/failover-status

Attributes

Name Type Required Doc
Get one resource by id or an array of resources by filtering attribute with GET.
GET /resource

GET

                  
Create a new resource with a POST.
(required)
(required)
POST /resource
POST

                  
Update a resource with PUT.
(required)
(required)
PUT /resource
PUT

                  
Delete a resource with DELETE.
(required)
(required)
(required)
DELETE /resource
DELETE

                  

/v1/extensions/:extensionId/endpoints/:endpointId/mappings

Attributes

Name Type Required Doc
id
time-uuid
false ID of the extension endpoint mapping
resourceType
string
false The type of the resource
resourceId
time-uuid
false The ID of the mobile resource
icopId
bigint
false The ID of the ICOP resource
updatedAt
timestamp
false When the last time the mapping was updated
dependencies
json
false The resource's dependencies
endpointId
time-uuid
false The ID of the endpoint
extensionId
time-uuid
false The ID of the extension
Get one resource by id or an array of resources by filtering attribute with GET.
GET /resource

GET

                  
Create a new resource with a POST.
(required)
(required)
POST /resource
POST

                  
Update a resource with PUT.
(required)
(required)
(required)
PUT /resource
PUT

                  
Delete a resource with DELETE.
(required)
(required)
(required)
DELETE /resource
DELETE

                  

/v1/extensions/:extensionId/endpoints/:endpointId/proxy

Proxy for endpoint

Attributes

Name Type Required Doc
Get one resource by id or an array of resources by filtering attribute with GET.
GET /resource

GET

                  
Create a new resource with a POST.
(required)
(required)
POST /resource
POST

                  
Update a resource with PUT.
(required)
(required)
PUT /resource
PUT

                  
Delete a resource with DELETE.
(required)
(required)
(required)
DELETE /resource
DELETE

                  

/v1/extensions/:extensionId/endpoints/:endpointId/speaker

Proxy for getting a speaker config

Attributes

Name Type Required Doc
Get one resource by id or an array of resources by filtering attribute with GET.
GET /resource

GET

                  
Create a new resource with a POST.
(required)
(required)
POST /resource
POST

                  
Update a resource with PUT.
(required)
(required)
PUT /resource
PUT

                  
Delete a resource with DELETE.
(required)
(required)
(required)
DELETE /resource
DELETE

                  

/v1/extensions/:extensionId/endpoints/:endpointId/uploads

Uploads for endpoint

Attributes

Name Type Required Doc
id
time-uuid
false ID of the upload
fileName
string
true File name of the upload
md5
string
true The content's MD5
uploadType
option: backup, other
true The type of upload
contentType
string
false The content's type
url
string
false The download/upload url of the file
lastModified
timestamp
false The last modified date of the file
size
integer
false The size (in bytes) of the file
Get one resource by id or an array of resources by filtering attribute with GET.
GET /resource

GET

                  
Create a new resource with a POST.
(required)
(required)
(required)
(required)
(required)
POST /resource
POST

                  
Update a resource with PUT.
(required)
(required)
(required)
PUT /resource
PUT

                  
Delete a resource with DELETE.
(required)
(required)
(required)
DELETE /resource
DELETE

                  

/v1/extensions/:extensionId/proxy

Proxy for extension

Attributes

Name Type Required Doc
Get one resource by id or an array of resources by filtering attribute with GET.
GET /resource

GET

                  
Create a new resource with a POST.
(required)
POST /resource
POST

                  
Update a resource with PUT.
(required)
PUT /resource
PUT

                  
Delete a resource with DELETE.
(required)
(required)
DELETE /resource
DELETE

                  

/v1/failover-pairs

Maps primary and backup endpoints to activation groups

Attributes

Name Type Required Doc
id
time-uuid
false ID of the Failover Pair
name
string
true Name of the Failover Pair
primaryEndpointId
time-uuid
true Primary Endpoint ID
backupEndpointId
time-uuid
true Backup Endpoint ID
timeout
integer
true Timeout for both replication and heartbeat (in seconds)
Get one resource by id or an array of resources by filtering attribute with GET.
GET /resource

GET

                  
Create a new resource with a POST.
(required)
(required)
(required)
(required)
POST /resource
POST

                  
Update a resource with PUT.
(required)
PUT /resource
PUT

                  
Delete a resource with DELETE.
(required)
DELETE /resource
DELETE

                  

/v1/inbound-cap-rules

Stores rules for creating notifications for inbound CAP messages.

Attributes

Name Type Required Doc
id
time-uuid
false ID of the rule
name
string
true Name of the rule
expression
string
true The conditional logic of the rule.
messageTemplateId
time-uuid
true ID of the message template to use when the rule matches.
languageCode
string
false If specified will only send out notification from matching <language> substring.
disabled
boolean
false If specified, the rule will be disabled if true, false otherwise
Get one resource by id or an array of resources by filtering attribute with GET.
GET /resource

GET

                  
Create a new resource with a POST.
(required)
(required)
(required)
POST /resource
POST

                  
Update a resource with PUT.
(required)
PUT /resource
PUT

                  
Delete a resource with DELETE.
(required)
DELETE /resource
DELETE

                  

/v1/inbound-email

Configures inbound email sources and destination routing.

Attributes

Name Type Required Doc
id
time-uuid
false ID of the Inbound Email Tag
name
string
true Name of the Inbound Email Tag
sourceWhitelist
array[uuid]
true Strings or regular expressions that represent allowable from addresses
securityLevel
option: high, medium, low, off
true Represents the strictness of the security policy regarding SPF records
tag
time-uuid
false The email address tag. Used for grouping multiple outbound rules
disabled
boolean
false If disabled equals true, no notifications will be sent based on the settings for this label. Defaults to `false`.
outboundRuleIds
array[uuid]
false IDs of outbound rules
Get one resource by id or an array of resources by filtering attribute with GET.
GET /resource

GET

                  
Create a new resource with a POST.
(required)
Copy (required)
(required)
POST /resource
POST

                  
Update a resource with PUT.
(required)
PUT /resource
PUT

                  
Delete a resource with DELETE.
(required)
DELETE /resource
DELETE

                  

/v1/inbound-email/:inboundEmailId/outbound-rules

Configures inbound email notification triggering rules and routing

Attributes

Name Type Required Doc
id
time-uuid
false ID of the Outbound Rules
name
string
true Name of the Outbound Rules
messageTemplateId
time-uuid
true ID of the associated message template
distributionListIds
array[uuid]
false IDs of the associated distribution list overrides
userIds
array[uuid]
false IDs of the associated user overrides
subjectCriteria
array[uuid]
false Strings or regular expressions that match on the contents of the subject field
bodyCriteria
array[uuid]
false Strings or regular expressions that match on the contents of the body field
disabled
boolean
false If set to true, notifications on inbound emails are disabled. Defaults to `false`.
Get one resource by id or an array of resources by filtering attribute with GET.
GET /resource

GET

                  
Create a new resource with a POST.
(required)
(required)
(required)
POST /resource
POST

                  
Update a resource with PUT.
(required)
(required)
PUT /resource
PUT

                  
Delete a resource with DELETE.
(required)
(required)
DELETE /resource
DELETE

                  

/v1/inbound-rss-feeds

Assigns which rss feeds to listen to for this provider.

Attributes

Name Type Required Doc
id
time-uuid
false Identifier of RSS feed.
url
string
true URL of the RSS feed to be monitored.
name
string
true Name of the RSS feed.
messageTemplateId
time-uuid
true ID of the message template to use when generating a notification.
distributionListIds
array[uuid]
false List of distribution lists to notify.
disabled
boolean
false True if the RSS feed is disabled
Get one resource by id or an array of resources by filtering attribute with GET.
GET /resource

GET

                  
Create a new resource with a POST.
(required)
(required)
(required)
POST /resource
POST

                  
Update a resource with PUT.
(required)
PUT /resource
PUT

                  
Delete a resource with DELETE.
(required)
DELETE /resource
DELETE

                  

/v1/load-definitions

Attributes

Name Type Required Doc
name
string
true Name of the Load Definition
id
time-uuid
false ID of the load request
deletePolicy
option: delete, retain
false If the load requests should delete or retain users not present in the CSV
securityGroupUpdatePolicy
option: update, skip
false If the load requests should update existing security groups or skip updates
distributionListUpdatePolicy
option: update, skip
false If the load requests should update existing distribution lists or skip updates
deviceUpdatePolicy
option: update, skip
false If the load requests should update existing user devices or skip updates
domainUpdatePolicy
option: update, skip
false If the load requests should update existing user domains or skip updates
Get one resource by id or an array of resources by filtering attribute with GET.
GET /resource

GET

                  
Create a new resource with a POST.
(required)
POST /resource
POST

                  
Update a resource with PUT.
PUT /resource
PUT

                  
Delete a resource with DELETE.
(required)
DELETE /resource
DELETE

                  

/v1/load-definitions/:loadDefinitionId/distribution-list-mappings

Attributes

Name Type Required Doc
id
time-uuid
false ID of the Tag Mapping
tagName
string
false Name of the Tag to map
distributionListId
time-uuid
false Distribution List to map the tag to
Get one resource by id or an array of resources by filtering attribute with GET.
GET /resource

GET

                  
Create a new resource with a POST.
(required)
POST /resource
POST

                  
Update a resource with PUT.
(required)
(required)
PUT /resource
PUT

                  
Delete a resource with DELETE.
(required)
(required)
DELETE /resource
DELETE

                  

/v1/load-definitions/:loadDefinitionId/domain-mappings

Attributes

Name Type Required Doc
id
time-uuid
false ID of the Tag Mapping
tagName
string
false Name of the Tag to map
domainId
time-uuid
false Domain to map the tag to
Get one resource by id or an array of resources by filtering attribute with GET.
GET /resource

GET

                  
Create a new resource with a POST.
(required)
POST /resource
POST

                  
Update a resource with PUT.
(required)
(required)
PUT /resource
PUT

                  
Delete a resource with DELETE.
(required)
(required)
DELETE /resource
DELETE

                  

/v1/load-definitions/:loadDefinitionId/domains

Domains to which the User Loader belongs

Attributes

Name Type Required Doc
id
time-uuid
false Domain ID
demote
boolean
false Required to be true when adding a domain that will replace a parent
promote
boolean
false Required to be true when adding a domain that will replace one or more descendants
name
string
false Filter list results by matching on name
Get one resource by id or an array of resources by filtering attribute with GET.
GET /resource

GET

                  
Create a new resource with a POST.
(required)
POST /resource
POST

                  
Update a resource with PUT.
(required)
(required)
PUT /resource
PUT

                  
Delete a resource with DELETE.
(required)
(required)
DELETE /resource
DELETE

                  

/v1/load-definitions/:loadDefinitionId/load-requests

Attributes

Name Type Required Doc
id
time-uuid
false ID of the load request
data
file
false CSV file containing load data
loadState
option: queued, running, errored, finished
false Status of the load request
log
string
false Log of load
tagsSeen
array[string]
false Tags seen in this load request
unmappedTags
array[string]
false Tags seen but unable to be processed as no tag mapping exists
Get one resource by id or an array of resources by filtering attribute with GET.
GET /resource

GET

                  
Create a new resource with a POST.
(required)
POST /resource
POST

                  
Update a resource with PUT.
(required)
(required)
PUT /resource
PUT

                  
Delete a resource with DELETE.
(required)
(required)
DELETE /resource
DELETE

                  

/v1/load-definitions/:loadDefinitionId/security-group-mappings

Attributes

Name Type Required Doc
id
time-uuid
false ID of the Tag Mapping
tagName
string
false Name of the Tag to map
securityGroupId
time-uuid
false Security Group to map the tag to
Get one resource by id or an array of resources by filtering attribute with GET.
GET /resource

GET

                  
Create a new resource with a POST.
(required)
POST /resource
POST

                  
Update a resource with PUT.
(required)
(required)
PUT /resource
PUT

                  
Delete a resource with DELETE.
(required)
(required)
DELETE /resource
DELETE

                  

/v1/message-templates

The Message Templates

Attributes

Name Type Required Doc
id
time-uuid
false ID of the message template
name
string
true Name of the message template
subject
string
true Subject (perhaps a summary version) of message
inferredMessageType
string
false The inferred type of the fusion message type
subjectCustomizable
boolean
false Whether or not the subject can be customized when the notification is sent (defaults to false)
subjectDisplay
option: auto, hide, show
false Suggestion to client application whether or not the subject is shown when sending the notification (defaults to auto)
distributionListIds
array[uuid]
false IDs of Distribution Lists to send to
distributionListIdsCustomizable
boolean
false Whether or not the distribution-list-ids can be customized when the notification is sent (defaults to false)
distributionListIdsDisplay
option: auto, hide, show
false Suggestion to the client whether or not to display the distribution-list-ids when sending the notification (defaults to auto)
deviceGroupIds
array[uuid]
false IDs of Device Groups to send to
deviceGroupIdsCustomizable
boolean
false Whether or not the device-group-ids can be customized when the notification is sent (defaults to false)
deviceGroupIdsDisplay
option: auto, hide, show
false Suggestion to the client whether or not to display the device-group-ids when sending the notification (defaults to auto)
userIds
array[uuid]
false Users to send the message template to
userIdsCustomizable
boolean
false Whether or not the distribution-list-ids can be customized when the notification is sent (defaults to false)
userIdsDisplay
option: auto, show, hide
false Suggestion to the client application whether or not to show the user-ids when sending the notification (defaults to auto)
collaborationGroupIds
array[uuid]
false IDs of collaboration groups to send to
collaborationGroupIdsCustomizable
boolean
false Whether or not the collaboration-group-ids can be customized when the notification is sent (defaults to false)
collaborationGroupIdsDisplay
option: auto, hide, show
false Suggestion to the client whether or not to display the collaboration-group-ids when sending the notification (defaults to auto)
areaOfInterestIds
array[uuid]
false Areas of interest to send the message template to
areaOfInterestIdsCustomizable
boolean
false Whether or not the area-of-interest-ids can be customized when the notification is sent (defaults to false)
areaOfInterestIdsDisplay
option: auto, show, hide
false Suggestion to the client application whether or not to show the area-of-interest-ids when sending the notification (defaults to auto)
body
string
false Body of message
bodyCustomizable
boolean
false Whether or not the body can be customized when the notification is sent (defaults to false)
bodyDisplay
option: auto, show, hide
false Suggestion to client application whether or not to show the body when sending the notification (defaults to auto)
audio
file
false Audio version of message
audioCustomizable
boolean
false Whether or not the audio can be customized when the notification is sent (defaults to false)
audioDisplay
option: auto, show, hide
false Suggestion to client application whether or not to show the audio file when sending the notification (defaults to auto)
image
file
false Image attached to message template
imageCustomizable
boolean
false Whether or not the image can be customized when the notification is sent (defaults to false)
imageDisplay
option: auto, show, hide
false Suggestion to client application whether to show the image when sending the notification (defaults to auto)
imageMimeType
option: image/png, image/jpeg, image/gif, image/jpg
false MIME type of image. Only image/png, image/gif, image/jpg and image/jpeg are supported
confirmationRequestId
time-uuid
false ID of Confirmation Request
confirmationRequestIdCustomizable
boolean
false Whether or not the confirmation request can be customized when the notification is sent (defaults to false)
confirmationRequestIdDisplay
option: auto, show, hide
false Suggestion to client application whether or not to show the confirmation request when sending the notification (defaults to auto)
expiration
integer
false The time in seconds the notification should expire from the time it is sent
expirationCustomizable
boolean
false Whether or not the expiration can be customized when the notification is sent (defaults to false)
expirationDisplay
option: auto, hide, show
false Suggestion to the client whether or not to display the expiration when sending the notification (defaults to auto)
metadata
json
false Metadata to attach to the notification
metadataCustomizable
boolean
false Whether or not metadata is customizable on notification send
alertTone
option: default, 911-dialed, accent, all-clear1, all-clear2, bell, bright, chime, chirp, class-change1, class-change2, class-change3, class-change4, class-change5, class-change6, code-blue, code-call, crystal, eas, eas-intro, evacuate1, evacuate2, evacuate3, evacuate4, fire-alarm, industrial-alarm, internal-emergency1, internal-emergency2, internal-emergency3, klaxon, location-closing, lockdown-1-pulse, lockdown-2-pulses, lockdown-3-pulses, lockdown, room-turn, severe-weather-advisory, shift-change1, shift-change2, shift-change3, shift-change4, silent, take-shelter, tone, tornado-siren
false The alert tone to play when sent as a mobile push notification (defaults to default)
alertToneCustomizable
boolean
false Whether or not the alert tone can be customized when the notification is sent (defaults to false)
alertToneDisplay
option: auto, show, hide
false Suggestion to client application whether or not to show the alert tone when sending the notification (defaults to auto)
notificationProfileId
time-uuid
false ID of Notification Profile applied to this Message Template.
optOut
boolean
false Whether or not end users can opt out of notifications based on this template (defaults to false)
followUp
boolean
false Denotes if this is a follow-up template; template must support the ability to customize users, only one may exist per provider (defaults to false)
Get one resource by id or an array of resources by filtering attribute with GET.
GET /resource

GET

                  
Create a new resource with a POST.
(required)
(required)
POST /resource
POST

                  
Update a resource with PUT.
(required)
PUT /resource
PUT

                  
Delete a resource with DELETE.
(required)
DELETE /resource
DELETE

                  

/v1/message-templates/:messageTemplateId/audio

Binary audio associated with notification

Attributes

Name Type Required Doc
Get one resource by id or an array of resources by filtering attribute with GET.
GET /resource

GET

                  
Create a new resource with a POST.
(required)
POST /resource
POST

                  
Update a resource with PUT.
(required)
PUT /resource
PUT

                  
Delete a resource with DELETE.
(required)
(required)
DELETE /resource
DELETE

                  

/v1/message-templates/:messageTemplateId/image

Binary image associated with notification

Attributes

Name Type Required Doc
Get one resource by id or an array of resources by filtering attribute with GET.
GET /resource

GET

                  
Create a new resource with a POST.
(required)
POST /resource
POST

                  
Update a resource with PUT.
(required)
PUT /resource
PUT

                  
Delete a resource with DELETE.
(required)
(required)
DELETE /resource
DELETE

                  

/v1/notification-profiles

Settings groups applied to a notification

Attributes

Name Type Required Doc
name
string
true name of the profile
id
time-uuid
false ID of the profile
settings
json
false Collapsed notification profile settings object
Get one resource by id or an array of resources by filtering attribute with GET.
GET /resource

GET

                  
Create a new resource with a POST.
(required)
POST /resource
POST

                  
Update a resource with PUT.
PUT /resource
PUT

                  
Delete a resource with DELETE.
(required)
DELETE /resource
DELETE

                  

/v1/notification-profiles/:notificationProfileId/settings

Settings in profile for an extension

Attributes

Name Type Required Doc
id
time-uuid
false Extension id of the profile setting
disabled
boolean
false If true, this device type from notifications.
value
json
false Actual notification settings for this extension
attachments
json
false Binary Attachements to the Notifcation Settings
Get one resource by id or an array of resources by filtering attribute with GET.
GET /resource

GET

                  
Create a new resource with a POST.
(required)
POST /resource
POST

                  
Update a resource with PUT.
(required)
(required)
PUT /resource
PUT

                  
Delete a resource with DELETE.
(required)
(required)
DELETE /resource
DELETE

                  

/v1/notification-profiles/:notificationProfileId/settings/:settingId/attachments

Attributes

Name Type Required Doc
id
time-uuid
false ID
Get one resource by id or an array of resources by filtering attribute with GET.
GET /resource

GET

                  
Create a new resource with a POST.
(required)
(required)
POST /resource
POST

                  
Update a resource with PUT.
(required)
(required)
(required)
PUT /resource
PUT

                  
Delete a resource with DELETE.
(required)
(required)
(required)
DELETE /resource
DELETE

                  

/v1/notifications

Notifications based on Message Templates

Attributes

Name Type Required Doc
id
time-uuid
false ID of the notification
messageTemplateId
time-uuid
false Message Template the notification is based on
subject
string
false Subject (perhaps a summary version) of the notification
initiatorId
time-uuid
false ID of the initiating user
initiator
string
false Stores a json representation of the initiating user
body
string
false Body of the notification
audio
file
false Audio attached to the notification
image
file
false Image attached to the notification
imageMimeType
option: image/png, image/jpeg, image/jpg, image/gif
false Mime type of image attached to notification
expiresAt
timestamp
false The time the notification will expire
abortedAt
timestamp
false The time the notification was aborted
createdAt
timestamp
false Time the notification was created
distributionListIds
array[uuid]
false Distribution Lists the notification was sent to
deviceGroupIds
array[uuid]
false Device Groups the notification was sent to
userIds
array[uuid]
false Users to send the notification to
collaborationGroupIds
array[uuid]
false Collaboration groups to send the notification to
areaOfInterestIds
array[uuid]
false Areas of interest to send the notification to
confirmationRequestId
time-uuid
false Confirmation Request to attach
metadata
json
false Metadata initiator can attach to notification
customVars
json
false Custom variables that are dynamically substituted in the subject or body templating.
alertTone
option: default, 911-dialed, accent, all-clear1, all-clear2, bell, bright, chime, chirp, class-change1, class-change2, class-change3, class-change4, class-change5, class-change6, code-blue, code-call, crystal, eas, eas-intro, evacuate1, evacuate2, evacuate3, evacuate4, fire-alarm, industrial-alarm, internal-emergency1, internal-emergency2, internal-emergency3, klaxon, location-closing, lockdown-1-pulse, lockdown-2-pulses, lockdown-3-pulses, lockdown, room-turn, severe-weather-advisory, shift-change1, shift-change2, shift-change3, shift-change4, silent, take-shelter, tone, tornado-siren
false The alert tone to use for mobile push notifications
notificationProfile
json
false Notification Profile
followUpForNotificationId
time-uuid
false Send a follow-up for the previously sent notification denoted
followUpForNotificationQuery
string
false Use the provided term-search query to determine additional recipients for a follow-up notification
followUpAllowed
boolean
false Whether a follow-up can be sent using this notification
initiationDetails[type]
option: rest-api, boundary-trigger, scheduled-notification, broadcast
false The type of notification this is
initiationDetails[scheduledNotificationActivity]
json
false If this notification was created by a scheduled notification, this field contains the scheduled-notification-activity
initiationDetails[broadcastEvent]
json
false If this notification was created by a fusion server broadcast, this field contains the broadcast-event
Get one resource by id or an array of resources by filtering attribute with GET.
GET /resource

GET

                  
Create a new resource with a POST.
POST /resource
POST

                  
Update a resource with PUT.
(required)
PUT /resource
PUT

                  
Delete a resource with DELETE.
(required)
DELETE /resource
DELETE

                  

/v1/notifications/:notificationId/activities

Activities on the Notification

Attributes

Name Type Required Doc
id
time-uuid
false Activity ID
userId
time-uuid
false User ID
type
option: cisco-spark, inbound-cap-sent, inbound-rss-sent, inbound-rss-failed, tracking-started, twitter-tweet-duplicate, recipient-skipped, sms-received, push-sent, call-answered, twitter-tweet-truncated, msteams-chat-failed, inbound-email-sent, msteams-chat-sent, confirmation, push-failed, tracking-terminated, expire, display-text-and-start-audio, escalation-rule-skipped, email-sent, conference-call-left, abort, email-queued, cisco-spark-failed, call-placed, twitter-tweet-split, display-text, sms-failed, start-audio, stop-audio, call-queued, sending-started, info, twitter-sent, call-failed, inbound-cap-failed, call-completed, inbound-email-failed, init-services, sending-finished, broadcast-started, push-queued, email-failed, sms-queued, conference-call-joined, conference-call-failed, twitter-image-over-limit, broadcast-finished, call-skipped, set-read-status, sms-sent, skip, tracking-completed, twitter-failed, broadcast-failed
false Type of Activity; Extensions may add other types
createdAt
timestamp
false The created time of the notification
readStatus
option: read, unread
false 'true' to mark the notification as read. 'false' to mark it as unread. Only available when 'type' is 'set-read-status'
details
json
false Activity details
confirmationOption
string
false Confirmation option chosen by user; only available when 'type' is confirmation
Get one resource by id or an array of resources by filtering attribute with GET.
GET /resource

GET

                  
Create a new resource with a POST.
(required)
POST /resource
POST

                  
Update a resource with PUT.
(required)
(required)
PUT /resource
PUT

                  
Delete a resource with DELETE.
(required)
(required)
DELETE /resource
DELETE

                  

/v1/notifications/:notificationId/audio

Binary audio associated with notification

Attributes

Name Type Required Doc
Get one resource by id or an array of resources by filtering attribute with GET.
GET /resource

GET

                  
Create a new resource with a POST.
(required)
POST /resource
POST

                  
Update a resource with PUT.
(required)
PUT /resource
PUT

                  
Delete a resource with DELETE.
(required)
(required)
DELETE /resource
DELETE

                  

/v1/notifications/:notificationId/devices

Devices that notifications were sent to

Attributes

Name Type Required Doc
id
time-uuid
false Id of devices
name
string
false Name of device
type
string
false Type of device
deviceIdentifier
string
false Device Identifier
Get one resource by id or an array of resources by filtering attribute with GET.
GET /resource

GET

                  
Create a new resource with a POST.
(required)
POST /resource
POST

                  
Update a resource with PUT.
(required)
(required)
PUT /resource
PUT

                  
Delete a resource with DELETE.
(required)
(required)
DELETE /resource
DELETE