The SMSPreferenceHandler API provides methods to manage SMS configurations.

This API is implemented as the script include SMSPreferenceHandlerSNC and resides in the sn_sms_pref namespace. To use this API you must install the Notify plugin (com.snc.notify) which requires a separate subscription. You can activate this plugin if you have the admin role.

SMSPreferenceHandler - getConfig()

Returns the preferences configuration record for the current telephony service provider.

The method queries all preference configuration records from the SMS Preference Configuration [sn_sms_pref_configuration] table for the current telephony service provider, sorts the results by the Order field (lowest to highest), and then returns the first record.

Table 1. Parameters
Name Type Description
None
Table 2. Returns
Type Description
GlideRecord Preference configuration record for the current telephony service provider. If no record exists, then null.

Example

var handler = new sn_sms_pref.SMSPreferenceHandler('TwilioDirect'); // Pass the provider name
var config = handler.getConfig();

SMSPreferenceHandler - SMSPreferenceHandler(String provider)

Instantiates the SMSPreferenceHandler script include object.

Table 3. Parameters
Name Type Description
provider String Name of the telephony service provider.

Example

var handler = new sn_sms_pref.SMSPreferenceHandler('TwilioDirect'); // Pass the provider name
var config = handler.getConfig();