SMS Control

Properties   Methods   Events   Config Settings   Errors  

The SMS control provides an easy way to manage short message service (SMS) messages from a variety of service providers.

Syntax

SMS

Remarks

This control provides a single interface that can be used to work with a variety of services. By supporting multiple providers with a single API code may be written once and used to support multiple services. The following providers are currently supported by this control:

• Twilio
• Sinch
• SMSGlobal
• SMS.to
• Vonage
• Clickatell

The control supports sending, scheduling, deleting, updating, listing, fetching, and more. Note that not all services support all operations. See the Service Provider Specific Notes page for more information.

Selecting a Provider

To specify a service provider simply set the ServiceProvider property. To begin, first create an account and register with the desired service provider(s).

Authentication

Once the account is created, the service provider will provide some form of credentials. Assign the provider account credentials to the corresponding AccountKey and AccountSecret properties. As a note, in some cases, the service provider does not provide or require an account secret.

Sending a Message

The Send method is used to send SMS messages without any delay.

The message details are specified by the MessageFrom, MessageRecipients, and MessageBody properties.

sms.MessageFrom = "+11234567890"; sms.MessageRecipients = "+10987654321"; sms.MessageBody = "This is an SMS message."; string messageId = sms.Send();

Scheduling a Message

Some service providers allow for messages to be scheduled to send at a particular time. The ScheduleMessage method can be used to delay SMS messages from being sent until the specified time.

The message details are specified by the MessageFrom, MessageRecipients, and MessageBody properties. The scheduled time to send is specified by the MessageDate property.

sms.MessageFrom = "+11234567890"; sms.MessageRecipients = "+10987654321"; sms.MessageBody = "This is an SMS message."; sms.MessageDate = "2023-04-10T20:02:39Z"; string messageId = sms.ScheduleMessage();

Deleting a Message

Some service providers also support "deleting" messages from the account. The DeleteSentMessage and DeleteReceivedMessage methods delete an SMS message that was sent or received, respectively. The particular manner in which the message is deleted depends on the service provider. See the service provider documentation for more details.

In order to delete a message, the corresponding message ID must be provided to the method.

sms.MessageFrom = "+11234567890"; sms.MessageRecipients = "+10987654321"; sms.MessageBody = "This is an SMS message."; string id = sms.Send(); // Wait for the message to send before deleting. sms.DeleteSentMessage(id);

Updating a Message

Certain service providers support updating sent messages. The specifics of what values can be updated and when the message is still available to be updated depends on the service provider. The UpdateSentMessage method will update a sent SMS message with the values found in its corresponding Messages* properties entry.

sms.MessageFrom = "+11234567890"; sms.MessageRecipients = "+10987654321"; sms.MessageBody = "This is an SMS message."; string id = sms.Send(); // Wait for the message to send before updating with cleared body text. sms.Messages[0].Body = ""; sms.UpdateSentMessage(id);

Listing Messages

If supported by the service provider, the ListSentMessages and ListReceivedMessages methods list sent and received SMS messages, respectively, present on the authenticated account.

In order to refine which messages are listed, service-specific filters may be supplied. See the service documentation for more information about the parameters that can be added as the filter.

string startTime = DateTime.UtcNow.ToString("yyyy-MM-ddTHH:mm:ssZ"); sms.MessageFrom = "+11234567890"; sms.MessageRecipients = "+10987654321"; sms.MessageBody = "This is an SMS message."; sms.Send(); // Wait for the message to send before listing only the above message by supplying multiple filters. sms.ListSentMessages("To=" + sms.MessageRecipients + "&DateSent>=" + startTime); foreach (SMSMessage message in sms.Messages) { if (message.From.Equals("+11234567890")) { // . . . } }

Fetching a Message

In certain cases, it is useful to fetch a specific message. If supported, the FetchSentMessage and FetchReceivedMessage methods can be used to fetch a specific SMS message that was sent or received, respectively, in the authenticated account.

In order to fetch a message, the corresponding message ID must be supplied.

sms.MessageFrom = "+11234567890"; sms.MessageRecipients = "+10987654321"; sms.MessageBody = "This is an SMS message."; string id = sms.Send(); // Wait for the message to send before fetching. sms.FetchSentMessage(id); if (sms.Messages[0].MessageStatus.Equals("Delivered")) { // . . . }

Property List

The following is the full list of the properties of the control with short descriptions. Click on the links for further details.

Method List

The following is the full list of the methods of the control with short descriptions. Click on the links for further details.

