The following table describes the settings for HTTP Generic Protocol Providers.
| Note: | If you are configuring this Protocol Provider to work with xMatters SMS, you must have simple SMS responses enabled, as explained in Configuring simple SMS replies. |
|
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. |
|
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. |
|
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. |
|
Response URL |
Webserver URL to which the Device Engine forwards the web API's response from the initial submission (e.g., http://yourwebserver/processResponse.jsp). |
| 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. |