Skip to content

IAdmSendSmsHttpGatewaySettings

The IAdmSendSmsHttpGatewaySettings interface represents settings of the HTTP to SMS gateway type.

Inheritance: The IAdmSendSmsHttpGatewaySettings interface inherits from the IAdmSendSmsGatewaySettings interface.

Note

For information on how to use the IAdmSendSmsHttpGatewaySettings interface, see IAdmSendSmsSettings::GatewaySettings

Properties

  • Property

  • Description

  • Url

  • Gets or sets the URL to send HTTP requests to.

  • Method

  • Gets or sets the data transfer method of HTTP requests.

  • Headers

  • Gets or sets headers of HTTP requests.

  • Body

  • Gets or sets the body of HTTP requests.

  • BodyEscaping

  • Gets or sets the type of escaping used when resolving value references in the HTTP request body.

  • SkipResponseParsing

  • Gets or sets a value indicating whether the HTTP response should be parsed for information about errors.

Details

Url

Gets or sets the URL to send HTTP requests to. You can use value references in the URL (e.g. %mobilenumber%, %smstext%). Value references are replaced with corresponding property values of the directory object that represents the recipient.

  • Type:
  • String
  • Access:
  • Read/Write

Method

Gets or sets the data transfer method of HTTP requests.


Headers

Gets or sets headers of HTTP requests. Multiple headers should be separated by line breaks (LF).

  • Type:
  • String
  • Access:
  • Read/Write

Body

Gets or sets the body of HTTP requests. You can use value references in the body (e.g. %mobilenumber%, %smstext%). Value references are replaced with corresponding property values of the directory object that represents the recipient.

  • Type:
  • String
  • Access:
  • Read/Write

BodyEscaping

Gets or sets the type of escaping used when resolving value references in the HTTP request body.

Remarks

This property is ignored if the HTTP header contains a Content-Type entity that sets the escaping type to one of the types specified in the ADM_HTTP2SMSGATEWAYESCAPING_ENUM enumeration.


SkipResponseParsing

Gets or sets a value indicating whether the HTTP response should be parsed for information about errors.

  • Type:
  • Boolean
  • Access:
  • Read/Write

Requirements

Minimum required version: 2017.1

See also