Event List

The following is the full list of the events fired by the control with short descriptions. Click on the links for further details.

Config Settings

The following is a list of config settings for the control with short descriptions. Click on the links for further details.

AccountKey Property (SMS Control)

The account key associated with the service provider account.

Syntax

smscontrol.AccountKey[=string]

Default Value

""

Remarks

This property takes a string that will be used as the account key to connect to the service provider. Service providers have various names for this value in their specific console. Consult the following table to find the typical name for the account key:

Data Type

String

AccountSecret Property (SMS Control)

The account secret associated with the service provider account.

Syntax

smscontrol.AccountSecret[=string]

Default Value

""

Remarks

This property takes a string that will be used as the account secret to connect to the service provider. Service providers have various names for this value in their specific console. Consult the following table to find the typical name for the account secret:

Data Type

String

FirewallAutoDetect Property (SMS Control)

This property tells the control whether or not to automatically detect and use firewall system settings, if available.

Syntax

smscontrol.FirewallAutoDetect[=boolean]

Default Value

False

Remarks

This property tells the control whether or not to automatically detect and use firewall system settings, if available.

Data Type

Boolean

FirewallType Property (SMS Control)

This property determines the type of firewall to connect through.

Syntax

smscontrol.FirewallType[=integer]

Possible Values

fwNone(0), 
fwTunnel(1), 
fwSOCKS4(2), 
fwSOCKS5(3), 
fwSOCKS4A(10)

Default Value

0

Remarks

This property determines the type of firewall to connect through. The applicable values are as follows:

Data Type

Integer

FirewallHost Property (SMS Control)

This property contains the name or IP address of firewall (optional).

Syntax

smscontrol.FirewallHost[=string]

Default Value

""

Remarks

This property contains the name or IP address of firewall (optional). If a FirewallHost is given, the requested connections will be authenticated through the specified firewall when connecting.

If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the control fails with an error.

Data Type

String

FirewallPassword Property (SMS Control)

This property contains a password if authentication is to be used when connecting through the firewall.

Syntax

smscontrol.FirewallPassword[=string]

Default Value

""

Remarks

This property contains a password if authentication is to be used when connecting through the firewall. If FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, the control fails with an error.

Data Type

String

FirewallPort Property (SMS Control)

This property contains the transmission control protocol (TCP) port for the firewall Host .

Syntax

smscontrol.FirewallPort[=integer]

Default Value

0

Remarks

This property contains the transmission control protocol (TCP) port for the firewall FirewallHost. See the description of the FirewallHost property for details.

Note: This property is set automatically when FirewallType is set to a valid value. See the description of the FirewallType property for details.

Data Type

Integer

FirewallUser Property (SMS Control)

This property contains a user name if authentication is to be used connecting through a firewall.

Syntax

smscontrol.FirewallUser[=string]

Default Value

""

Remarks

This property contains a user name if authentication is to be used connecting through a firewall. If the FirewallHost is specified, this property and FirewallPassword properties are used to connect and authenticate to the given Firewall. If the authentication fails, the control fails with an error.

Data Type

String

Idle Property (SMS Control)

The current status of the control.

Syntax

smscontrol.Idle

Default Value

True

Remarks

Idle will be False if the component is currently busy (communicating and/or waiting for an answer), and True at all other times.

This property is read-only.

Data Type

Boolean

MessageBody Property (SMS Control)

The body of the SMS message that will be sent.

Syntax

smscontrol.MessageBody[=string]

Default Value

""

Remarks

This property takes a string that will be used as the body of the SMS message when the Send or ScheduleMessage methods are called. The string passed into this property must obey certain encoding and length requirements depending on the service provider. See the service documentation for more information.

Note: If the message length exceeds the standard 160 characters for 7-bit encoding or 70 characters for Unicode encoding, some service providers will segment the message into multiple SMS messages that will be concatenated for the recipient. Consult the documentation of the individual service provider for how longer SMS messages are processed.

Data Type

String

MessageDate Property (SMS Control)

The date and time when the SMS message will be sent.

Syntax

smscontrol.MessageDate[=string]

Default Value

""

Remarks

This property takes a string that will be used as the date and time when the SMS message will be sent. This property should only be set when the ScheduleMessage method is called.

Depending on the service provider, scheduled SMS messages are subject to certain time restraints:

Example

sms.MessageDate = "1970-01-01T00:00:00Z"; // yyyy-MM-ddTHH:mm:ssZ format

