SMS Class

Properties   Methods   Events   Config Settings   Errors  

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

Class Name

CloudSMS_SMS

Procedural Interface

 cloudsms_sms_open();
 cloudsms_sms_close($res);
 cloudsms_sms_register_callback($res, $id, $function);
 cloudsms_sms_get_last_error($res);
 cloudsms_sms_get_last_error_code($res);
 cloudsms_sms_set($res, $id, $index, $value);
 cloudsms_sms_get($res, $id, $index);
 cloudsms_sms_do_addqueryparam($res, $name, $value);
 cloudsms_sms_do_config($res, $configurationstring);
 cloudsms_sms_do_deletereceivedmessage($res, $messageid);
 cloudsms_sms_do_deletesentmessage($res, $messageid);
 cloudsms_sms_do_doevents($res);
 cloudsms_sms_do_handlewebhook($res, $headerstring, $querystring, $postdata);
 cloudsms_sms_do_interrupt($res);
 cloudsms_sms_do_listreceivedmessages($res, $filter);
 cloudsms_sms_do_listsentmessages($res, $filter);
 cloudsms_sms_do_reset($res);
 cloudsms_sms_do_retrievereceivedmessage($res, $messageid);
 cloudsms_sms_do_retrievesentmessage($res, $messageid);
 cloudsms_sms_do_schedulemessage($res);
 cloudsms_sms_do_send($res);
 cloudsms_sms_do_updatesentmessage($res, $messageid);

Remarks

This class 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 class:

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

The class 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 RetrieveSentMessage and RetrieveReceivedMessage 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 class with short descriptions. Click on the links for further details.

Method List

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

Event List

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

Config Settings

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

AccountKey Property (CloudSMS_SMS Class)

The account key associated with the service provider account.

Object Oriented Interface

public function getAccountKey();
public function setAccountKey($value);

Procedural Interface

cloudsms_sms_get($res, 1 );
cloudsms_sms_set($res, 1, $value );

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 (CloudSMS_SMS Class)

The account secret associated with the service provider account.

Object Oriented Interface

public function getAccountSecret();
public function setAccountSecret($value);

Procedural Interface

cloudsms_sms_get($res, 2 );
cloudsms_sms_set($res, 2, $value );

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 (CloudSMS_SMS Class)

Whether to automatically detect and use firewall system settings, if available.

Object Oriented Interface

public function getFirewallAutoDetect();
public function setFirewallAutoDetect($value);

Procedural Interface

cloudsms_sms_get($res, 3 );
cloudsms_sms_set($res, 3, $value );

Default Value

false

Remarks

Whether to automatically detect and use firewall system settings, if available.

Data Type

Boolean

FirewallType Property (CloudSMS_SMS Class)

The type of firewall to connect through.

Object Oriented Interface

public function getFirewallType();
public function setFirewallType($value);

Procedural Interface

cloudsms_sms_get($res, 4 );
cloudsms_sms_set($res, 4, $value );

Default Value

0

Remarks

The type of firewall to connect through. The applicable values are as follows:

Data Type

Integer

FirewallHost Property (CloudSMS_SMS Class)

The name or IP address of the firewall (optional).

Object Oriented Interface

public function getFirewallHost();
public function setFirewallHost($value);

Procedural Interface

cloudsms_sms_get($res, 5 );
cloudsms_sms_set($res, 5, $value );

Default Value

''

Remarks

The name or IP address of the 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 class fails with an error.

Data Type

String

FirewallPassword Property (CloudSMS_SMS Class)

A password if authentication is to be used when connecting through the firewall.

Object Oriented Interface

public function getFirewallPassword();
public function setFirewallPassword($value);

Procedural Interface

cloudsms_sms_get($res, 6 );
cloudsms_sms_set($res, 6, $value );

Default Value

''

Remarks

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 class fails with an error.

Data Type

String

FirewallPort Property (CloudSMS_SMS Class)

The Transmission Control Protocol (TCP) port for the firewall Host .

Object Oriented Interface

public function getFirewallPort();
public function setFirewallPort($value);

Procedural Interface

cloudsms_sms_get($res, 7 );
cloudsms_sms_set($res, 7, $value );

Default Value

0

Remarks

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 (CloudSMS_SMS Class)

A username if authentication is to be used when connecting through a firewall.

Object Oriented Interface

public function getFirewallUser();
public function setFirewallUser($value);

Procedural Interface

cloudsms_sms_get($res, 8 );
cloudsms_sms_set($res, 8, $value );

Default Value

''

Remarks

A username if authentication is to be used when connecting through a firewall. If FirewallHost is specified, this property and the FirewallPassword property are used to connect and authenticate to the given Firewall. If the authentication fails, the class fails with an error.

Data Type

String

Idle Property (CloudSMS_SMS Class)

The current status of the class.

Object Oriented Interface

public function getIdle();

Procedural Interface

