/v1/activation-groups

Activation Groups (limit: 200, filter limit per group: 200)

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/active-callaware-calls

Get a list of active calls across all Fusion servers

Attributes

Name Type Required Doc
type
option: endpoint-rule, callaware-rule
true Type that triggered the call
id
time-uuid
false id of endpoint activity
details
json
false info about the call
endpointId
time-uuid
false id of the endpoint the call is on
startTime
timestamp
false time that the call started
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/areas-of-interest

Geographic Areas of Interest (limit: 20)

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
boundingBox
string
false Specify bounding box to query for
syncedDeviceTypes
array[string]
false What kind of devices the AOI is synced to
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 (limit: 3500)

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/Nuuk, 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/Qostanay, 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/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/bell-schedules-bulk-exceptions

Create exceptions in multiple Bell Schedules at once

Attributes

Name Type Required Doc
startDate
date
true Start date for the exception.
endDate
date
true End date for the exception.
description
string
false Description of the exception to create in each bell schedule.
ringListId
time-uuid
false The ring list to use during the exception, omit to suppress rings.
bellScheduleIds
array[time-uuid]
false The bell schedules to which the exception should be added. Required unless you supply a true value for allBellSchedules.
allBellSchedules
boolean
false If true, will apply the exception to all bell schedules, regardless of the value of bellScheduleIds.
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.
PUT /resource
PUT

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

                  

/v1/bell-schedules/:bellScheduleId/clone

Makes a clone of a given bell schedule

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/bell-schedules/:bellScheduleId/domains

Domains to which the Bell Schedule 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/brandings

Provides access to brandings resources for Fusion customers. Brandings provides a way to customize UI.

Attributes

Name Type Required Doc
id
time-uuid
true The unique identifier for the brandings record.
logo
file
false The brandings logo.
logoAltText
string
false Alt text for the logo image.
primaryColor
string
false Hex color value for the branding's primary color.
secondaryColor
string
false Hex color value for the branding's secondary color.
companyName
string
false Name of the company that owns the branding.
companyEmail
string
false The branding contact's email address.
companyPhone
string
false The branding contact's phone number.
customUrl
string
false A web link to custom help content for brandings customers.
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/bulk-uploads

Supports the bulk upload of resources from a tsv.

Attributes

Name Type Required Doc
id
time-uuid
false ID of the Bulk Upload
resourceType
option: message-templates, device-groups, speakers, bell-schedules, call-aware-call-redirects, call-aware-routing-requests, ring-lists, dialing-configurations
true The type of resource for upload
testMode
boolean
false Whether or not to rollback the transaction after completion
endpointId
time-uuid
false Id of the destination fusion server
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/bulk-uploads/:bulkUploadId/commit

Commits the current bulk upload

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/bulk-uploads/:bulkUploadId/logs

Gets logs for a specific bulk upload

Attributes

Name Type Required Doc
resourceCreated
boolean
false Filter whether or not the resource in the log was created
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/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/collaboration-groups/:collaborationGroupId/domains

Domains to which the Collaboration Group 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/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
includeDynamicReplies
boolean
false Whether dynamic replies should be included in the response. Default true.
includeEscalationRules
boolean
false Whether escalation rules should be included in the response. Default true.
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/clone

Makes a clone of a given confirmation request.

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/confirmation-requests/:confirmationRequestId/domains

Domains to which the Confirmation Request 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/confirmation-requests/:confirmationRequestId/dynamic-replies

Attributes

Name Type Required Doc
id
time-uuid
false ID of the dynamic reply
optionLabel
string
true The confirmation response option text the dynamic reply rule applies to
quota
integer
false The number of confirmations of <option-label> that will receive the <first> reply
first
string
false Response for the first <quota> confirmations
rest
string
false Response for any confirmations greater than the first <quota>
every
string
false Response for every 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)
(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/confirmation-requests/:confirmationRequestId/escalation-rules

Attributes

Name Type Required Doc
id
time-uuid
false ID of the escalation rule
confirmationRequestId
time-uuid
false ID of the associated confirmation request
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)
(required)
PUT /resource
PUT

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

                  

/v1/cucm-clusters

CUCM Cluster settings that are independent of a specific Fusion server.

Attributes

Name Type Required Doc
id
time-uuid
false Id of the CUCM cluster
name
string
true Name of the CUCM cluster
snmpVersion
string
true #{2, 3}. If 2, then only snmp-community is required. If 3, then only snmp-username, snmp-auth-password, and snmp-encrypt-password are required.
axlAddress
string
true Address of the AXL server used to retrieve information from the CUCM DB.
axlUser
string
true User used to authenticate with the AXL server.
nextAuthenticationUrl
string
false For commands that don't originate from InformaCast, this URL will be used to authenticate pushes sent to phones.
snmpCommunity
string
false Only used in SNMP v2. The human-readable partition name for phones in your SNMP system.
snmpUsername
string
false Only used in SNMP v3. Older versions do not use this. The username provided by InformaCast when requesting CUCM authenticate the SNMP request.
snmpAuthPassword
string
false Only used in SNMP v3. Older versions do not use this. The password provided by InformaCast when requesting CUCM authenticate the SNMP request.
snmpEncryptPassword
string
false Only used in SNMP v3. CUCM Privacy Password. Only used in SNMP v3. Older versions do not use this. Refer to SNMP docs for purpose.
secureConnection
boolean
false Indicates whether the CTI connnection (if in use) is conducted over TLS.
capfAddress
string
false Address of the server used to authenticate certificates.
capfPort
integer
false Port of the server used to authenticate certificates.
tftpAddress
string
false Address of the file server used to transfer files to CUCM.
tftpPort
integer
false Port of the file server used to transfer files to CUCM.
axlPassword
string
false Password used to authenticate with the AXL server.
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/cucm-clusters/:cucmClusterId/fusion-servers