Note: Custom date and time formats can be specified via the DateFormat configuration setting.

Data Type

String

MessageFrom Property (SMS Control)

The sender of the SMS message.

Syntax

smscontrol.MessageFrom[=string]

Default Value

""

Remarks

This property takes a string that will be used as the sender when the Send or ScheduleMessage methods are called. This is typically a phone number.

Service Provider Specific Notes

• Twilio, Sinch, SMS.to, and Vonage all recommend using E.164 formatting for phone numbers, i.e. [+][country code][subscriber number including area code].
  • For example, the U.S. number (415) 555-2671 should be formatted as +14155552671.
• SMSGlobal and Clickatell require a leading '0' or '+' to be removed and replaced with the country code.
  • For example, the Australia number 0447973739 should be formatted as 61447973739.

Twilio

• Not required if using the TwilioMessagingServiceSid configuration setting.

Data Type

String

MessageRecipients Property (SMS Control)

The recipient(s) of the SMS message.

Syntax

smscontrol.MessageRecipients[=string]

Default Value

""

Remarks

This property takes a string that will be used as the recipient(s) when the Send or ScheduleMessage methods are called. This is typically a phone number. To specify multiple recipients, separate each recipient with a ',' character.

Service Provider Specific Notes

• Twilio, Sinch, SMS.to, and Vonage all recommend using E.164 formatting for phone numbers, i.e. [+][country code][subscriber number including area code].
  • For example, the U.S. number (415) 555-2671 should be formatted as +14155552671.
• SMSGlobal and Clickatell require a leading '0' or '+' to be removed and replaced with the country code.
  • For example, the Australia number 0447973739 should be formatted as 61447973739.

Data Type

String

MessagesCount Property (SMS Control)

The number of records in the Messages arrays.

Syntax

smscontrol.MessagesCount

Default Value

0

Remarks

This property controls the size of the following arrays:

• MessagesBody
• MessagesDirection
• MessagesFrom
• MessagesMessageId
• MessagesMessageStatus
• MessagesTo

The array indices start at 0 and end at MessagesCount - 1.

This property is read-only and not available at design time.

Data Type

Integer

MessagesBody Property (SMS Control)

The body content of the message.

Syntax

smscontrol.MessagesBody(MessagesIndex)[=string]

Default Value

""

Remarks

The body content of the message.

The MessagesIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessagesCount property.

This property is not available at design time.

Data Type

String

MessagesDirection Property (SMS Control)

The direction of the message based on the perspective of the account: 0 The message is an outgoing message sent by the account.

Syntax

smscontrol.MessagesDirection(MessagesIndex)

Default Value

0

Remarks

The direction of the message based on the perspective of the account:

The MessagesIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessagesCount property.

This property is read-only and not available at design time.

Data Type

Integer

MessagesFrom Property (SMS Control)

The sender of the message (typically a number).

Syntax

smscontrol.MessagesFrom(MessagesIndex)[=string]

Default Value

""

Remarks

The sender of the message (typically a number).

The MessagesIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessagesCount property.

This property is not available at design time.

Data Type

String

MessagesMessageId Property (SMS Control)

The unique identifier of the message.

Syntax

smscontrol.MessagesMessageId(MessagesIndex)

Default Value

""

Remarks

The unique identifier of the message.

The MessagesIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessagesCount property.

This property is read-only and not available at design time.

Data Type

String

MessagesMessageStatus Property (SMS Control)

The current status of the message.

Syntax

smscontrol.MessagesMessageStatus(MessagesIndex)[=string]

Default Value

""

Remarks

The current status of the message. Possible values vary between service providers.

The MessagesIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessagesCount property.

This property is not available at design time.

Data Type

String

MessagesTo Property (SMS Control)

The recipient(s) of the message (typically numbers).

Syntax

smscontrol.MessagesTo(MessagesIndex)[=string]

Default Value

""

Remarks

The recipient(s) of the message (typically numbers).

The MessagesIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessagesCount property.

This property is not available at design time.

Data Type

String

ProxyAuthScheme Property (SMS Control)

This property is used to tell the control which type of authorization to perform when connecting to the proxy.

Syntax

smscontrol.ProxyAuthScheme[=integer]

Possible Values

authBasic(0), 
authDigest(1), 
authProprietary(2), 
authNone(3), 
authNtlm(4), 
authNegotiate(5)

Default Value

0

Remarks

This property is used to tell the control which type of authorization to perform when connecting to the proxy. This is used only when the ProxyUser and ProxyPassword properties are set.

