[Index]
Model ref.: device/notification_service/CucmNotification
The full URL would include the host-proxy name: https://[host-proxy].
Variables are enclosed in square brackets.
{
"$schema": "http://json-schema.org/draft-03/schema",
"type": "object",
"properties": {
"version": {
"title": "Version",
"required": true,
"type": "string",
"readonly": false,
"description": "The version of the Call Manager for which notifications are required. Only supported from version 9.0 onwards.",
"choices": [
{
"title": "9.0",
"value": "9.0"
},
{
"title": "10.0",
"value": "10.0"
}
]
},
"client_name": {
"title": "Notification Client Name",
"required": false,
"type": "string",
"readonly": false,
"description": "The name of the client application that is listening for notifications from a Call Manager."
},
"network_id": {
"title": "Notification Client Network Id",
"required": false,
"type": "string",
"readonly": false,
"description": "Typically maps to the IP address or DNS name of the client application that is listening for notifications from a Call Manager."
},
"host": {
"title": "Host Name",
"required": true,
"type": "string",
"readonly": false,
"description": "The host name for the Call Manager that sends the notifications."
},
"port": {
"title": "Port",
"required": false,
"type": "integer",
"readonly": false,
"description": "The port that is used for communication with the Call Manager."
},
"username": {
"title": "Admin Username",
"required": true,
"type": "string",
"readonly": false,
"description": "The username for an administrator's account of the Call Manager"
},
"password": {
"title": "Admin Password",
"required": true,
"type": "string",
"readonly": false,
"description": "The password for the given administrator account."
},
"polling_interval": {
"title": "Polling Interval",
"required": false,
"type": "integer",
"readonly": false,
"description": "The rate (in seconds) at with the service will poll the call manager for change notifications."
},
"object_names": {
"title": "Notification Objects",
"description": "A list of classes for which notifications are required.",
"required": false,
"type": "array",
"readonly": false,
"items": {
"type": "string",
"choices": [
{
"title": "LdapSearch",
"value": "LdapSearch"
},
{
"title": "CustomUserField",
"value": "CustomUserField"
},
{
"title": "CCAProfiles",
"value": "CCAProfiles"
},
{
"title": "PhoneNtp",
"value": "PhoneNtp"
},
{
"title": "CcdRequestingService",
"value": "CcdRequestingService"
},
{
"title": "Annunciator",
"value": "Annunciator"
},
{
"title": "CiscoCatalyst600024PortFXSGateway",
"value": "CiscoCatalyst600024PortFXSGateway"
},
{
"title": "MohServer",
"value": "MohServer"
},
{
"title": "SmartEntitlementRequest",
"value": "SmartEntitlementRequest"
},
{
"title": "EmccFeatureConfig",
"value": "EmccFeatureConfig"
},
{
"title": "DeviceProfileOptions",
"value": "DeviceProfileOptions"
},
{
"title": "ApplicationDialRules",
"value": "ApplicationDialRules"
},
{
"title": "PresenceRedundancyGroup",
"value": "PresenceRedundancyGroup"
},
{
"title": "UnassignedDevice",
"value": "UnassignedDevice"
},
{
"title": "VoiceMailPilot",
"value": "VoiceMailPilot"
},
{
"title": "SyslogConfiguration",
"value": "SyslogConfiguration"
},
{
"title": "Country",
"value": "Country"
},
{
"title": "IpPhoneServices",
"value": "IpPhoneServices"
},
{
"title": "RemoteCluster",
"value": "RemoteCluster"
},
{
"title": "MeetMe",
"value": "MeetMe"
},
{
"title": "DirNumberAliasLookupandSync",
"value": "DirNumberAliasLookupandSync"
},
{
"title": "DhcpSubnet",
"value": "DhcpSubnet"
},
{
"title": "WirelessAccessPointControllers",
"value": "WirelessAccessPointControllers"
},
{
"title": "ServiceProfile",
"value": "ServiceProfile"
},
{
"title": "SipProfile",
"value": "SipProfile"
},
{
"title": "CredentialPolicy",
"value": "CredentialPolicy"
},
{
"title": "ChangeDNDStatus",
"value": "ChangeDNDStatus"
},
{
"title": "FacInfo",
"value": "FacInfo"
},
{
"title": "LdapDirectory",
"value": "LdapDirectory"
},
{
"title": "RouteList",
"value": "RouteList"
},
{
"title": "ImeExclusionNumberGroup",
"value": "ImeExclusionNumberGroup"
},
{
"title": "SoftKeySet",
"value": "SoftKeySet"
},
{
"title": "HttpProfile",
"value": "HttpProfile"
},
{
"title": "InteractiveVoiceResponse",
"value": "InteractiveVoiceResponse"
},
{
"title": "GatewayEndpointDigitalAccessBri",
"value": "GatewayEndpointDigitalAccessBri"
},
{
"title": "SdpTransparencyProfile",
"value": "SdpTransparencyProfile"
},
{
"title": "CallManager",
"value": "CallManager"
},
{
"title": "SecureConfig",
"value": "SecureConfig"
},
{
"title": "ConferenceBridge",
"value": "ConferenceBridge"
},
{
"title": "SmartLicenseRenewRegistration",
"value": "SmartLicenseRenewRegistration"
},
{
"title": "CcdHostedDNGroup",
"value": "CcdHostedDNGroup"
},
{
"title": "LineGroup",
"value": "LineGroup"
},
{
"title": "UpdateLicenseUsage",
"value": "UpdateLicenseUsage"
},
{
"title": "ProcessNode",
"value": "ProcessNode"
},
{
"title": "CallManagerGroup",
"value": "CallManagerGroup"
},
{
"title": "CredentialPolicyDefault",
"value": "CredentialPolicyDefault"
},
{
"title": "Ddi",
"value": "Ddi"
},
{
"title": "MobilityProfile",
"value": "MobilityProfile"
},
{
"title": "SmartLicenseDeRegister",
"value": "SmartLicenseDeRegister"
},
{
"title": "Phone",
"value": "Phone"
},
{
"title": "TransPatternOptions",
"value": "TransPatternOptions"
},
{
"title": "DeviceProfile",
"value": "DeviceProfile"
},
{
"title": "ImeEnrolledPattern",
"value": "ImeEnrolledPattern"
},
{
"title": "IvrUserLocale",
"value": "IvrUserLocale"
},
{
"title": "MobileVoiceAccess",
"value": "MobileVoiceAccess"
},
{
"title": "TvsCertificate",
"value": "TvsCertificate"
},
{
"title": "UniversalDeviceTemplate",
"value": "UniversalDeviceTemplate"
},
{
"title": "RegistrationDynamic",
"value": "RegistrationDynamic"
},
{
"title": "AppServerInfo",
"value": "AppServerInfo"
},
{
"title": "SmartLicenseReRegister",
"value": "SmartLicenseReRegister"
},
{
"title": "BillingServer",
"value": "BillingServer"
},
{
"title": "CommonPhoneConfig",
"value": "CommonPhoneConfig"
},
{
"title": "HandoffConfiguration",
"value": "HandoffConfiguration"
},
{
"title": "RoutePlan",
"value": "RoutePlan"
},
{
"title": "InfrastructureDevice",
"value": "InfrastructureDevice"
},
{
"title": "User",
"value": "User"
},
{
"title": "AppUser",
"value": "AppUser"
},
{
"title": "NumDevices",
"value": "NumDevices"
},
{
"title": "ImeRouteFilterGroup",
"value": "ImeRouteFilterGroup"
},
{
"title": "RoutePartition",
"value": "RoutePartition"
},
{
"title": "CiscoCloudOnboarding",
"value": "CiscoCloudOnboarding"
},
{
"title": "ProcessNodeService",
"value": "ProcessNodeService"
},
{
"title": "OSVersion",
"value": "OSVersion"
},
{
"title": "AarGroupMatrix",
"value": "AarGroupMatrix"
},
{
"title": "SipRoutePattern",
"value": "SipRoutePattern"
},
{
"title": "SipTrunk",
"value": "SipTrunk"
},
{
"title": "ImeFirewall",
"value": "ImeFirewall"
},
{
"title": "Location",
"value": "Location"
},
{
"title": "ServiceParameter",
"value": "ServiceParameter"
},
{
"title": "FixedMohAudioSource",
"value": "FixedMohAudioSource"
},
{
"title": "TransPattern",
"value": "TransPattern"
},
{
"title": "RoutePartitionsForLearnedPatterns",
"value": "RoutePartitionsForLearnedPatterns"
},
{
"title": "WLANProfile",
"value": "WLANProfile"
},
{
"title": "Gatekeeper",
"value": "Gatekeeper"
},
{
"title": "IlsConfig",
"value": "IlsConfig"
},
{
"title": "Change",
"value": "Change"
},
{
"title": "AdvertisedPatterns",
"value": "AdvertisedPatterns"
},
{
"title": "ExpresswayCConfiguration",
"value": "ExpresswayCConfiguration"
},
{
"title": "MessageWaiting",
"value": "MessageWaiting"
},
{
"title": "HcsLicense",
"value": "HcsLicense"
},
{
"title": "TodAccess",
"value": "TodAccess"
},
{
"title": "SipRealm",
"value": "SipRealm"
},
{
"title": "SmartLicenseRegister",
"value": "SmartLicenseRegister"
},
{
"title": "GatewayEndpointType",
"value": "GatewayEndpointType"
},
{
"title": "H323Phone",
"value": "H323Phone"
},
{
"title": "SoftKey",
"value": "SoftKey"
},
{
"title": "DialPlanTag",
"value": "DialPlanTag"
},
{
"title": "CtiRoutePoint",
"value": "CtiRoutePoint"
},
{
"title": "Line",
"value": "Line"
},
{
"title": "LdapFilter",
"value": "LdapFilter"
},
{
"title": "ImeClient",
"value": "ImeClient"
},
{
"title": "UniversalLineTemplate",
"value": "UniversalLineTemplate"
},
{
"title": "ConfigEnterpriseParameters",
"value": "ConfigEnterpriseParameters"
},
{
"title": "DialPlan",
"value": "DialPlan"
},
{
"title": "ImeE164Transformation",
"value": "ImeE164Transformation"
},
{
"title": "DeviceMobility",
"value": "DeviceMobility"
},
{
"title": "Transcoder",
"value": "Transcoder"
},
{
"title": "WifiHotspot",
"value": "WifiHotspot"
},
{
"title": "AuthenticateUser",
"value": "AuthenticateUser"
},
{
"title": "Announcement",
"value": "Announcement"
},
{
"title": "RemoteDestinationProfile",
"value": "RemoteDestinationProfile"
},
{
"title": "GatewayEndpointDigitalAccessPri",
"value": "GatewayEndpointDigitalAccessPri"
},
{
"title": "SipDialRules",
"value": "SipDialRules"
},
{
"title": "SmartLicenseRenewAuthorization",
"value": "SmartLicenseRenewAuthorization"
},
{
"title": "FeatureGroupTemplate",
"value": "FeatureGroupTemplate"
},
{
"title": "BlockedLearnedPatterns",
"value": "BlockedLearnedPatterns"
},
{
"title": "PhoneButtonTemplate",
"value": "PhoneButtonTemplate"
},
{
"title": "UpdateRemoteCluster",
"value": "UpdateRemoteCluster"
},
{
"title": "LineFromULT",
"value": "LineFromULT"
},
{
"title": "DeviceDefaults",
"value": "DeviceDefaults"
},
{
"title": "GatewayEndpointDigitalAccessT1",
"value": "GatewayEndpointDigitalAccessT1"
},
{
"title": "SNMPCommunityString",
"value": "SNMPCommunityString"
},
{
"title": "PhoneOptions",
"value": "PhoneOptions"
},
{
"title": "Srst",
"value": "Srst"
},
{
"title": "GatewayEndpointAnalogAccess",
"value": "GatewayEndpointAnalogAccess"
},
{
"title": "UserGroup",
"value": "UserGroup"
},
{
"title": "ImeExclusionNumber",
"value": "ImeExclusionNumber"
},
{
"title": "ApplicationToSoftkeyTemplate",
"value": "ApplicationToSoftkeyTemplate"
},
{
"title": "LdapSyncCustomField",
"value": "LdapSyncCustomField"
},
{
"title": "Css",
"value": "Css"
},
{
"title": "LdapSyncStatus",
"value": "LdapSyncStatus"
},
{
"title": "WlanProfileGroup",
"value": "WlanProfileGroup"
},
{
"title": "SipProfileOptions",
"value": "SipProfileOptions"
},
{
"title": "RemoteDestination",
"value": "RemoteDestination"
},
{
"title": "PresenceGroup",
"value": "PresenceGroup"
},
{
"title": "CallPickupGroup",
"value": "CallPickupGroup"
},
{
"title": "CiscoCatalyst6000E1VoIPGateway",
"value": "CiscoCatalyst6000E1VoIPGateway"
},
{
"title": "MediaResourceGroup",
"value": "MediaResourceGroup"
},
{
"title": "ImeLearnedRoutes",
"value": "ImeLearnedRoutes"
},
{
"title": "RoutePattern",
"value": "RoutePattern"
},
{
"title": "SQLUpdate",
"value": "SQLUpdate"
},
{
"title": "CcdFeatureConfig",
"value": "CcdFeatureConfig"
},
{
"title": "PhoneActivationCode",
"value": "PhoneActivationCode"
},
{
"title": "UserProfileProvision",
"value": "UserProfileProvision"
},
{
"title": "Mtp",
"value": "Mtp"
},
{
"title": "SNMPUser",
"value": "SNMPUser"
},
{
"title": "H323Trunk",
"value": "H323Trunk"
},
{
"title": "ResourcePriorityNamespace",
"value": "ResourcePriorityNamespace"
},
{
"title": "CcdAdvertisingService",
"value": "CcdAdvertisingService"
},
{
"title": "UpdateTransportSettings",
"value": "UpdateTransportSettings"
},
{
"title": "DirectoryLookupDialRules",
"value": "DirectoryLookupDialRules"
},
{
"title": "GeoLocationFilter",
"value": "GeoLocationFilter"
},
{
"title": "PageLayoutPreferences",
"value": "PageLayoutPreferences"
},
{
"title": "DevicePool",
"value": "DevicePool"
},
{
"title": "EnterpriseParameters",
"value": "EnterpriseParameters"
},
{
"title": "EndUserCapfProfile",
"value": "EndUserCapfProfile"
},
{
"title": "FallbackProfile",
"value": "FallbackProfile"
},
{
"title": "ApplicationServer",
"value": "ApplicationServer"
},
{
"title": "MobileSmartClientProfile",
"value": "MobileSmartClientProfile"
},
{
"title": "PresenceUser",
"value": "PresenceUser"
},
{
"title": "SafSecurityProfile",
"value": "SafSecurityProfile"
},
{
"title": "SafForwarder",
"value": "SafForwarder"
},
{
"title": "CiscoCatalyst6000T1VoIPGatewayPri",
"value": "CiscoCatalyst6000T1VoIPGatewayPri"
},
{
"title": "SipTrunkSecurityProfile",
"value": "SipTrunkSecurityProfile"
},
{
"title": "UserLocale",
"value": "UserLocale"
},
{
"title": "CallPark",
"value": "CallPark"
},
{
"title": "VpnGateway",
"value": "VpnGateway"
},
{
"title": "FallbackFeatureConfig",
"value": "FallbackFeatureConfig"
},
{
"title": "TransformationProfile",
"value": "TransformationProfile"
},
{
"title": "EnterpriseFeatureAccessConfiguration",
"value": "EnterpriseFeatureAccessConfiguration"
},
{
"title": "PhysicalLocation",
"value": "PhysicalLocation"
},
{
"title": "DeviceLogout",
"value": "DeviceLogout"
},
{
"title": "CmcInfo",
"value": "CmcInfo"
},
{
"title": "CumaServerSecurityProfile",
"value": "CumaServerSecurityProfile"
},
{
"title": "ServiceParametersReset",
"value": "ServiceParametersReset"
},
{
"title": "ImportedDirectoryUriCatalogs",
"value": "ImportedDirectoryUriCatalogs"
},
{
"title": "AarGroup",
"value": "AarGroup"
},
{
"title": "Customer",
"value": "Customer"
},
{
"title": "NetworkAccessProfile",
"value": "NetworkAccessProfile"
},
{
"title": "ImeFeatureConfig",
"value": "ImeFeatureConfig"
},
{
"title": "UnassignedPresenceServers",
"value": "UnassignedPresenceServers"
},
{
"title": "VpnGroup",
"value": "VpnGroup"
},
{
"title": "CalledPartyTransformationPattern",
"value": "CalledPartyTransformationPattern"
},
{
"title": "UcService",
"value": "UcService"
},
{
"title": "DateTimeGroup",
"value": "DateTimeGroup"
},
{
"title": "InterClusterDirectoryUri",
"value": "InterClusterDirectoryUri"
},
{
"title": "Gateway",
"value": "Gateway"
},
{
"title": "ImeRouteFilterElement",
"value": "ImeRouteFilterElement"
},
{
"title": "TimeSchedule",
"value": "TimeSchedule"
},
{
"title": "SNMPMIB2List",
"value": "SNMPMIB2List"
},
{
"title": "CommonDeviceConfig",
"value": "CommonDeviceConfig"
},
{
"title": "UnassignedPresenceUsers",
"value": "UnassignedPresenceUsers"
},
{
"title": "DhcpServer",
"value": "DhcpServer"
},
{
"title": "SoftKeyTemplate",
"value": "SoftKeyTemplate"
},
{
"title": "SelfProvisioning",
"value": "SelfProvisioning"
},
{
"title": "TimePeriod",
"value": "TimePeriod"
},
{
"title": "LicensingResourceUsage",
"value": "LicensingResourceUsage"
},
{
"title": "ApplicationUserCapfProfile",
"value": "ApplicationUserCapfProfile"
},
{
"title": "LineOptions",
"value": "LineOptions"
},
{
"title": "VoiceMailProfile",
"value": "VoiceMailProfile"
},
{
"title": "CallingPartyTransformationPattern",
"value": "CallingPartyTransformationPattern"
},
{
"title": "EnterprisePhoneConfig",
"value": "EnterprisePhoneConfig"
},
{
"title": "GeoLocation",
"value": "GeoLocation"
},
{
"title": "UserPhoneAssociation",
"value": "UserPhoneAssociation"
},
{
"title": "SafCcdPurgeBlockLearnedRoutes",
"value": "SafCcdPurgeBlockLearnedRoutes"
},
{
"title": "FeatureControlPolicy",
"value": "FeatureControlPolicy"
},
{
"title": "VpnProfile",
"value": "VpnProfile"
},
{
"title": "CallerFilterList",
"value": "CallerFilterList"
},
{
"title": "ImeEnrolledPatternGroup",
"value": "ImeEnrolledPatternGroup"
},
{
"title": "MediaResourceList",
"value": "MediaResourceList"
},
{
"title": "ConferenceNow",
"value": "ConferenceNow"
},
{
"title": "SIPNormalizationScript",
"value": "SIPNormalizationScript"
},
{
"title": "AssignedPresenceUsers",
"value": "AssignedPresenceUsers"
},
{
"title": "ExternalCallControlProfile",
"value": "ExternalCallControlProfile"
},
{
"title": "DeviceReset",
"value": "DeviceReset"
},
{
"title": "HuntPilot",
"value": "HuntPilot"
},
{
"title": "Mobility",
"value": "Mobility"
},
{
"title": "CCMVersion",
"value": "CCMVersion"
},
{
"title": "SmartLicenseStatus",
"value": "SmartLicenseStatus"
},
{
"title": "GatewaySccpEndpoints",
"value": "GatewaySccpEndpoints"
},
{
"title": "CalledPartyTracing",
"value": "CalledPartyTracing"
},
{
"title": "ResourcePriorityNamespaceList",
"value": "ResourcePriorityNamespaceList"
},
{
"title": "RecordingProfile",
"value": "RecordingProfile"
},
{
"title": "RouteGroup",
"value": "RouteGroup"
},
{
"title": "CiscoCatalyst6000T1VoIPGatewayT1",
"value": "CiscoCatalyst6000T1VoIPGatewayT1"
},
{
"title": "MlppDomain",
"value": "MlppDomain"
},
{
"title": "DeviceMobilityGroup",
"value": "DeviceMobilityGroup"
},
{
"title": "GatewayType",
"value": "GatewayType"
},
{
"title": "LbmGroup",
"value": "LbmGroup"
},
{
"title": "MraServiceDomain",
"value": "MraServiceDomain"
},
{
"title": "GeoLocationPolicy",
"value": "GeoLocationPolicy"
},
{
"title": "InterClusterServiceProfile",
"value": "InterClusterServiceProfile"
},
{
"title": "ElinGroup",
"value": "ElinGroup"
},
{
"title": "PhoneSecurityProfile",
"value": "PhoneSecurityProfile"
},
{
"title": "RegionMatrix",
"value": "RegionMatrix"
},
{
"title": "CcdHostedDN",
"value": "CcdHostedDN"
},
{
"title": "LdapSystem",
"value": "LdapSystem"
},
{
"title": "HuntList",
"value": "HuntList"
},
{
"title": "AudioCodecPreferenceList",
"value": "AudioCodecPreferenceList"
},
{
"title": "LicensedUser",
"value": "LicensedUser"
},
{
"title": "LbmHubGroup",
"value": "LbmHubGroup"
},
{
"title": "LocalRouteGroup",
"value": "LocalRouteGroup"
},
{
"title": "SoftKeyCallState",
"value": "SoftKeyCallState"
},
{
"title": "H323Gateway",
"value": "H323Gateway"
},
{
"title": "VohServer",
"value": "VohServer"
},
{
"title": "VoiceMailPort",
"value": "VoiceMailPort"
},
{
"title": "PhoneType",
"value": "PhoneType"
},
{
"title": "DeviceLogin",
"value": "DeviceLogin"
},
{
"title": "ImeServer",
"value": "ImeServer"
},
{
"title": "MohAudioSource",
"value": "MohAudioSource"
},
{
"title": "Region",
"value": "Region"
},
{
"title": "AssignedPresenceServers",
"value": "AssignedPresenceServers"
},
{
"title": "DiscardDigitInstruction",
"value": "DiscardDigitInstruction"
},
{
"title": "PhoneTypeDisplayInstance",
"value": "PhoneTypeDisplayInstance"
},
{
"title": "LdapSync",
"value": "LdapSync"
},
{
"title": "DefaultDeviceProfile",
"value": "DefaultDeviceProfile"
},
{
"title": "TransportSettings",
"value": "TransportSettings"
},
{
"title": "EnterpriseParametersReset",
"value": "EnterpriseParametersReset"
},
{
"title": "DirectedCallPark",
"value": "DirectedCallPark"
},
{
"title": "LdapAuthentication",
"value": "LdapAuthentication"
},
{
"title": "RouteFilter",
"value": "RouteFilter"
}
]
}
},
"registration_id": {
"title": "Registration Id",
"description": "An Id that is generated by the Call Manager for the client that is listening for change notifications.",
"required": false,
"type": "string",
"readonly": true
}
}
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Purge | POST | /api/device/notification_service/CucmNotification/purge/ |
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Purge | POST | /api/device/notification_service/CucmNotification/[pkid]/purge | hierarchy=[hierarchy] | If payload required: |