cloudsms_sms_get($res, 9 );

Default Value

true

Remarks

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

This property is read-only.

Data Type

Boolean

MessageBody Property (CloudSMS_SMS Class)

The body of the SMS message that will be sent.

Object Oriented Interface

public function getMessageBody();
public function setMessageBody($value);

Procedural Interface

cloudsms_sms_get($res, 10 );
cloudsms_sms_set($res, 10, $value );

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 (CloudSMS_SMS Class)

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

Object Oriented Interface

public function getMessageDate();
public function setMessageDate($value);

Procedural Interface

cloudsms_sms_get($res, 11 );
cloudsms_sms_set($res, 11, $value );

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 (CloudSMS_SMS Class)

The sender of the SMS message.

Object Oriented Interface

public function getMessageFrom();
public function setMessageFrom($value);

Procedural Interface

cloudsms_sms_get($res, 12 );
cloudsms_sms_set($res, 12, $value );

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 (CloudSMS_SMS Class)

The recipient(s) of the SMS message.

Object Oriented Interface

public function getMessageRecipients();
public function setMessageRecipients($value);

Procedural Interface

cloudsms_sms_get($res, 13 );
cloudsms_sms_set($res, 13, $value );

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 (CloudSMS_SMS Class)

The number of records in the Messages arrays.

Object Oriented Interface

public function getMessagesCount();

Procedural Interface

cloudsms_sms_get($res, 14 );

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 (CloudSMS_SMS Class)

The body content of the message.

Object Oriented Interface

public function getMessagesBody($messagesindex);
public function setMessagesBody($messagesindex, $value);

Procedural Interface

cloudsms_sms_get($res, 15 , $messagesindex);
cloudsms_sms_set($res, 15, $value , $messagesindex);

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 (CloudSMS_SMS Class)

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

Object Oriented Interface

public function getMessagesDirection($messagesindex);

Procedural Interface