ProxyAuthScheme should be set to authNone (3) when no authentication is expected.

By default, ProxyAuthScheme is authBasic (0), and if the ProxyUser and ProxyPassword properties are set, the component will attempt basic authentication.

If ProxyAuthScheme is set to authDigest (1), digest authentication will be attempted instead.

If ProxyAuthScheme is set to authProprietary (2), then the authorization token will not be generated by the control. Look at the configuration file for the control being used to find more information about manually setting this token.

If ProxyAuthScheme is set to authNtlm (4), NTLM authentication will be used.

For security reasons, setting this property will clear the values of ProxyUser and ProxyPassword.

Data Type

Integer

ProxyAutoDetect Property (SMS Control)

This property tells the control whether or not to automatically detect and use proxy system settings, if available.

Syntax

smscontrol.ProxyAutoDetect[=boolean]

Default Value

False

Remarks

This property tells the control whether or not to automatically detect and use proxy system settings, if available. The default value is .

Data Type

Boolean

ProxyPassword Property (SMS Control)

This property contains a password if authentication is to be used for the proxy.

Syntax

smscontrol.ProxyPassword[=string]

Default Value

""

Remarks

This property contains a password if authentication is to be used for the proxy.

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

ProxyPort Property (SMS Control)

This property contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80).

Syntax

smscontrol.ProxyPort[=integer]

Default Value

80

Remarks

This property contains the Transmission Control Protocol (TCP) port for the proxy ProxyServer (default 80). See the description of the ProxyServer property for details.

Data Type

Integer

ProxyServer Property (SMS Control)

If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

Syntax

smscontrol.ProxyServer[=string]

Default Value

""

Remarks

If a proxy ProxyServer is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

If the ProxyServer property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the ProxyServer property is set to the corresponding address. If the search is not successful, an error is returned.

Data Type

String

ProxySSL Property (SMS Control)

This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy.

Syntax

smscontrol.ProxySSL[=integer]

Possible Values

psAutomatic(0), 
psAlways(1), 
psNever(2), 
psTunnel(3)

Default Value

0

Remarks

This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows:

Data Type

Integer

ProxyUser Property (SMS Control)

This property contains a user name, if authentication is to be used for the proxy.

Syntax

smscontrol.ProxyUser[=string]

Default Value

""

Remarks

This property contains a username if authentication is to be used for the proxy.

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

QueryParamCount Property (SMS Control)

The number of records in the QueryParam arrays.

Syntax

smscontrol.QueryParamCount[=integer]

Default Value

0

Remarks

This property controls the size of the following arrays:

• QueryParamName
• QueryParamValue

The array indices start at 0 and end at QueryParamCount - 1.

This property is not available at design time.

Data Type

Integer

QueryParamName Property (SMS Control)

The name of the query parameter.

Syntax

smscontrol.QueryParamName(QueryParamIndex)[=string]

Default Value

""

Remarks

The name of the query parameter.

This property specifies the name of the query parameter.

The QueryParamIndex parameter specifies the index of the item in the array. The size of the array is controlled by the QueryParamCount property.

This property is not available at design time.

Data Type

String

QueryParamValue Property (SMS Control)

The value of the query parameter.

Syntax

smscontrol.QueryParamValue(QueryParamIndex)[=string]

Default Value

""

Remarks

The value of the query parameter.

This property specifies the value of the query parameter. The control will automatically URL-encode this value when sending the request.

The QueryParamIndex parameter specifies the index of the item in the array. The size of the array is controlled by the QueryParamCount property.

This property is not available at design time.

Data Type

String

ServiceProvider Property (SMS Control)

The service provider to use.

Syntax

smscontrol.ServiceProvider[=integer]

Possible Values

spTwilio(0), 
spSinch(1), 
spSMSGlobal(2), 
spSMSto(3), 
spVonage(4), 
spClickatell(5)

Default Value

0

Remarks

This property specifies the service provider to use. The currently supported service providers are Twilio, Sinch, SMSGlobal, SMS.to, Vonage, and Clickatell.

This property is not available at design time.

Data Type

Integer

SSLAcceptServerCertEncoded Property (SMS Control)

This is the certificate (PEM/base64 encoded).

Syntax

smscontrol.SSLAcceptServerCertEncoded[=string]

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLAcceptServerCertStore and SSLAcceptServerCertSubject properties also may be used to specify a certificate.

