Notification Rule

The Notification rule API allows you to configure notifications that are sent when a specific tag is added to a contact in a specific campaign.

Note	Only the administrator created during install can use this API.

This API is represented on the Customer Collaboration Platform user interface in the Notifications panel.

There are four types of notification rules: email, IM, http and (connection to) CCE. The parameters to use when creating or updating a notification rule depend on the type. The following table lists the parameters that are applicable to each type.


Rule type	Required parameters	Optional parameters	Notes
email	name, campaignUrl, tags, type, targets	description, subject, body
im	name, campaignUrl, tags, type, targets	description, body
http	name, campaignUrl, tags, type, httpUrl	description, httpUsername, httpPassword, sslVerifyCertificates
cce	name, campaignUrl, tags, type, scriptSelector, mediaRoutingDomainId	description	The scriptSelector is the Dialed Number String or Script Selector from the CCE configuration. The mediaRoutingDomainId is the ID of the selected Media Routing Domain from the CCE configuration. Currently, the only valid value for mediaRoutingDomainId is "1" (for voice callback).

Note	Fields not relevant to a given notification type will be ignored. For example, a body specified in a http notification rule will be ignored.

Note	You must configure an Email (SMTP) Server before notification can be sent through email. You must configure an XMPP server before IM notifications can be sent. Connection to CCE Notifications send a request to CCE with media routing information.