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