When SSLAcceptServerCertEncoded is set, a search is initiated in the current SSLAcceptServerCertStore for the private key of the certificate. If the key is found, SSLAcceptServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLAcceptServerCertSubject is set to an empty string.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLAcceptServerCertEncodedB.

This property is not available at design time.

Data Type

Binary String

SSLCertEncoded Property (SMS Control)

This is the certificate (PEM/base64 encoded).

Syntax

smscontrol.SSLCertEncoded[=string]

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.

When SSLCertEncoded is set, a search is initiated in the current SSLCertStore for the private key of the certificate. If the key is found, SSLCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLCertSubject is set to an empty string.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLCertEncodedB.

This property is not available at design time.

Data Type

Binary String

SSLCertStore Property (SMS Control)

This is the name of the certificate store for the client certificate.

Syntax

smscontrol.SSLCertStore[=string]

Default Value

"MY"

Remarks

This is the name of the certificate store for the client certificate.

The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password protected, specify the password in SSLCertStorePassword.

SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLCertStoreB.

Data Type

Binary String

SSLCertStorePassword Property (SMS Control)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

smscontrol.SSLCertStorePassword[=string]

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

SSLCertStoreType Property (SMS Control)

This is the type of certificate store for this certificate.

Syntax

smscontrol.SSLCertStoreType[=integer]

Possible Values

cstUser(0), 
cstMachine(1), 
cstPFXFile(2), 
cstPFXBlob(3), 
cstJKSFile(4), 
cstJKSBlob(5), 
cstPEMKeyFile(6), 
cstPEMKeyBlob(7), 
cstPublicKeyFile(8), 
cstPublicKeyBlob(9), 
cstSSHPublicKeyBlob(10), 
cstP7BFile(11), 
cstP7BBlob(12), 
cstSSHPublicKeyFile(13), 
cstPPKFile(14), 
cstPPKBlob(15), 
cstXMLFile(16), 
cstXMLBlob(17), 
cstJWKFile(18), 
cstJWKBlob(19), 
cstSecurityKey(20), 
cstBCFKSFile(21), 
cstBCFKSBlob(22), 
cstPKCS11(23), 
cstAuto(99)

Default Value

0

Remarks

This is the type of certificate store for this certificate.

The control supports both public and private keys in a variety of formats. When the cstAuto value is used, the control will automatically determine the type. This property can take one of the following values:

Data Type

Integer

SSLCertSubject Property (SMS Control)

This is the subject of the certificate used for client authentication.

Syntax

smscontrol.SSLCertSubject[=string]

Default Value

""

Remarks

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

SSLProvider Property (SMS Control)

This specifies the SSL/TLS implementation to use.

Syntax

smscontrol.SSLProvider[=integer]

Possible Values

sslpAutomatic(0), 
sslpPlatform(1), 
sslpInternal(2)

Default Value

0

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic) the control will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are:

In most cases using the default value (Automatic) is recommended. The control will select a provider depending on the current platform.

When Automatic is selected the platform implementation is used by default. When TLS 1.3 is enabled via SSLEnabledProtocols the internal implementation is used.

Data Type

Integer

SSLServerCertEncoded Property (SMS Control)

This is the certificate (PEM/base64 encoded).

Syntax

smscontrol.SSLServerCertEncoded

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLServerCertStore and SSLServerCertSubject properties also may be used to specify a certificate.

When SSLServerCertEncoded is set, a search is initiated in the current SSLServerCertStore for the private key of the certificate. If the key is found, SSLServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLServerCertSubject is set to an empty string.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLServerCertEncodedB.

This property is read-only and not available at design time.

Data Type

Binary String

AddQueryParam Method (SMS Control)

Adds a query parameter to the QueryParams properties.

Syntax

smscontrol.AddQueryParam Name, Value

Remarks

This method is used to add a query parameter to the QueryParam* properties. Name specifies the name of the parameter, and Value specifies the value of the parameter.

All specified Values will be URL encoded by the control automatically. Consult the service documentation for details on the available parameters.

For example, this method can be used to limit how many messages are returned when listing: // The PageSize parameter shown here is a Twilio parameter. sms.AddQueryParam("PageSize", "20"); sms.ListSentMessages(""); // The service now returns 20 messages rather than the default.

Config Method (SMS Control)

Sets or retrieves a configuration setting.

Syntax

smscontrol.Config ConfigurationString

Remarks

Config is a generic method available in every control. It is used to set and retrieve configuration settings for the control.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the control, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

DeleteReceivedMessage Method (SMS Control)

