Notification API Parameters

The parameters to use when creating or updating a notification rule depend on the notification type. The following table lists the parameters that are applicable to each type.

Parameters are optional unless otherwise noted.


Parameter	Description	Notes
changeStamp	The change stamp of the notification record.	Integer. Defaults to 0. changeStamp is returned in GET. changeStamp is required for PUT (Update API).
name	The name of the notification rule.	Required for POST.
campaignUrl	The URL of the campaign.	String. Required for POST.
description	Description.	String. Follows Customer Collaboration Platform standard description naming conventions.
tags/tag	Tag or list of tags from which the rule is activated and a notification is sent.	String. Required for POST. Maximum of 5.
type	The type of notification to send out for this rule.	Valid values are: email (Notification is sent over email.) IM (Notification is sent over IM.) http (Notification is used for chat and is reserved for other developer applications that deliver social contact data to an external application.) (connection to) CCE (Notification sends a request to CCE with media routing information.) Required for POST.
targets/target	One or more targets to which the notification rule is sent.	String. Required for POST. Maximum of 10.
httpUrl	The URL of a REST API.	Required for POST. Customer Collaboration Platform will post details of a social contact to this URL.
alternateHttpUrl	The URL of a REST API.	The URL of a REST API.Customer Collaboration Platform will post details of a social contact to this URL. This is a alternate URL which will be attempted to send notification in case primary URL is not accessible. Typically this is used in case of a cluster target. Instead of creating 2 separate notification rules, cluster targets could be clubbed in to 1 single notification rule.
subject	The subject of a notification rule message.	String. Maximum of 255 characters.
body	The body of the notification rule message. The link to the social contact is automatically inserted after the body. Link URL will appear beneath the body.	String. Maximum of 2048 characters. The body may contain reserved keywords in a special syntax. These reserved Notification Body keywords will be replaced with values from the social contact. The reserved word syntax takes the form ${KEYWORD}.
httpUsername	Username	Required if authentication is necessary to use the REST API specified by httpUrl.
httpPassword	Password	Required if authentication is necessary to use the REST API specified by httpUrl.
sslVerifyCertificates (optional)	Flag to always validate the SSL certificate of the remote URL.	Boolean. Allowed value is True. HTTPS only.
scriptSelector	The Dialed Number String/Script Selector from the CCE configuration.
mediaRoutingDomains	A list of media routing domains, each of which contains the media routing domain ID of the media routing domain from the CCE Configuration.	Integer, not null. At present, only one Media Routing Domain is supported.