HTTP xMatters SMS Protocol Providers

The following table describes the settings for HTTP xMatters SMS Protocol Providers. For information on how xMatters processes SMS messages and responses, see Configuring SMS messages and replies.

Note that the HTTP xMatters SMS service is provided by xMatters; contact your Client Assistance representative to set up an account, and for help with the required values for this page.

Note: The xMatters SMS service requires that you have simple SMS responses enabled, as explained in Configuring simple SMS replies.
HTTP xMatters SMS Provider Details

Setting

Description

Name

Name of the protocol provider.

Description

A brief description of the provider (optional).

Maximum Retries

Number of times to resend a notification before potentially using an alternate service provider; allowable values are from 0 to 10.

Retry Interval

Amount of time in seconds to wait between retries.

Maximum Session Size

Number of notifications per connection/session.

Split long message

Controls whether notifications that exceed the number of characters specified by the Split size setting are split into multiple smaller messages or sent as a single message.

Split size

Determines the maximum number of characters per message sent to this Protocol Provider. This setting applies only if the Split long message check box is selected.

If you are using the SAR concatenation method, refer to the "HTTP xMatters SMS Protocol Providers" note following this table for more information about this setting.

Maximum message length

If enforced by this provider, the maximum number of characters allowed per notification. For more information, see Setting Maximum Message Length.

Maximum PIN length

If enforced by this provider, the maximum number of characters allowed in a PIN. If the PIN is longer than the maximum PIN length, the leading characters are truncated.

Short Code Compliance

Select an option to specify when xMatters should send a notification explaining terms of service to each SMS Device:

  • None: xMatters will not send a notification to the Device when it is added, modified, or activated.
  • Send Welcome: xMatters will send a Welcome notification to an SMS Device when it is added, modified, or activated. (The content of this message is defined in the SMSCONFIRMMSG Constant.)
  • Send Custom: xMatters will send a Custom notification to an SMS Device when it is added, modified, or activated. (The content of this message is defined in the SMSFIRSTMMSG Constant.)
  • Send Welcome and Custom: Sends both the Welcome and the Custom messages.

In addition to modifying the content of the Custom message, you can modify its behavior and other properties using the xMatters scripts. For example, you could extend the functionality of the Custom message to include a validation request, and then select the "Send Welcome and Custom" option. Whenever a User added a new Device, xMatters would send a Welcome message containing the standard terms and conditions, and then automatically send a validation request to the Device three seconds later.

Note that specific content for these messages may be required by local regulations or your SMS provider; for more information about specifying their content, see SMS Confirmation and First Alert Messages Constants.

After changing this value, you must restart any Device Engines using this Protocol Provider for the changes to be applied.

API URL

URL to which the Device Engine initially submits (e.g., http://webapi.somecompany.com: 8080).

Username

Typically, the username supplied by the web API provider; required if the URL uses HTTP authentication.

Password

Typically, the password supplied by the web API provider; required if the URL uses HTTP authentication.
API ID The number used by xMatters to identify your xMatters SMS account.
From The phone number to use as the caller ID that identifies the source of outgoing messages. Must be a valid outgoing caller ID for your account.

Response URL

Web server URL to which the Device Engine forwards the web API's response from the initial submission (i.e., http://yourwebserver/services/xmsms).

Request Parameters This area displays an editable list of HTTP request parameters available to this provider. This list is typically specified by the web API.

Click Add New Name/Value Pair to create a new request parameter, and then specify a Name and Value in the related fields. To remove a request parameter, select the related check box and then click Remove Selected Name/Value Pair.

Country-Specific Overrides

You can set country-specific overrides for the Protocol Provider's Source Address: if a country override exists that matches the country specified for a User's text phone Device details, the Protocol Provider will use the source address overrides.

To add a new country override, click Add New Country, and then select the country for which you want to configure the override from the Country drop-down list. Select an option in the Short Code Compliance if you want to send a welcome notification to Users whose Devices match the specified country.

In the Source Address field, type the address you want to use for recipients in that country.

You can also specify a separate address to which recipients should send their responses. If you specify an address in the Reply To field, the response portion of the SMS message includes "Send reply to <address>." Note that this does not override or affect the original source of the message; it provides a visual reminder to the recipient that they should respond to a different address.

Note: This feature requires that you have configured simple SMS replies, as described in Configuring simple SMS replies.