Deletes a received message from the account.

Syntax

smscontrol.DeleteReceivedMessage MessageId

Remarks

Note: This method is not supported by spSinch and spClickatell.

This method is used to remove a received message from the account. MessageId identifies the particular message to delete.

Service Provider Specific Notes

Twilio

• There is no distinction between calling send and receive variants of operations due to the fact that this service does not have separate endpoints for the two.

DeleteSentMessage Method (SMS Control)

Deletes a sent message from the account.

Syntax

smscontrol.DeleteSentMessage MessageId

Remarks

Note: This method is not supported by spClickatell.

This method is used to remove a sent message from the account. MessageId identifies the particular message to delete.

Service Provider Specific Notes

Twilio

• There is no distinction between calling send and receive variants of operations due to the fact that this service does not have separate endpoints for the two.

Sinch

• This method cancels rather than deletes and can also be used on a scheduled message.

DoEvents Method (SMS Control)

Processes events from the internal message queue.

Syntax

smscontrol.DoEvents 

Remarks

When DoEvents is called, the control processes any available events. If no events are available, it waits for a preset period of time, and then returns.

FetchReceivedMessage Method (SMS Control)

Fetches a received message from the account.

Syntax

smscontrol.FetchReceivedMessage MessageId

Remarks

Note: This method is not supported by spSMSto, spVonage, and spClickatell.

This method is used to retrieve a specific message received by the account, populating the Message* properties. MessageId identifies the particular message to fetch.

For example, this method can be used to access various pieces of information pertaining to the message: // Fetch a particular message with its ID. sms.FetchReceivedMessage(messageId); // Access message details. if (sms.Messages[0].From == "+11234567890" && sms.Messages[0].MessageStatus == "received") { // . . . }

Service Provider Specific Notes

Twilio

• There is no distinction between calling send and receive variants of operations due to the fact that this service does not have separate endpoints for the two.

FetchSentMessage Method (SMS Control)

Fetches a message sent from the account.

Syntax

smscontrol.FetchSentMessage MessageId

Remarks

Note: This method is not supported by spVonage and spClickatell.

This method is used to retrieve a specific message sent from the account, populating the Message* properties. MessageId identifies the particular message to fetch.

For example, this method can be used to access various pieces of information pertaining to the message: // Fetch a particular message with its ID. sms.FetchSentMessage(messageId); // Access message details. if (sms.Messages[0].To == "+10987654321" && sms.Messages[0].MessageStatus == "delivered") { // . . . }

Service Provider Specific Notes

Twilio

• There is no distinction between calling send and receive variants of operations due to the fact that this service does not have separate endpoints for the two.

HandleWebhook Method (SMS Control)

Parses requests made to a web-hook.

Syntax

smscontrol.HandleWebhook HeaderString, QueryString, PostData

Remarks

This method takes the HeaderString, QueryString, and PostData to parse the callback request that was made to a web server. Service providers typically support two types of callback endpoints.

The first callback endpoint, delivery reports, give status updates on sent messages. When the method handles these requests, the control will fire the DeliveryReport event.

The second callback endpoint, incoming messages, will fire a request to the web-hook when a new incoming message arrives. When the method handles these requests, the control will fire the IncomingMessage event.

It is important to note that the control will not handle creating the web server to host the web-hook that is specified. The method is intended to be used as a helper method for interpreting the request made to the web-hook.

Interrupt Method (SMS Control)

Interrupt the current method.

Syntax

smscontrol.Interrupt 

Remarks

If there is no method in progress, Interrupt simply returns, doing nothing.

ListReceivedMessages Method (SMS Control)

Lists received messages from the account.

Syntax

smscontrol.ListReceivedMessages Filter

Remarks

Note: This method is not supported by spVonage and spClickatell.

This method is used to list messages received by the account, populating the Message* properties and firing the MessageList event. Filter allows for further control when listing.

For example, this method can be used to list only messages received during a specific timeframe: // The DateSent filter shown here is an available Twilio filter. sms.ListReceivedMessages("DateSent>=2023-04-14T16:48:39Z&DateSent<=2023-04-14T16:58:39Z"); // The service now returns only messages that were received within the 10 minute window. foreach (SMSMessage message in sms.Messages) { string sender = message.From; string to = message.To; string body = message.Body; string id = message.MessageId; }

Service Provider Specific Notes

Twilio

• There is no distinction between calling send and receive variants of operations due to the fact that this service does not have separate endpoints for the two.