cloudsms_sms_get($res, 16 , $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 (CloudSMS_SMS Class)

The sender of the message (typically a number).

Object Oriented Interface

public function getMessagesFrom($messagesindex);
public function setMessagesFrom($messagesindex, $value);

Procedural Interface

cloudsms_sms_get($res, 17 , $messagesindex);
cloudsms_sms_set($res, 17, $value , $messagesindex);

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 (CloudSMS_SMS Class)

The unique identifier of the message.

Object Oriented Interface

public function getMessagesMessageId($messagesindex);

Procedural Interface

cloudsms_sms_get($res, 18 , $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 (CloudSMS_SMS Class)

The current status of the message.

Object Oriented Interface

public function getMessagesMessageStatus($messagesindex);
public function setMessagesMessageStatus($messagesindex, $value);

Procedural Interface

cloudsms_sms_get($res, 19 , $messagesindex);
cloudsms_sms_set($res, 19, $value , $messagesindex);

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 (CloudSMS_SMS Class)

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

Object Oriented Interface

public function getMessagesTo($messagesindex);
public function setMessagesTo($messagesindex, $value);

Procedural Interface

cloudsms_sms_get($res, 20 , $messagesindex);
cloudsms_sms_set($res, 20, $value , $messagesindex);

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 (CloudSMS_SMS Class)

The type of authorization to perform when connecting to the proxy.

Object Oriented Interface

public function getProxyAuthScheme();
public function setProxyAuthScheme($value);

Procedural Interface

cloudsms_sms_get($res, 21 );
cloudsms_sms_set($res, 21, $value );

Default Value

0

Remarks

The 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 class 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 class. Look at the configuration file for the class 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 (CloudSMS_SMS Class)

Whether to automatically detect and use proxy system settings, if available.

Object Oriented Interface

public function getProxyAutoDetect();
public function setProxyAutoDetect($value);

Procedural Interface

cloudsms_sms_get($res, 22 );
cloudsms_sms_set($res, 22, $value );

Default Value

false

Remarks

Whether to automatically detect and use proxy system settings, if available. The default value is false.

Data Type

Boolean

ProxyPassword Property (CloudSMS_SMS Class)

A password if authentication is to be used for the proxy.

Object Oriented Interface

public function getProxyPassword();
public function setProxyPassword($value);

Procedural Interface

cloudsms_sms_get($res, 23 );
cloudsms_sms_set($res, 23, $value );

Default Value

''

Remarks

A password 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

ProxyPort Property (CloudSMS_SMS Class)

The Transmission Control Protocol (TCP) port for the proxy Server (default 80).

Object Oriented Interface

public function getProxyPort();
public function setProxyPort($value);

Procedural Interface

cloudsms_sms_get($res, 24 );
cloudsms_sms_set($res, 24, $value );

Default Value

80

Remarks

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 (CloudSMS_SMS Class)

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

Object Oriented Interface

public function getProxyServer();
public function setProxyServer($value);

Procedural Interface

cloudsms_sms_get($res, 25 );
cloudsms_sms_set($res, 25, $value );

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 (CloudSMS_SMS Class)

When to use a Secure Sockets Layer (SSL) for the connection to the proxy.

Object Oriented Interface

public function getProxySSL();
public function setProxySSL($value);

Procedural Interface

cloudsms_sms_get($res, 26 );
cloudsms_sms_set($res, 26, $value );

Default Value

0

Remarks

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 (CloudSMS_SMS Class)

A username if authentication is to be used for the proxy.

Object Oriented Interface

public function getProxyUser();
public function setProxyUser($value);

Procedural Interface

cloudsms_sms_get($res, 27 );
cloudsms_sms_set($res, 27, $value );

Default Value

''

Remarks

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 (CloudSMS_SMS Class)

The number of records in the QueryParam arrays.

Object Oriented Interface

public function getQueryParamCount();
public function setQueryParamCount($value);

Procedural Interface

cloudsms_sms_get($res, 28 );
cloudsms_sms_set($res, 28, $value );

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 (CloudSMS_SMS Class)

The name of the query parameter.

Object Oriented Interface

public function getQueryParamName($queryparamindex);
public function setQueryParamName($queryparamindex, $value);

Procedural Interface

cloudsms_sms_get($res, 29 , $queryparamindex);
cloudsms_sms_set($res, 29, $value , $queryparamindex);

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 (CloudSMS_SMS Class)

The value of the query parameter.

Object Oriented Interface

public function getQueryParamValue($queryparamindex);
public function setQueryParamValue($queryparamindex, $value);

Procedural Interface

cloudsms_sms_get($res, 30 , $queryparamindex);
cloudsms_sms_set($res, 30, $value , $queryparamindex);

Default Value

''

Remarks

The value of the query parameter.

This property specifies the value of the query parameter. The class 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 (CloudSMS_SMS Class)

The service provider to use.

Object Oriented Interface

public function getServiceProvider();
public function setServiceProvider($value);

Procedural Interface

cloudsms_sms_get($res, 31 );
cloudsms_sms_set($res, 31, $value );

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

SSLAcceptServerCertEffectiveDate Property (CloudSMS_SMS Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLAcceptServerCertEffectiveDate();

Procedural Interface

cloudsms_sms_get($res, 32 );

Default Value

''

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLAcceptServerCertExpirationDate Property (CloudSMS_SMS Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSLAcceptServerCertExpirationDate();

Procedural Interface

cloudsms_sms_get($res, 33 );

Default Value

''

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLAcceptServerCertExtendedKeyUsage Property (CloudSMS_SMS Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLAcceptServerCertExtendedKeyUsage();

Procedural Interface

cloudsms_sms_get($res, 34 );

Default Value

''

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprint Property (CloudSMS_SMS Class)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertFingerprint();

Procedural Interface

cloudsms_sms_get($res, 35 );

Default Value

''

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprintSHA1 Property (CloudSMS_SMS Class)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertFingerprintSHA1();

Procedural Interface

cloudsms_sms_get($res, 36 );

Default Value

''

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprintSHA256 Property (CloudSMS_SMS Class)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertFingerprintSHA256();

Procedural Interface

cloudsms_sms_get($res, 37 );

Default Value

''

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSLAcceptServerCertIssuer Property (CloudSMS_SMS Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertIssuer();

Procedural Interface

cloudsms_sms_get($res, 38 );

Default Value

''

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSLAcceptServerCertPrivateKey Property (CloudSMS_SMS Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKey();

Procedural Interface

cloudsms_sms_get($res, 39 );

Default Value

''

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SSLAcceptServerCertPrivateKey may be available but not exportable. In this case, SSLAcceptServerCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLAcceptServerCertPrivateKeyAvailable Property (CloudSMS_SMS Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKeyAvailable();

Procedural Interface

cloudsms_sms_get($res, 40 );

Default Value

false

Remarks

Whether a SSLAcceptServerCertPrivateKey is available for the selected certificate. If SSLAcceptServerCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLAcceptServerCertPrivateKeyContainer Property (CloudSMS_SMS Class)

The name of the PrivateKey container for the certificate (if available).

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKeyContainer();

Procedural Interface

cloudsms_sms_get($res, 41 );

Default Value

''

Remarks

The name of the SSLAcceptServerCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKey Property (CloudSMS_SMS Class)

The public key of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertPublicKey();

Procedural Interface

cloudsms_sms_get($res, 42 );

Default Value

''

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKeyAlgorithm Property (CloudSMS_SMS Class)

The textual description of the certificate's public key algorithm.

Object Oriented Interface

public function getSSLAcceptServerCertPublicKeyAlgorithm();

Procedural Interface

cloudsms_sms_get($res, 43 );

Default Value

''

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKeyLength Property (CloudSMS_SMS Class)

The length of the certificate's public key (in bits).

Object Oriented Interface

public function getSSLAcceptServerCertPublicKeyLength();

Procedural Interface

cloudsms_sms_get($res, 44 );

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SSLAcceptServerCertSerialNumber Property (CloudSMS_SMS Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLAcceptServerCertSerialNumber();

Procedural Interface

cloudsms_sms_get($res, 45 );

Default Value

''

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SSLAcceptServerCertSignatureAlgorithm Property (CloudSMS_SMS Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLAcceptServerCertSignatureAlgorithm();

Procedural Interface

cloudsms_sms_get($res, 46 );

Default Value

''

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLAcceptServerCertStore Property (CloudSMS_SMS Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLAcceptServerCertStore();
public function setSSLAcceptServerCertStore($value);

Procedural Interface

cloudsms_sms_get($res, 47 );
cloudsms_sms_set($res, 47, $value );

Default Value

'MY'

Remarks

The name of the certificate store for the client certificate.

The SSLAcceptServerCertStoreType property denotes the type of the certificate store specified by SSLAcceptServerCertStore. If the store is password-protected, specify the password in SSLAcceptServerCertStorePassword.

SSLAcceptServerCertStore is used in conjunction with the SSLAcceptServerCertSubject property to specify client certificates. If SSLAcceptServerCertStore has a value, and SSLAcceptServerCertSubject or SSLAcceptServerCertEncoded is set, a search for a certificate is initiated. Please see the SSLAcceptServerCertSubject 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 cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Binary String

SSLAcceptServerCertStorePassword Property (CloudSMS_SMS Class)

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

Object Oriented Interface

public function getSSLAcceptServerCertStorePassword();
public function setSSLAcceptServerCertStorePassword($value);

Procedural Interface

cloudsms_sms_get($res, 48 );
cloudsms_sms_set($res, 48, $value );

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

SSLAcceptServerCertStoreType Property (CloudSMS_SMS Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLAcceptServerCertStoreType();
public function setSSLAcceptServerCertStoreType($value);

Procedural Interface

cloudsms_sms_get($res, 49 );
cloudsms_sms_set($res, 49, $value );

Default Value

0

Remarks

The type of certificate store for this certificate.

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

Data Type

Integer

SSLAcceptServerCertSubjectAltNames Property (CloudSMS_SMS Class)

Comma-separated lists of alternative subject names for the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertSubjectAltNames();

Procedural Interface

cloudsms_sms_get($res, 50 );

Default Value

''

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintMD5 Property (CloudSMS_SMS Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintMD5();

Procedural Interface

cloudsms_sms_get($res, 51 );

Default Value

''

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintSHA1 Property (CloudSMS_SMS Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintSHA1();

Procedural Interface

cloudsms_sms_get($res, 52 );

Default Value

''

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintSHA256 Property (CloudSMS_SMS Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintSHA256();

Procedural Interface

cloudsms_sms_get($res, 53 );

Default Value

''

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLAcceptServerCertUsage Property (CloudSMS_SMS Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSLAcceptServerCertUsage();

Procedural Interface

cloudsms_sms_get($res, 54 );

Default Value

''

Remarks

The text description of SSLAcceptServerCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

SSLAcceptServerCertUsageFlags Property (CloudSMS_SMS Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertUsageFlags();

Procedural Interface

cloudsms_sms_get($res, 55 );

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLAcceptServerCertUsageFlags is a combination of the following flags:

Please see the SSLAcceptServerCertUsage property for a text representation of SSLAcceptServerCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

SSLAcceptServerCertVersion Property (CloudSMS_SMS Class)

The certificate's version number.

Object Oriented Interface

public function getSSLAcceptServerCertVersion();

Procedural Interface

cloudsms_sms_get($res, 56 );

Default Value

''

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SSLAcceptServerCertSubject Property (CloudSMS_SMS Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLAcceptServerCertSubject();
public function setSSLAcceptServerCertSubject($value);

Procedural Interface

cloudsms_sms_get($res, 57 );
cloudsms_sms_set($res, 57, $value );

Default Value

''

Remarks

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

SSLAcceptServerCertEncoded Property (CloudSMS_SMS Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLAcceptServerCertEncoded();
public function setSSLAcceptServerCertEncoded($value);

Procedural Interface

cloudsms_sms_get($res, 58 );
cloudsms_sms_set($res, 58, $value );

Default Value

''

Remarks

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.

This property is not available at design time.

Data Type

Binary String

SSLCertEffectiveDate Property (CloudSMS_SMS Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLCertEffectiveDate();

Procedural Interface

cloudsms_sms_get($res, 59 );

Default Value

''

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLCertExpirationDate Property (CloudSMS_SMS Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSLCertExpirationDate();

Procedural Interface

cloudsms_sms_get($res, 60 );

Default Value

''

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLCertExtendedKeyUsage Property (CloudSMS_SMS Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLCertExtendedKeyUsage();

Procedural Interface

cloudsms_sms_get($res, 61 );

Default Value

''

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SSLCertFingerprint Property (CloudSMS_SMS Class)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Object Oriented Interface

public function getSSLCertFingerprint();

Procedural Interface

cloudsms_sms_get($res, 62 );

Default Value

''

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SSLCertFingerprintSHA1 Property (CloudSMS_SMS Class)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Object Oriented Interface

public function getSSLCertFingerprintSHA1();

Procedural Interface

cloudsms_sms_get($res, 63 );

Default Value

''

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSLCertFingerprintSHA256 Property (CloudSMS_SMS Class)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Object Oriented Interface

public function getSSLCertFingerprintSHA256();

Procedural Interface

cloudsms_sms_get($res, 64 );

Default Value

''

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSLCertIssuer Property (CloudSMS_SMS Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSLCertIssuer();

Procedural Interface

cloudsms_sms_get($res, 65 );

Default Value

''

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSLCertPrivateKey Property (CloudSMS_SMS Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLCertPrivateKey();

Procedural Interface

cloudsms_sms_get($res, 66 );

Default Value

''

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SSLCertPrivateKey may be available but not exportable. In this case, SSLCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLCertPrivateKeyAvailable Property (CloudSMS_SMS Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLCertPrivateKeyAvailable();

Procedural Interface

cloudsms_sms_get($res, 67 );

Default Value

false

Remarks

Whether a SSLCertPrivateKey is available for the selected certificate. If SSLCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLCertPrivateKeyContainer Property (CloudSMS_SMS Class)

The name of the PrivateKey container for the certificate (if available).

Object Oriented Interface

public function getSSLCertPrivateKeyContainer();

Procedural Interface

cloudsms_sms_get($res, 68 );

Default Value

''

Remarks

The name of the SSLCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLCertPublicKey Property (CloudSMS_SMS Class)

The public key of the certificate.

Object Oriented Interface

public function getSSLCertPublicKey();

Procedural Interface

cloudsms_sms_get($res, 69 );

Default Value

''

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SSLCertPublicKeyAlgorithm Property (CloudSMS_SMS Class)

The textual description of the certificate's public key algorithm.

Object Oriented Interface

public function getSSLCertPublicKeyAlgorithm();

Procedural Interface

cloudsms_sms_get($res, 70 );

Default Value

''

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLCertPublicKeyLength Property (CloudSMS_SMS Class)

The length of the certificate's public key (in bits).

Object Oriented Interface

public function getSSLCertPublicKeyLength();

Procedural Interface

cloudsms_sms_get($res, 71 );

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SSLCertSerialNumber Property (CloudSMS_SMS Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLCertSerialNumber();

Procedural Interface

cloudsms_sms_get($res, 72 );

Default Value

''

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SSLCertSignatureAlgorithm Property (CloudSMS_SMS Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLCertSignatureAlgorithm();

Procedural Interface

cloudsms_sms_get($res, 73 );

Default Value

''

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLCertStore Property (CloudSMS_SMS Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLCertStore();
public function setSSLCertStore($value);

Procedural Interface

cloudsms_sms_get($res, 74 );
cloudsms_sms_set($res, 74, $value );

Default Value

'MY'

Remarks

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 cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Binary String

SSLCertStorePassword Property (CloudSMS_SMS Class)

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

Object Oriented Interface

public function getSSLCertStorePassword();
public function setSSLCertStorePassword($value);

Procedural Interface

cloudsms_sms_get($res, 75 );
cloudsms_sms_set($res, 75, $value );

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 (CloudSMS_SMS Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLCertStoreType();
public function setSSLCertStoreType($value);

Procedural Interface

cloudsms_sms_get($res, 76 );
cloudsms_sms_set($res, 76, $value );

Default Value

0

Remarks

The type of certificate store for this certificate.

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

Data Type

Integer

SSLCertSubjectAltNames Property (CloudSMS_SMS Class)

Comma-separated lists of alternative subject names for the certificate.

Object Oriented Interface

public function getSSLCertSubjectAltNames();

Procedural Interface

cloudsms_sms_get($res, 77 );

Default Value

''

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSLCertThumbprintMD5 Property (CloudSMS_SMS Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintMD5();

Procedural Interface

cloudsms_sms_get($res, 78 );

Default Value

''

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLCertThumbprintSHA1 Property (CloudSMS_SMS Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintSHA1();

Procedural Interface

cloudsms_sms_get($res, 79 );

Default Value

''

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLCertThumbprintSHA256 Property (CloudSMS_SMS Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintSHA256();

Procedural Interface

cloudsms_sms_get($res, 80 );

Default Value

''

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLCertUsage Property (CloudSMS_SMS Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSLCertUsage();

Procedural Interface

cloudsms_sms_get($res, 81 );

Default Value

''

Remarks

The text description of SSLCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

SSLCertUsageFlags Property (CloudSMS_SMS Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLCertUsageFlags();

Procedural Interface

cloudsms_sms_get($res, 82 );

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLCertUsageFlags is a combination of the following flags:

Please see the SSLCertUsage property for a text representation of SSLCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

SSLCertVersion Property (CloudSMS_SMS Class)

The certificate's version number.

Object Oriented Interface

public function getSSLCertVersion();

Procedural Interface

cloudsms_sms_get($res, 83 );

Default Value

''

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SSLCertSubject Property (CloudSMS_SMS Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLCertSubject();
public function setSSLCertSubject($value);

Procedural Interface

cloudsms_sms_get($res, 84 );
cloudsms_sms_set($res, 84, $value );

Default Value

''

Remarks

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

SSLCertEncoded Property (CloudSMS_SMS Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLCertEncoded();
public function setSSLCertEncoded($value);

Procedural Interface

cloudsms_sms_get($res, 85 );
cloudsms_sms_set($res, 85, $value );

Default Value

''

Remarks

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.

This property is not available at design time.

Data Type

Binary String

SSLProvider Property (CloudSMS_SMS Class)

The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.

Object Oriented Interface

public function getSSLProvider();
public function setSSLProvider($value);

Procedural Interface

cloudsms_sms_get($res, 86 );
cloudsms_sms_set($res, 86, $value );

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 class 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 as follows:

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

When Automatic is selected, on Windows, the class will use the platform implementation. On Linux/macOS, the class will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols, the internal implementation is used on all platforms.

Data Type

Integer

SSLServerCertEffectiveDate Property (CloudSMS_SMS Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLServerCertEffectiveDate();

Procedural Interface

cloudsms_sms_get($res, 87 );

Default Value

''

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLServerCertExpirationDate Property (CloudSMS_SMS Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSLServerCertExpirationDate();

Procedural Interface

cloudsms_sms_get($res, 88 );

Default Value

''

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLServerCertExtendedKeyUsage Property (CloudSMS_SMS Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLServerCertExtendedKeyUsage();

Procedural Interface

cloudsms_sms_get($res, 89 );

Default Value

''

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SSLServerCertFingerprint Property (CloudSMS_SMS Class)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Object Oriented Interface

public function getSSLServerCertFingerprint();

Procedural Interface

cloudsms_sms_get($res, 90 );

Default Value

''

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SSLServerCertFingerprintSHA1 Property (CloudSMS_SMS Class)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Object Oriented Interface

public function getSSLServerCertFingerprintSHA1();

Procedural Interface

cloudsms_sms_get($res, 91 );

Default Value

''

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSLServerCertFingerprintSHA256 Property (CloudSMS_SMS Class)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Object Oriented Interface

public function getSSLServerCertFingerprintSHA256();

Procedural Interface

cloudsms_sms_get($res, 92 );

Default Value

''

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSLServerCertIssuer Property (CloudSMS_SMS Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSLServerCertIssuer();

Procedural Interface

cloudsms_sms_get($res, 93 );

Default Value

''

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSLServerCertPrivateKey Property (CloudSMS_SMS Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLServerCertPrivateKey();

Procedural Interface

cloudsms_sms_get($res, 94 );

Default Value

''

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SSLServerCertPrivateKey may be available but not exportable. In this case, SSLServerCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLServerCertPrivateKeyAvailable Property (CloudSMS_SMS Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLServerCertPrivateKeyAvailable();

Procedural Interface

cloudsms_sms_get($res, 95 );

Default Value

false

Remarks

Whether a SSLServerCertPrivateKey is available for the selected certificate. If SSLServerCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLServerCertPrivateKeyContainer Property (CloudSMS_SMS Class)

The name of the PrivateKey container for the certificate (if available).

Object Oriented Interface

public function getSSLServerCertPrivateKeyContainer();

Procedural Interface

cloudsms_sms_get($res, 96 );

Default Value

''

Remarks

The name of the SSLServerCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLServerCertPublicKey Property (CloudSMS_SMS Class)

The public key of the certificate.

Object Oriented Interface

public function getSSLServerCertPublicKey();

Procedural Interface

cloudsms_sms_get($res, 97 );

Default Value

''

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SSLServerCertPublicKeyAlgorithm Property (CloudSMS_SMS Class)

The textual description of the certificate's public key algorithm.

Object Oriented Interface

public function getSSLServerCertPublicKeyAlgorithm();

Procedural Interface

cloudsms_sms_get($res, 98 );

Default Value

''

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLServerCertPublicKeyLength Property (CloudSMS_SMS Class)

The length of the certificate's public key (in bits).

Object Oriented Interface

public function getSSLServerCertPublicKeyLength();

Procedural Interface

cloudsms_sms_get($res, 99 );

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SSLServerCertSerialNumber Property (CloudSMS_SMS Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLServerCertSerialNumber();

Procedural Interface

cloudsms_sms_get($res, 100 );

Default Value

''

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SSLServerCertSignatureAlgorithm Property (CloudSMS_SMS Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLServerCertSignatureAlgorithm();

Procedural Interface

cloudsms_sms_get($res, 101 );

Default Value

''

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLServerCertStore Property (CloudSMS_SMS Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLServerCertStore();

Procedural Interface

cloudsms_sms_get($res, 102 );

Default Value

'MY'

Remarks

The name of the certificate store for the client certificate.

The SSLServerCertStoreType property denotes the type of the certificate store specified by SSLServerCertStore. If the store is password-protected, specify the password in SSLServerCertStorePassword.

SSLServerCertStore is used in conjunction with the SSLServerCertSubject property to specify client certificates. If SSLServerCertStore has a value, and SSLServerCertSubject or SSLServerCertEncoded is set, a search for a certificate is initiated. Please see the SSLServerCertSubject 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 cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

This property is read-only.

Data Type

Binary String

SSLServerCertStorePassword Property (CloudSMS_SMS Class)

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

Object Oriented Interface

public function getSSLServerCertStorePassword();

Procedural Interface

cloudsms_sms_get($res, 103 );

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.

This property is read-only.

Data Type

String

SSLServerCertStoreType Property (CloudSMS_SMS Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLServerCertStoreType();

Procedural Interface

cloudsms_sms_get($res, 104 );

Default Value

0

Remarks

The type of certificate store for this certificate.

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

This property is read-only.

Data Type

Integer

SSLServerCertSubjectAltNames Property (CloudSMS_SMS Class)

Comma-separated lists of alternative subject names for the certificate.

Object Oriented Interface

public function getSSLServerCertSubjectAltNames();

Procedural Interface

cloudsms_sms_get($res, 105 );

Default Value

''

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSLServerCertThumbprintMD5 Property (CloudSMS_SMS Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintMD5();

Procedural Interface

cloudsms_sms_get($res, 106 );

Default Value

''

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLServerCertThumbprintSHA1 Property (CloudSMS_SMS Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintSHA1();

Procedural Interface

cloudsms_sms_get($res, 107 );

Default Value

''

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLServerCertThumbprintSHA256 Property (CloudSMS_SMS Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintSHA256();

Procedural Interface

cloudsms_sms_get($res, 108 );

Default Value

''

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLServerCertUsage Property (CloudSMS_SMS Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSLServerCertUsage();

Procedural Interface

cloudsms_sms_get($res, 109 );

Default Value

''

Remarks

The text description of SSLServerCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

SSLServerCertUsageFlags Property (CloudSMS_SMS Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLServerCertUsageFlags();

Procedural Interface

cloudsms_sms_get($res, 110 );

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLServerCertUsageFlags is a combination of the following flags:

Please see the SSLServerCertUsage property for a text representation of SSLServerCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

SSLServerCertVersion Property (CloudSMS_SMS Class)

The certificate's version number.

Object Oriented Interface

public function getSSLServerCertVersion();

Procedural Interface

cloudsms_sms_get($res, 111 );

Default Value

''

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SSLServerCertSubject Property (CloudSMS_SMS Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLServerCertSubject();

Procedural Interface

cloudsms_sms_get($res, 112 );

Default Value

''

Remarks

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.

This property is read-only.

Data Type

String

SSLServerCertEncoded Property (CloudSMS_SMS Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLServerCertEncoded();

Procedural Interface

cloudsms_sms_get($res, 113 );

Default Value

''

Remarks

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.

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

Data Type

Binary String

AddQueryParam Method (CloudSMS_SMS Class)

Adds a query parameter to the QueryParams properties.

Object Oriented Interface

public function doAddQueryParam($name, $value);

Procedural Interface

cloudsms_sms_do_addqueryparam($res, $name, $value);

Remarks

This method is used to add a query parameter to the QueryParams 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 class 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 (CloudSMS_SMS Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

cloudsms_sms_do_config($res, $configurationstring);

Remarks

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

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, 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 (CloudSMS_SMS Class)

Deletes a received message from the account.

Object Oriented Interface

public function doDeleteReceivedMessage($messageid);

Procedural Interface

cloudsms_sms_do_deletereceivedmessage($res, $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 (CloudSMS_SMS Class)

Deletes a sent message from the account.

Object Oriented Interface

public function doDeleteSentMessage($messageid);

Procedural Interface

cloudsms_sms_do_deletesentmessage($res, $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 (CloudSMS_SMS Class)

This method processes events from the internal message queue.

Object Oriented Interface

public function doEvents();

Procedural Interface

cloudsms_sms_do_doevents($res);

Remarks

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

HandleWebhook Method (CloudSMS_SMS Class)

Parses requests made to a web-hook.

Object Oriented Interface

public function doHandleWebhook($headerstring, $querystring, $postdata);

Procedural Interface

cloudsms_sms_do_handlewebhook($res, $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 class 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 class will fire the IncomingMessage event.

It is important to note that the class 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 (CloudSMS_SMS Class)

This method interrupts the current method.

Object Oriented Interface

public function doInterrupt();

Procedural Interface

cloudsms_sms_do_interrupt($res);

Remarks

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

ListReceivedMessages Method (CloudSMS_SMS Class)

Lists received messages from the account.

Object Oriented Interface

public function doListReceivedMessages($filter);

Procedural Interface

cloudsms_sms_do_listreceivedmessages($res, $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 Messages 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 (CloudSMS_SMS Class)

Lists messages sent from the account.

Object Oriented Interface

public function doListSentMessages($filter);

Procedural Interface

cloudsms_sms_do_listsentmessages($res, $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 Messages 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 (CloudSMS_SMS Class)

This method will reset the class.

Object Oriented Interface

public function doReset();

Procedural Interface

cloudsms_sms_do_reset($res);

Remarks

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

RetrieveReceivedMessage Method (CloudSMS_SMS Class)

Fetches a received message from the account.

Object Oriented Interface

public function doRetrieveReceivedMessage($messageid);

Procedural Interface

cloudsms_sms_do_retrievereceivedmessage($res, $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 Messages 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.RetrieveReceivedMessage(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.

RetrieveSentMessage Method (CloudSMS_SMS Class)

Fetches a message sent from the account.

Object Oriented Interface

public function doRetrieveSentMessage($messageid);

Procedural Interface

cloudsms_sms_do_retrievesentmessage($res, $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 Messages 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.RetrieveSentMessage(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.

ScheduleMessage Method (CloudSMS_SMS Class)

Schedules a message to be sent.

Object Oriented Interface

public function doScheduleMessage();

Procedural Interface

cloudsms_sms_do_schedulemessage($res);

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 RetrieveSentMessage 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 (CloudSMS_SMS Class)

Sends an SMS message.

Object Oriented Interface

public function doSend();

Procedural Interface

cloudsms_sms_do_send($res);

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 (CloudSMS_SMS Class)

Updates a scheduled or sent message.

Object Oriented Interface

public function doUpdateSentMessage($messageid);

Procedural Interface

cloudsms_sms_do_updatesentmessage($res, $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 Messages properties with a matching . There are a number of ways to populate messages into the properties. The Send and ScheduleMessage methods will populate the Messages properties using the response from the service provider. The RetrieveSentMessage 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 Messages properties and set the property to the specific MessageId. Once the message is populated in the Messages 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 (CloudSMS_SMS Class)

Fired once for each delivery report.

Object Oriented Interface

public function fireDeliveryReport($param);

Procedural Interface

cloudsms_sms_register_callback($res, 1, array($this, 'fireDeliveryReport'));

Parameter List

 'messageid'
 'status'

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 RetrieveSentMessage method to get the real ID once the message is sent.

Error Event (CloudSMS_SMS Class)

Fired when information is available about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

cloudsms_sms_register_callback($res, 2, array($this, 'fireError'));

Parameter List

 'errorcode'
 'description'

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class 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 (CloudSMS_SMS Class)

Fired once for each incoming message.

Object Oriented Interface

public function fireIncomingMessage($param);

Procedural Interface

cloudsms_sms_register_callback($res, 3, array($this, 'fireIncomingMessage'));

Parameter List

 'messageid'
 'sentto'
 'from'
 'body'

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, RetrieveReceivedMessage, 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 (CloudSMS_SMS Class)

Fired once for each log message.

Object Oriented Interface

public function fireLog($param);

Procedural Interface

cloudsms_sms_register_callback($res, 4, array($this, 'fireLog'));

Parameter List

 'loglevel'
 'message'
 'logtype'

Remarks

This event is fired once for each log message generated by the class. 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 (CloudSMS_SMS Class)

Fired once for each listed message.

Object Oriented Interface

public function fireMessageList($param);

Procedural Interface

cloudsms_sms_register_callback($res, 5, array($this, 'fireMessageList'));

Parameter List

 'messageid'
 'direction'
 'sentto'
 'from'
 'messagestatus'
 'body'

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 class.

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 (CloudSMS_SMS Class)

Fired after the server presents its certificate to the client.

Object Oriented Interface

public function fireSSLServerAuthentication($param);

Procedural Interface

cloudsms_sms_register_callback($res, 6, array($this, 'fireSSLServerAuthentication'));

Parameter List

 'certencoded'
 'certsubject'
 'certissuer'
 'status'
 'accept'

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 (CloudSMS_SMS Class)

Fired when secure connection progress messages are available.

Object Oriented Interface

public function fireSSLStatus($param);

Procedural Interface

cloudsms_sms_register_callback($res, 7, array($this, 'fireSSLStatus'));

Parameter List

 'message'

Remarks

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

Config Settings (SMS Class)

SMS Config Settings

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

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

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

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

Socket Config Settings

Base Config Settings

Trappable Errors (SMS Class)

SMS Errors

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

HTTP Errors

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

TCPClient Errors

SSL Errors

TCP/IP Errors