CUCM configuration that pertains to a specific Fusion server

Attributes

Name Type Required Doc
id
time-uuid
false ID of Fusion server CUCM settings.
endpointId
time-uuid
true ID of the Fusion server.
cmAddress
string
true Comma delimited list of servers to try, in order, for a CTI connection.
cmUsername
string
true Username for CTI activation. Used for JTAPI enabled only.
cmPassword
string
false Password for CTI activation. Used for JTAPI enabled only
jtapiPhoneActivationEnabled
boolean
false If true, phones that came from this cluster distributed to this fusion server will use JTAPI for activation. False if they will use HTTP.
jtapiStaticTerminalsEnabled
boolean
false Only used when JTAPI enabled is true. If true, InformaCast will create CTI connections over JTAPI to as many phones as it can when InformaCast starts.
syncId
string
false The ID of this record in the Fusion database. Used for optimizing sync performance.
makeCtiConnection
boolean
false Says whether or not InformaCast will create JTAPI connections ahead of time for performance.
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)
PUT /resource
PUT

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

                  

/v1/device-groups

Device Groups (limit: 3500, filter limit per group: 200)

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
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/device-groups/:deviceGroupId/clone

Makes a clone of a given device group

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/device-groups/:deviceGroupId/domains

Domains to which the Device Group 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/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
icopIds
json
false Device icop ids by which to filter with
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

Distribution Lists (limit: 3500)

Attributes

Name Type Required Doc
id
time-uuid
false Distribution List ID
name
string
true Distribution List name
isSubscribable
boolean
false Marks the distribution list as subscribable for self service
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/clone

Makes a clone of a given distribution list

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/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/scim-groups

Associated SCIM groups for Distribution List

Attributes

Name Type Required Doc
id
time-uuid
false Id of member scim group
scimGroupId
time-uuid
true Id of member scim group
distributionListId
time-uuid
false Id of the distribution list
includeMemberCounts
boolean
false Whether or not to include member counts for the scim groups
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/distribution-lists/:distributionListId/user-subscriptions

Distribution List User Subscriptions (limit per Distribution List: 100,000)

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

Domains (limit: 200)

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/bell-schedules

The Bell Schedules which are members of the Domain

Attributes

Name Type Required Doc
id
time-uuid
false Bell Schedule 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/collaboration-groups

The Collaboration Groups which are members of the Domain

Attributes

Name Type Required Doc
id
time-uuid
false Collaboration 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
type
string
false Filter list results by matching on type of collaboration 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)
(required)
PUT /resource
PUT

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

                  

/v1/domains/:domainId/confirmation-requests

The Confirmation Requests which are members of the Domain

Attributes

Name Type Required Doc
id
time-uuid
false Confirmation Request 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/device-groups

The Device Groups which are members of the Domain

Attributes

Name Type Required Doc
id
time-uuid
false Device 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/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/incident-plans

The Incident Plans which are members of the Domain

Attributes

Name Type Required Doc
id
time-uuid
false Incident Plan 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/incidents

The Incidents which are members of the Domain

Attributes

Name Type Required Doc
id
time-uuid
false Incident 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/message-templates

The Message Templates which are members of the Domain

Attributes

Name Type Required Doc
id
time-uuid
false Message Template 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
followUp
boolean
false Is this a follow-up 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)
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/notification-profiles

The Notification Profiles which are members of the Domain

Attributes

Name Type Required Doc
id
time-uuid
false Notification Profile 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/notifications

The Notifications which are members of the Domain

Attributes

Name Type Required Doc
id
time-uuid
false Notification 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/ring-lists

The Ring Lists which are members of the Domain

Attributes

Name Type Required Doc
id
time-uuid
false Ring 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/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
type
option: regular, anonymous, application, endpoint, support
false Filter list results by matching on type of user
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 Extensions (license filter limit per type: 200)

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/devices

Endpoint for updating/querying devices with filters

Attributes

Name Type Required Doc
id
time-uuid
false Id of the device
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.
endpointId
time-uuid
false The endpoint the device belongs to
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)
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
isCucmMigrated
boolean
false Indicates whether or not this endpoint has had its CUCM clusters migrated to the cloud
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, replication-queue-reset, collect-logs, syncer-startup, log-message, phone-cache-update, phone-cache-full-delta-update, phone-cache-partial-update, axl-result, device-sync, replication-clean-up, restart, backup, callaware-recording
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)