ListSentMessages Method (SMS Control)

Lists messages sent from the account.

Syntax

smscontrol.ListSentMessages Filter

Remarks

Note: This method is not supported by spVonage and spClickatell.

This method is used to list messages sent from the account, populating the Message* properties and firing the MessageList event. Filter allows for further control when listing.

For example, this method can be used to list only messages sent during a specific timeframe: // The DateSent filter shown here is an available Twilio filter. sms.ListSentMessages("DateSent>=2023-04-14T16:48:39Z&DateSent<=2023-04-14T16:58:39Z"); // The service now returns only messages that were sent within the 10 minute window. foreach (SMSMessage message in sms.Messages) { string sender = message.From; string to = message.To; string body = message.Body; string id = message.MessageId; }

Service Provider Specific Notes

Twilio

• There is no distinction between calling send and receive variants of operations due to the fact that this service does not have separate endpoints for the two.

Reset Method (SMS Control)

Reset the control.

Syntax

smscontrol.Reset 

Remarks

This method will reset the control's properties to their default values.

ScheduleMessage Method (SMS Control)

Schedules a message to be sent.

Syntax

smscontrol.ScheduleMessage 

Remarks

Note: This method is not supported by spVonage.

This method uses the values from MessageBody, MessageFrom, MessageRecipients, and MessageDate. For more information about the restrictions of these specific values, see their specific documentation.

sms.MessageFrom = "+11234567890"; sms.MessageRecipients = "+10987654321"; sms.MessageBody = "This is an SMS message."; sms.MessageDate = "2023-04-10T20:02:39Z"; string messageId = sms.ScheduleMessage();

Service Provider Specific Notes

Twilio

• Twilio requires the use of messaging services for scheduling messages.
  • To use a messaging service set the TwilioMessagingServiceSid configuration setting.
  • It is not required to set the MessageFrom to a specific number.
• Twilio also requires a message must be scheduled at least 15 minutes in advance of the message send time and cannot be scheduled more than 7 days in advance of the request.

Sinch

• When WebhookURL is set to a valid URL, the delivery_report parameter will be set to "summary".
• If MessageDate is set to a value representing a time in the future, the message will be delayed until the time occurs.
• If MessageDate is set to a value representing a time in the past, messages will be sent immediately.

SMS Global

• Uses a different ID for the message when it is scheduled versus when it is sent.
  • The scheduled ID can be used with the FetchSentMessage method to get the real ID once the message is sent.

SMS.to

• SMS.to allows for different types of modes when sending messages such as campaigns and flash SMS messages.
  • See SMStoMessageType for more information.
• SMS.to also allows for a specific timezone to be used.
  • See SMStoTimezone for more information.

Clickatell

• Does not support the use of WebhookURL for setting a specific callback URL for the message.

Send Method (SMS Control)

Sends an SMS message.

Syntax

smscontrol.Send 

Remarks

This method uses the values from MessageBody, MessageFrom, and MessageRecipients. For restrictions on the values, see their documentation for more information.

sms.MessageFrom = "+11234567890"; sms.MessageRecipients = "+10987654321"; sms.MessageBody = "This is an SMS message."; string messageId = sms.Send();

Service Provider Specific Notes

Twilio

• Twilio allows for the use of messaging services instead of setting the From to a specific number.
  • To use a messaging service set the TwilioMessagingServiceSid configuration setting.

Sinch

• When WebhookURL is set to a valid URL, the delivery_report parameter will be set to "summary".

SMS.to

• SMS.to allows for different types of modes when sending messages such as campaigns and flash SMS messages.
  • See SMStoMessageType for more information.
• SMS.to also allows for a specific timezone to be used.
  • See SMStoTimezone for more information.

Vonage

• Vonage allows for both ASCII and Unicode messages to be sent.
  • See VonageMessageBodyType for more information.
• Does not support the use of WebhookURL for setting a specific callback URL for the message.

Clickatell

• Does not support the use of WebhookURL for setting a specific callback URL for the message.

UpdateSentMessage Method (SMS Control)

Updates a scheduled or sent message.

Syntax

smscontrol.UpdateSentMessage MessageId

Remarks

Note: Only spTwilio and spSinch support updating sent or schedule messages.

This method takes the MessageId of the message that is being updated. To update a message, a message must be present in the Message* properties with a matching . There are a number of ways to populate messages into the properties. The Send and ScheduleMessage methods will populate the Message* properties using the response from the service provider. The FetchSentMessage and ListSentMessages methods can be used to populate already sent messages from the service provider directly. Another option is to create a new entry in the Message* properties and set the property to the specific MessageId. Once the message is populated in the Message* properties, you can change the properties depending on the value of the ServiceProvider.

sms.MessageFrom = "+11234567890"; sms.MessageRecipients = "+10987654321"; sms.MessageBody = "This is an SMS message."; string id = sms.Send(); // Wait for the message to send before updating with cleared body text. sms.Messages[0].Body = ""; sms.UpdateSentMessage(id);

Service Provider Specific Notes

Twilio

• This method can only be used to redact the message by setting the to an empty string or cancel a message by updating the .

Sinch

• This method can be used to update the , , and values of the message.

DeliveryReport Event (SMS Control)

Fired once for each delivery report.

Syntax

Sub smscontrol_DeliveryReport(MessageId As String, Status As String)

Remarks

This event fires once for each delivery report parsed by the HandleWebhook method. The MessageId corresponds to the message ID of the message that was sent. Typically, the MessageId will correlate to the MessageId that is provided from the ScheduleMessage and Send methods. The Status parameter is the parsed status from the delivery report.

Service Provider Specific Notes

SMS Global

• Uses a different ID for the message when it is scheduled versus when it is sent.
  • The scheduled ID can be used with the FetchSentMessage method to get the real ID once the message is sent.

Error Event (SMS Control)

Information about errors during data delivery.

Syntax

Sub smscontrol_Error(ErrorCode As Integer, Description As String)

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the control fails with an error.

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

IncomingMessage Event (SMS Control)

Fired once for each incoming message.

Syntax

Sub smscontrol_IncomingMessage(MessageId As String, SentTo As String, From As String, Body As String)

Remarks

This event fires once for each incoming message parsed by the HandleWebhook method. The MessageId corresponds to the message ID of the message that was received. If supported, the MessageId can be used with the DeleteReceivedMessage, FetchReceivedMessage, and ListReceivedMessages methods. See the specific method documentation for more information.

The SentTo parameter is the ID (typically a number) that the message was sent to. The From parameter is the sender ID (typically a number) that the message was sent from. The Body parameter is the text content of the message that was sent.

Log Event (SMS Control)

This event fires once for each log message.

Syntax

Sub smscontrol_Log(LogLevel As Integer, Message As String, LogType As String)

Remarks

This event fires once for each log message generated by the control. The verbosity is controlled by the LogLevel setting.

LogLevel indicates the level of message. Possible values are as follows:

The value 1 (Info) logs basic information, including the URL, HTTP version, and status details.

The value 2 (Verbose) logs additional information about the request and response.

The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any).

Message is the log entry.

LogType identifies the type of log entry. Possible values are as follows:

• "Info"
• "RequestHeaders"
• "ResponseHeaders"
• "RequestBody"
• "ResponseBody"
• "ProxyRequest"
• "ProxyResponse"
• "FirewallRequest"
• "FirewallResponse"

MessageList Event (SMS Control)

Fired once for each listed message.

Syntax

Sub smscontrol_MessageList(MessageId As String, Direction As Integer, SentTo As String, From As String, MessageStatus As String, Body As String)

Remarks

This event fires once for each listed message after calling the ListSentMessages and ListReceivedMessages methods, providing access to more information about each message listed by the control.

The MessageId corresponds to the message ID of the listed message, which can be used to perform other operations that are supported by the service.

Direction identifies the originator of the listed message:

SentTo is the ID (typically a number) that the message was sent to.

From is the sender ID (typically a number) that the message was sent from.

MessageStatus shows the current status of the listed message. Possible values vary between service providers.

Body is the text content of the listed message.

SSLServerAuthentication Event (SMS Control)

Fired after the server presents its certificate to the client.

Syntax

Sub smscontrol_SSLServerAuthentication(CertEncoded As String, CertSubject As String, CertIssuer As String, Status As String, Accept As Boolean)

Remarks

During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

SSLStatus Event (SMS Control)

Shows the progress of the secure connection.

Syntax

Sub smscontrol_SSLStatus(Message As String)

Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

Config Settings (SMS Control)

SMS Config Settings

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

Socket Config Settings

Base Config Settings

Trappable Errors (SMS Control)

SMS Errors

The control may also return one of the following error codes, which are inherited from other controls.

HTTP Errors

The control may also return one of the following error codes, which are inherited from other controls.

TCPClient Errors

SSL Errors

TCP/IP Errors