SMPP Class

Properties   Methods   Events   Config Settings   Errors  

The Smpp Class implements a lightweight message transmission interface using the Short Message Peer-to-Peer protocol, most known for its use in cellular text messaging.

Syntax

SMPP

Remarks

The Smpp class supports both plaintext and Secure Sockets Layer/Transport Layer Security (SSL/TLS) connections. When connecting over SSL/TLS the SSLServerAuthentication event allows you to check the server identity and other security attributes. The SSLStatus event provides information about the SSL handshake. Additional SSL related settings are also supported via the Config method.

The Smpp Class will bind as a transceiver, and thus it can send and receive messages from the server. Additionally, it can send single and multirecipient messages and also can upload data.

Using Smpp is quite easy. First, simply set the SMPPServer, SMPPPort, and, if needed, the SMPPVersion properties. Second, a single call to the Connect method with a specified user Id and password will connect the class.

Transmitting messages is just as easy. You can manipulate the Recipients properties directly, or just use AddRecipient method to add recipients one at a time to the recipient list. After all recipients have been added, a single call to the SendMessage method will transmit the specified message. If the send is successful, the method will set and return the value of the MessageId property. Otherwise, an Error event will fire for each unsuccessful message destination.

The Smpp Class supports message and data transmission, as well as auxiliary operations, such as CheckMessageStatus and ReplaceMessage. All nonimplemented features of the protocol are supported through the SendCommand method and PITrail event. Because of the nature of the protocol, all methods and operations are implemented synchronously.

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.

Connected Property (SMPP Class)

This property indicates whether or not the class is bound.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetConnected();

Unicode (Windows)
BOOL GetConnected();

int ipworks_smpp_getconnected(void* lpObj);

bool GetConnected();

Default Value

FALSE

Remarks

The value of this property indicates whether or not the class has successfully bound to the SMPPServer. It will not be true until a successful Connected event has fired.

The two ways to bind are (1) by calling Connect with a user identifier and password, which will set the UserId and Password properties before connecting; or (2) by setting those two properties and calling SendMessage while not connected.

Note: It is recommended to use the Connect or Disconnect method instead of setting this property.

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

Data Type

Boolean

FirewallAutoDetect Property (SMPP Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFirewallAutoDetect();
int SetFirewallAutoDetect(int bFirewallAutoDetect);

Unicode (Windows)
BOOL GetFirewallAutoDetect();
INT SetFirewallAutoDetect(BOOL bFirewallAutoDetect);

int ipworks_smpp_getfirewallautodetect(void* lpObj);
int ipworks_smpp_setfirewallautodetect(void* lpObj, int bFirewallAutoDetect);

bool GetFirewallAutoDetect();
int SetFirewallAutoDetect(bool bFirewallAutoDetect);

Default Value

FALSE

Remarks

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

Data Type

Boolean

FirewallType Property (SMPP Class)

This property determines the type of firewall to connect through.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFirewallType();
int SetFirewallType(int iFirewallType);

Unicode (Windows)
INT GetFirewallType();
INT SetFirewallType(INT iFirewallType);

FW_NONE(0), 
FW_TUNNEL(1), 
FW_SOCKS4(2), 
FW_SOCKS5(3), 
FW_SOCKS4A(10)

int ipworks_smpp_getfirewalltype(void* lpObj);
int ipworks_smpp_setfirewalltype(void* lpObj, int iFirewallType);

int GetFirewallType();
int SetFirewallType(int iFirewallType);

Default Value

0

Remarks

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

Data Type

Integer

FirewallHost Property (SMPP Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFirewallHost();
int SetFirewallHost(const char* lpszFirewallHost);

Unicode (Windows)
LPWSTR GetFirewallHost();
INT SetFirewallHost(LPCWSTR lpszFirewallHost);

char* ipworks_smpp_getfirewallhost(void* lpObj);
int ipworks_smpp_setfirewallhost(void* lpObj, const char* lpszFirewallHost);

QString GetFirewallHost();
int SetFirewallHost(QString qsFirewallHost);

Default Value

""

Remarks

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

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

Data Type

String

FirewallPassword Property (SMPP Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFirewallPassword();
int SetFirewallPassword(const char* lpszFirewallPassword);

Unicode (Windows)
LPWSTR GetFirewallPassword();
INT SetFirewallPassword(LPCWSTR lpszFirewallPassword);

char* ipworks_smpp_getfirewallpassword(void* lpObj);
int ipworks_smpp_setfirewallpassword(void* lpObj, const char* lpszFirewallPassword);

QString GetFirewallPassword();
int SetFirewallPassword(QString qsFirewallPassword);

Default Value

""

Remarks

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

Data Type

String

FirewallPort Property (SMPP Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFirewallPort();
int SetFirewallPort(int iFirewallPort);

Unicode (Windows)
INT GetFirewallPort();
INT SetFirewallPort(INT iFirewallPort);

int ipworks_smpp_getfirewallport(void* lpObj);
int ipworks_smpp_setfirewallport(void* lpObj, int iFirewallPort);

int GetFirewallPort();
int SetFirewallPort(int iFirewallPort);

Default Value

0

Remarks

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

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

Data Type

Integer

FirewallUser Property (SMPP Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFirewallUser();
int SetFirewallUser(const char* lpszFirewallUser);

Unicode (Windows)
LPWSTR GetFirewallUser();
INT SetFirewallUser(LPCWSTR lpszFirewallUser);

char* ipworks_smpp_getfirewalluser(void* lpObj);
int ipworks_smpp_setfirewalluser(void* lpObj, const char* lpszFirewallUser);

QString GetFirewallUser();
int SetFirewallUser(QString qsFirewallUser);

Default Value

""

Remarks

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

Data Type

String

Idle Property (SMPP Class)

The current status of the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetIdle();

Unicode (Windows)
BOOL GetIdle();

int ipworks_smpp_getidle(void* lpObj);

bool GetIdle();

Default Value

TRUE

Remarks

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

This property is read-only.

Data Type

Boolean

LocalHost Property (SMPP Class)

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLocalHost();
int SetLocalHost(const char* lpszLocalHost);

Unicode (Windows)
LPWSTR GetLocalHost();
INT SetLocalHost(LPCWSTR lpszLocalHost);

char* ipworks_smpp_getlocalhost(void* lpObj);
int ipworks_smpp_setlocalhost(void* lpObj, const char* lpszLocalHost);

QString GetLocalHost();
int SetLocalHost(QString qsLocalHost);

Default Value

""

Remarks

The LocalHost property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.

If the class is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multi-homed hosts (machines with more than one IP interface).

NOTE: LocalHost is not persistent. You must always set it in code, and never in the property window.

Data Type

String

MessageExpiration Property (SMPP Class)

This property denotes the validity period of the current message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMessageExpiration();
int SetMessageExpiration(const char* lpszMessageExpiration);

Unicode (Windows)
LPWSTR GetMessageExpiration();
INT SetMessageExpiration(LPCWSTR lpszMessageExpiration);

char* ipworks_smpp_getmessageexpiration(void* lpObj);
int ipworks_smpp_setmessageexpiration(void* lpObj, const char* lpszMessageExpiration);

QString GetMessageExpiration();
int SetMessageExpiration(QString qsMessageExpiration);

Default Value

""

Remarks

This property indicates the Message Center expiration time, after which the message should be discarded if not delivered to the destination. It can be set using absolute or relative time formats.

Absolute Time Format is a 16-character string represented as "YYMMDDhhmmsstnnp" where:

Relative Time Format is the same 16-character string where "p" should be set to "R" for "relative". For relative time, "tnn" are ignored and thus should be set to a constant value of "000".

Data Type

String

MessageId Property (SMPP Class)

This property indicates the identifier of the most recently sent message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMessageId();

Unicode (Windows)
LPWSTR GetMessageId();

char* ipworks_smpp_getmessageid(void* lpObj);

QString GetMessageId();

Default Value

""

Remarks

This property indicates the identifier of the most recently sent message. After a successful call to SendMessage, this property will be set to the server-assigned Id for that message.

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

Data Type

String

MessagePriority Property (SMPP Class)

This property indicates the priority level of the current message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetMessagePriority();
int SetMessagePriority(int iMessagePriority);

Unicode (Windows)
INT GetMessagePriority();
INT SetMessagePriority(INT iMessagePriority);

SMPP_MESSAGE_PRIORITY_LOW(0), 
SMPP_MESSAGE_PRIORITY_NORMAL(1), 
SMPP_MESSAGE_PRIORITY_HIGH(2), 
SMPP_MESSAGE_PRIORITY_URGENT(3)

int ipworks_smpp_getmessagepriority(void* lpObj);
int ipworks_smpp_setmessagepriority(void* lpObj, int iMessagePriority);

int GetMessagePriority();
int SetMessagePriority(int iMessagePriority);

Default Value

1

Remarks

When sending a message, this property will tell the server what type of priority to assign to the message. The effect of the message priority setting depends on the Message Center (MC) manufacturer and the network on which the target recipient lies. For example, some MCs may immediately forward "urgent" messages, some networks may use the priority setting as a visual indicator of the message's urgency (e.g., blinking icons), and some networks may entirely ignore the priority setting.

Data Type

Integer

Password Property (SMPP Class)

This property contains the user's password.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPassword();
int SetPassword(const char* lpszPassword);

Unicode (Windows)
LPWSTR GetPassword();
INT SetPassword(LPCWSTR lpszPassword);

char* ipworks_smpp_getpassword(void* lpObj);
int ipworks_smpp_setpassword(void* lpObj, const char* lpszPassword);

QString GetPassword();
int SetPassword(QString qsPassword);

Default Value

""

Remarks

This property contains the user's password. When binding to the SMPPServer, the client must provide a known user identifier and a valid password for that Id.

The two ways to bind are (1) by calling Connect with a user identifier and password, which will set the UserId and this property before connecting; or (2) by setting those two properties and calling SendMessage while not connected.

Data Type

String

Protocol Property (SMPP Class)

This property defines the SMPP protocol to be used.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProtocol();
int SetProtocol(int iProtocol);

Unicode (Windows)
INT GetProtocol();
INT SetProtocol(INT iProtocol);

SMPP_SMPP(0), 
SMPP_CIMD2(1)

int ipworks_smpp_getprotocol(void* lpObj);
int ipworks_smpp_setprotocol(void* lpObj, int iProtocol);

int GetProtocol();
int SetProtocol(int iProtocol);

Default Value

0

Remarks

This property defines the protocol to be used when connecting to the server. Possible values are as follows:

Data Type

Integer

RecipientCount Property (SMPP Class)

The number of records in the Recipient arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetRecipientCount();
int SetRecipientCount(int iRecipientCount);

Unicode (Windows)
INT GetRecipientCount();
INT SetRecipientCount(INT iRecipientCount);

int ipworks_smpp_getrecipientcount(void* lpObj);
int ipworks_smpp_setrecipientcount(void* lpObj, int iRecipientCount);

int GetRecipientCount();
int SetRecipientCount(int iRecipientCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

• RecipientAddress
• RecipientType

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

This property is not available at design time.

Data Type

Integer

RecipientAddress Property (SMPP Class)

This property contains the email address of a particular recipient.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetRecipientAddress(int iRecipientIndex);
int SetRecipientAddress(int iRecipientIndex, const char* lpszRecipientAddress);

Unicode (Windows)
LPWSTR GetRecipientAddress(INT iRecipientIndex);
INT SetRecipientAddress(INT iRecipientIndex, LPCWSTR lpszRecipientAddress);

char* ipworks_smpp_getrecipientaddress(void* lpObj, int recipientindex);
int ipworks_smpp_setrecipientaddress(void* lpObj, int recipientindex, const char* lpszRecipientAddress);

QString GetRecipientAddress(int iRecipientIndex);
int SetRecipientAddress(int iRecipientIndex, QString qsRecipientAddress);

Default Value

""

Remarks

This property contains the email address of a particular recipient. This can be used to set single or multiple recipients. The RecipientType contains the corresponding type.

For a recipient type of normal, the value in the RecipientAddress should be either the dotted IPv4 of an SMS-enabled device or the directory number of a target mobile phone. For distributed lists, the value should be the name of the list as it is stored on the SMPPServer.

The RecipientIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RecipientCount property.

This property is not available at design time.

Data Type

String

RecipientType Property (SMPP Class)

This property contains the type of a particular recipient.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetRecipientType(int iRecipientIndex);
int SetRecipientType(int iRecipientIndex, int iRecipientType);

Unicode (Windows)
INT GetRecipientType(INT iRecipientIndex);
INT SetRecipientType(INT iRecipientIndex, INT iRecipientType);

SMPP_RECIPIENT_TYPE_NORMAL(0), 
SMPP_RECIPIENT_TYPE_LIST(1)

int ipworks_smpp_getrecipienttype(void* lpObj, int recipientindex);
int ipworks_smpp_setrecipienttype(void* lpObj, int recipientindex, int iRecipientType);

int GetRecipientType(int iRecipientIndex);
int SetRecipientType(int iRecipientIndex, int iRecipientType);

Default Value

0

Remarks

This property contains the type of a particular recipient. This property is used only for multiple recipient messages. The RecipientAddress contains the corresponding recipient's address.

For a recipient type of normal, the value in RecipientAddress should be either the dotted IPv4 of an SMS-enabled device or the directory number of a target mobile phone. For distributed lists, the value should be the name of the list as it is stored on the SMPPServer.

Valid values for RecipientType are as follows:

The RecipientIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RecipientCount property.

This property is not available at design time.

Data Type

Integer

ScheduledDelivery Property (SMPP Class)

This property tells the server when to deliver the current message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetScheduledDelivery();
int SetScheduledDelivery(const char* lpszScheduledDelivery);

Unicode (Windows)
LPWSTR GetScheduledDelivery();
INT SetScheduledDelivery(LPCWSTR lpszScheduledDelivery);

char* ipworks_smpp_getscheduleddelivery(void* lpObj);
int ipworks_smpp_setscheduleddelivery(void* lpObj, const char* lpszScheduledDelivery);

QString GetScheduledDelivery();
int SetScheduledDelivery(QString qsScheduledDelivery);

Default Value

""

Remarks

This property is used by the class when sending a message to inform the Message Center to forward the message to the intended recipients at a specific time. It can be set using absolute or relative time formats.

Absolute Time Format is a 16-character string represented as "YYMMDDhhmmsstnnp" where:

Relative Time Format is the same 16-character string where "p" should be set to "R" for "relative". For relative time, "tnn" are ignored and thus should be set to a constant value of "000".

Data Type

String

SenderAddress Property (SMPP Class)

This property contains the address of the External Short Messaging Entity (ESME).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSenderAddress();
int SetSenderAddress(const char* lpszSenderAddress);

Unicode (Windows)
LPWSTR GetSenderAddress();
INT SetSenderAddress(LPCWSTR lpszSenderAddress);

char* ipworks_smpp_getsenderaddress(void* lpObj);
int ipworks_smpp_setsenderaddress(void* lpObj, const char* lpszSenderAddress);

QString GetSenderAddress();
int SetSenderAddress(QString qsSenderAddress);

Default Value

""

Remarks

This property contains the address of the External Short Messaging Entity (ESME). The SMPP protocol allows an ESME to specify its address, whether it is a phone number or an IP address. If this property is not set, the class will default to the value in LocalHost.

Data Type

String

ServiceType Property (SMPP Class)

This property indicates the type of service for the current message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetServiceType();
int SetServiceType(int iServiceType);

Unicode (Windows)
INT GetServiceType();
INT SetServiceType(INT iServiceType);

SMPP_SERVICE_DEFAULT(0), 
SMPP_SERVICE_CMT(1), 
SMPP_SERVICE_CPT(2), 
SMPP_SERVICE_VMN(3), 
SMPP_SERVICE_VMA(4), 
SMPP_SERVICE_WAP(5), 
SMPP_SERVICE_USSD(6), 
SMPP_SERVICE_CBS(7)

int ipworks_smpp_getservicetype(void* lpObj);
int ipworks_smpp_setservicetype(void* lpObj, int iServiceType);

int GetServiceType();
int SetServiceType(int iServiceType);

Default Value

0

Remarks

When sending messages, this property is used to define the SMS application service to be associated with the message. The Message Center (MC) will use the value to determine the availability of enhanced messaging services and to control the teleservice used on the air interface.

The values are defined in the SMPP 5.0 specification as follows:

Data Type

Integer

SMPPPort Property (SMPP Class)

This property contains the server port for secure SMPP (default 2775).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSMPPPort();
int SetSMPPPort(int iSMPPPort);

Unicode (Windows)
INT GetSMPPPort();
INT SetSMPPPort(INT iSMPPPort);

int ipworks_smpp_getsmppport(void* lpObj);
int ipworks_smpp_setsmppport(void* lpObj, int iSMPPPort);

int GetSMPPPort();
int SetSMPPPort(int iSMPPPort);

Default Value

2775

Remarks

For an implicit Secure Sockets Layer (SSL), use port 3551 (please refer to the SSLStartMode property for more information).

A valid port number (a value between 1 and 65535) is required for the connection to take place. The property must be set before a connection is attempted and cannot be changed once a connection is established. Any attempt to change this property while connected will fail with an error.

Data Type

Integer

SMPPServer Property (SMPP Class)

This property is the SMPP entity to which the class will connect.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSMPPServer();
int SetSMPPServer(const char* lpszSMPPServer);

Unicode (Windows)
LPWSTR GetSMPPServer();
INT SetSMPPServer(LPCWSTR lpszSMPPServer);

char* ipworks_smpp_getsmppserver(void* lpObj);
int ipworks_smpp_setsmppserver(void* lpObj, const char* lpszSMPPServer);

QString GetSMPPServer();
int SetSMPPServer(QString qsSMPPServer);

Default Value

""

Remarks

This property is the instant messaging server to which the class will connect when the Connect method is called. This property must contain a valid SMPP service application address.

Data Type

String

SMPPVersion Property (SMPP Class)

This property indicates the SMPP version to be used throughout the connection.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSMPPVersion();
int SetSMPPVersion(int iSMPPVersion);

Unicode (Windows)
INT GetSMPPVersion();
INT SetSMPPVersion(INT iSMPPVersion);

SMPP_VERSION_50(0), 
SMPP_VERSION_34(1), 
SMPP_VERSION_33(2)

int ipworks_smpp_getsmppversion(void* lpObj);
int ipworks_smpp_setsmppversion(void* lpObj, int iSMPPVersion);

int GetSMPPVersion();
int SetSMPPVersion(int iSMPPVersion);

Default Value

1

Remarks

This property contains the SMPP version to be used throughout the connection.

The default value is version 3.4 because it is the most widely used version of the protocol.

Choosing the highest mutually supported version is generally recommended. Version 3.4 is the default value; however, if version 5.0 is supported, it is recommended.

Data Type

Integer

SSLAcceptServerCertEncoded Property (SMPP Class)

This is the certificate (PEM/Base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLAcceptServerCertEncoded(char* &lpSSLAcceptServerCertEncoded, int &lenSSLAcceptServerCertEncoded);
int SetSSLAcceptServerCertEncoded(const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);

Unicode (Windows)
INT GetSSLAcceptServerCertEncoded(LPSTR &lpSSLAcceptServerCertEncoded, INT &lenSSLAcceptServerCertEncoded);
INT SetSSLAcceptServerCertEncoded(LPCSTR lpSSLAcceptServerCertEncoded, INT lenSSLAcceptServerCertEncoded);

int ipworks_smpp_getsslacceptservercertencoded(void* lpObj, char** lpSSLAcceptServerCertEncoded, int* lenSSLAcceptServerCertEncoded);
int ipworks_smpp_setsslacceptservercertencoded(void* lpObj, const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);

QByteArray GetSSLAcceptServerCertEncoded();
int SetSSLAcceptServerCertEncoded(QByteArray qbaSSLAcceptServerCertEncoded);

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

SSLCertEncoded Property (SMPP Class)

This is the certificate (PEM/Base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLCertEncoded(char* &lpSSLCertEncoded, int &lenSSLCertEncoded);
int SetSSLCertEncoded(const char* lpSSLCertEncoded, int lenSSLCertEncoded);

Unicode (Windows)
INT GetSSLCertEncoded(LPSTR &lpSSLCertEncoded, INT &lenSSLCertEncoded);
INT SetSSLCertEncoded(LPCSTR lpSSLCertEncoded, INT lenSSLCertEncoded);

int ipworks_smpp_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int ipworks_smpp_setsslcertencoded(void* lpObj, const char* lpSSLCertEncoded, int lenSSLCertEncoded);

QByteArray GetSSLCertEncoded();
int SetSSLCertEncoded(QByteArray qbaSSLCertEncoded);

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

SSLCertStore Property (SMPP Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLCertStore(char* &lpSSLCertStore, int &lenSSLCertStore);
int SetSSLCertStore(const char* lpSSLCertStore, int lenSSLCertStore);

Unicode (Windows)
INT GetSSLCertStore(LPSTR &lpSSLCertStore, INT &lenSSLCertStore);
INT SetSSLCertStore(LPCSTR lpSSLCertStore, INT lenSSLCertStore);

int ipworks_smpp_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int ipworks_smpp_setsslcertstore(void* lpObj, const char* lpSSLCertStore, int lenSSLCertStore);

QByteArray GetSSLCertStore();
int SetSSLCertStore(QByteArray qbaSSLCertStore);

Default Value

"MY"

Remarks

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

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

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

Designations of certificate stores are platform dependent.

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

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

Data Type

Binary String

SSLCertStorePassword Property (SMPP Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSSLCertStorePassword();
int SetSSLCertStorePassword(const char* lpszSSLCertStorePassword);

Unicode (Windows)
LPWSTR GetSSLCertStorePassword();
INT SetSSLCertStorePassword(LPCWSTR lpszSSLCertStorePassword);

char* ipworks_smpp_getsslcertstorepassword(void* lpObj);
int ipworks_smpp_setsslcertstorepassword(void* lpObj, const char* lpszSSLCertStorePassword);

QString GetSSLCertStorePassword();
int SetSSLCertStorePassword(QString qsSSLCertStorePassword);

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

This is the type of certificate store for this certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType);

Unicode (Windows)
INT GetSSLCertStoreType();
INT SetSSLCertStoreType(INT iSSLCertStoreType);

CST_USER(0), 
CST_MACHINE(1), 
CST_PFXFILE(2), 
CST_PFXBLOB(3), 
CST_JKSFILE(4), 
CST_JKSBLOB(5), 
CST_PEMKEY_FILE(6), 
CST_PEMKEY_BLOB(7), 
CST_PUBLIC_KEY_FILE(8), 
CST_PUBLIC_KEY_BLOB(9), 
CST_SSHPUBLIC_KEY_BLOB(10), 
CST_P7BFILE(11), 
CST_P7BBLOB(12), 
CST_SSHPUBLIC_KEY_FILE(13), 
CST_PPKFILE(14), 
CST_PPKBLOB(15), 
CST_XMLFILE(16), 
CST_XMLBLOB(17), 
CST_JWKFILE(18), 
CST_JWKBLOB(19), 
CST_SECURITY_KEY(20), 
CST_BCFKSFILE(21), 
CST_BCFKSBLOB(22), 
CST_PKCS11(23), 
CST_AUTO(99)

int ipworks_smpp_getsslcertstoretype(void* lpObj);
int ipworks_smpp_setsslcertstoretype(void* lpObj, int iSSLCertStoreType);

int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType);

Default Value

0

Remarks

This is 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

SSLCertSubject Property (SMPP Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSSLCertSubject();
int SetSSLCertSubject(const char* lpszSSLCertSubject);

Unicode (Windows)
LPWSTR GetSSLCertSubject();
INT SetSSLCertSubject(LPCWSTR lpszSSLCertSubject);

char* ipworks_smpp_getsslcertsubject(void* lpObj);
int ipworks_smpp_setsslcertsubject(void* lpObj, const char* lpszSSLCertSubject);

QString GetSSLCertSubject();
int SetSSLCertSubject(QString qsSSLCertSubject);

Default Value

""

Remarks

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

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

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

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

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

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

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

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

Data Type

String

SSLEnabled Property (SMPP Class)

Whether TLS/SSL is enabled.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLEnabled();
int SetSSLEnabled(int bSSLEnabled);

Unicode (Windows)
BOOL GetSSLEnabled();
INT SetSSLEnabled(BOOL bSSLEnabled);

int ipworks_smpp_getsslenabled(void* lpObj);
int ipworks_smpp_setsslenabled(void* lpObj, int bSSLEnabled);

bool GetSSLEnabled();
int SetSSLEnabled(bool bSSLEnabled);

Default Value

FALSE

Remarks

This setting specifies whether TLS/SSL is enabled in the class. When False (default) the class operates in plaintext mode. When True TLS/SSL is enabled.

TLS/SSL may also be enabled by setting SSLStartMode. Setting SSLStartMode will automatically update this property value.

This property is not available at design time.

Data Type

Boolean

SSLProvider Property (SMPP Class)

This specifies the SSL/TLS implementation to use.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLProvider();
int SetSSLProvider(int iSSLProvider);

Unicode (Windows)
INT GetSSLProvider();
INT SetSSLProvider(INT iSSLProvider);

SSLP_AUTOMATIC(0), 
SSLP_PLATFORM(1), 
SSLP_INTERNAL(2)

int ipworks_smpp_getsslprovider(void* lpObj);
int ipworks_smpp_setsslprovider(void* lpObj, int iSSLProvider);

int GetSSLProvider();
int SetSSLProvider(int iSSLProvider);

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:

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

SSLServerCertEncoded Property (SMPP Class)

This is the certificate (PEM/Base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLServerCertEncoded(char* &lpSSLServerCertEncoded, int &lenSSLServerCertEncoded);

Unicode (Windows)
INT GetSSLServerCertEncoded(LPSTR &lpSSLServerCertEncoded, INT &lenSSLServerCertEncoded);

int ipworks_smpp_getsslservercertencoded(void* lpObj, char** lpSSLServerCertEncoded, int* lenSSLServerCertEncoded);

QByteArray GetSSLServerCertEncoded();

Default Value

""

Remarks

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

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

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

Data Type

Binary String

SSLStartMode Property (SMPP Class)

Determines how the class starts the SSL negotiation.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLStartMode();
int SetSSLStartMode(int iSSLStartMode);

Unicode (Windows)
INT GetSSLStartMode();
INT SetSSLStartMode(INT iSSLStartMode);

SSL_AUTOMATIC(0), 
SSL_IMPLICIT(1), 
SSL_EXPLICIT(2), 
SSL_NONE(3)

int ipworks_smpp_getsslstartmode(void* lpObj);
int ipworks_smpp_setsslstartmode(void* lpObj, int iSSLStartMode);

int GetSSLStartMode();
int SetSSLStartMode(int iSSLStartMode);

Default Value

3

Remarks

The SSLStartMode property may have one of the following values:

Data Type

Integer

SystemType Property (SMPP Class)

This property contains a string representing the type of system during a connection.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSystemType();
int SetSystemType(const char* lpszSystemType);

Unicode (Windows)
LPWSTR GetSystemType();
INT SetSystemType(LPCWSTR lpszSystemType);

char* ipworks_smpp_getsystemtype(void* lpObj);
int ipworks_smpp_setsystemtype(void* lpObj, const char* lpszSystemType);

QString GetSystemType();
int SetSystemType(QString qsSystemType);

Default Value

""

Remarks

This property contains a string representing the type of system during a connection. Some SMS servers require that a system type be supplied during connection. The system type is a string representation, usually as an abbreviation, of a particular kind of system. The string cannot exceed 12 bytes.

Data Type

String

Timeout Property (SMPP Class)

A timeout for the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTimeout();
int SetTimeout(int iTimeout);

Unicode (Windows)
INT GetTimeout();
INT SetTimeout(INT iTimeout);

int ipworks_smpp_gettimeout(void* lpObj);
int ipworks_smpp_settimeout(void* lpObj, int iTimeout);

int GetTimeout();
int SetTimeout(int iTimeout);

Default Value

60

Remarks

If the Timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If Timeout is set to a positive value, the class will wait for the operation to complete before returning control.

The class will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not "freeze" and remains responsive.

If Timeout expires, and the operation is not yet complete, the class fails with an error.

Please note that by default, all timeouts are inactivity timeouts, i.e. the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the Timeout property is 60 seconds.

Data Type

Integer

UserId Property (SMPP Class)

This property is used for identification with the SMPP service.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetUserId();
int SetUserId(const char* lpszUserId);

Unicode (Windows)
LPWSTR GetUserId();
INT SetUserId(LPCWSTR lpszUserId);

char* ipworks_smpp_getuserid(void* lpObj);
int ipworks_smpp_setuserid(void* lpObj, const char* lpszUserId);

QString GetUserId();
int SetUserId(QString qsUserId);

Default Value

""

Remarks

This property is used for identification with the SMPP service. When binding to the SMPPServer, the client must provide a known user identifier and a valid password for that Id.

The two ways to bind are (1) by calling Connect with a user Id and password, which will set the UserId and Password properties before connecting; or (2) by setting those two properties and calling SendMessage while not connected.

Data Type

String

AddRecipient Method (SMPP Class)

This method will add a recipient of the specified type to the recipient list.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int AddRecipient(int iRecipientType, const char* lpszRecipientAddress);

Unicode (Windows)
INT AddRecipient(INT iRecipientType, LPCWSTR lpszRecipientAddress);

int ipworks_smpp_addrecipient(void* lpObj, int iRecipientType, const char* lpszRecipientAddress);

int AddRecipient(int iRecipientType, const QString& qsRecipientAddress);

Remarks

This method will add a recipient of the specified type to the recipient list. For normal-type recipients, the addresses should be either a dotted IPv4 address (for sending messages to other SMS-enabled applications) or the directory number of a mobile phone. To send messages to distributed lists, the name of the list should be used.

Valid values for RecipientType are as follows:

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

CancelMessage Method (SMPP Class)

This method will cancel the specified message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int CancelMessage(const char* lpszMessageId);

Unicode (Windows)
INT CancelMessage(LPCWSTR lpszMessageId);

int ipworks_smpp_cancelmessage(void* lpObj, const char* lpszMessageId);

int CancelMessage(const QString& qsMessageId);

Remarks

This method will cancel the message stored on the SMPPServer under the value in MessageId.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

CheckLink Method (SMPP Class)

This method will check the connection to the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int CheckLink();

Unicode (Windows)
INT CheckLink();

int ipworks_smpp_checklink(void* lpObj);

int CheckLink();

Remarks

This method will check the connection to the server. This method is used to ensure that the host on the other end of the connection is still active, or that it is still available. Although a socket connection may still be available between the client and server, the SMS application on the server may have been taken offline without releasing the socket or the CPU may be bogged down. This method will send a PDU to the server and wait the length of Timeout for a response.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

CheckMessageStatus Method (SMPP Class)

This method will retrieve the status of the specified message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int CheckMessageStatus(const char* lpszMessageId);

Unicode (Windows)
INT CheckMessageStatus(LPCWSTR lpszMessageId);

int ipworks_smpp_checkmessagestatus(void* lpObj, const char* lpszMessageId);

int CheckMessageStatus(const QString& qsMessageId);

Remarks

This method will retrieve the last known status of the message stored on the server under MessageId. The class will fire a MessageStatus containing the parsed response from the server.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Config Method (SMPP Class)

Sets or retrieves a configuration setting.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

char* ipworks_smpp_config(void* lpObj, const char* lpszConfigurationString);

QString Config(const QString& qsConfigurationString);

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.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

Connect Method (SMPP Class)

This method will bind as a transceiver to the SMPP service.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Connect();

Unicode (Windows)
INT Connect();

int ipworks_smpp_connect(void* lpObj);

int Connect();

Remarks

This method will establish a socket connection to the SMPPServer and attempt to bind as a transceiver. Once the bind operation has been completed, a Connected event will be fired containing the status of the connection.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ConnectTo Method (SMPP Class)

This method will bind as a transceiver to the SMPP service.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ConnectTo(const char* lpszUserId, const char* lpszPassword);

Unicode (Windows)
INT ConnectTo(LPCWSTR lpszUserId, LPCWSTR lpszPassword);

int ipworks_smpp_connectto(void* lpObj, const char* lpszUserId, const char* lpszPassword);

int ConnectTo(const QString& qsUserId, const QString& qsPassword);

Remarks

This method will establish a socket connection to the SMPPServer and attempt to bind as a transceiver. Once the bind operation has completed, a Connected event will be fired containing the status of the connection.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Disconnect Method (SMPP Class)

This method will disconnect from the SMPP service.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Disconnect();

Unicode (Windows)
INT Disconnect();

int ipworks_smpp_disconnect(void* lpObj);

int Disconnect();

Remarks

This method will send an unbind command and close the socket connection to the SMPPServer. After an unbind operation and socket closing, a Disconnected event will be fired containing the status of the unbind operation.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

DoEvents Method (SMPP Class)

This method processes events from the internal message queue.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DoEvents();

Unicode (Windows)
INT DoEvents();

int ipworks_smpp_doevents(void* lpObj);

int DoEvents();

Remarks

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Interrupt Method (SMPP Class)

Interrupt the current method.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Interrupt();

Unicode (Windows)
INT Interrupt();

int ipworks_smpp_interrupt(void* lpObj);

int Interrupt();

Remarks

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ReplaceMessage Method (SMPP Class)

This method replaces a previously sent message with a new one.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ReplaceMessage(const char* lpszMessageId, const char* lpszNewMessage);

Unicode (Windows)
INT ReplaceMessage(LPCWSTR lpszMessageId, LPCWSTR lpszNewMessage);

int ipworks_smpp_replacemessage(void* lpObj, const char* lpszMessageId, const char* lpszNewMessage);

int ReplaceMessage(const QString& qsMessageId, const QString& qsNewMessage);

Remarks

Assuming that a message on the SMPPServer is being stored under the value in MessageId, this method will replace that message with the value in NewMessage.

If no message corresponds to MessageId, the SMS service will respond with an error message.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Reset Method (SMPP Class)

Reset the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int ipworks_smpp_reset(void* lpObj);

int Reset();

Remarks

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

SendCommand Method (SMPP Class)

This method will format and send a protocol data unit (PDU) using the specified command identifier and payload.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* SendCommand(int iCommandId, const char* lpPayload, int lenPayload, int *lpSize = NULL);

Unicode (Windows)
LPSTR SendCommand(INT iCommandId, LPCSTR lpPayload, INT lenPayload, LPINT lpSize = NULL);

char* ipworks_smpp_sendcommand(void* lpObj, int iCommandId, const char* lpPayload, int lenPayload, int *lpSize);

QByteArray SendCommand(int iCommandId, QByteArray qbaPayload);

Remarks

This method offers a way to do more with the class than is directly supported. This method takes a command identifier and a payload, which includes every required and optional field after the header, and creates the 16-byte header for it before sending it to the server. The response PDU is returned both in the PITrail and by this method.

Error Handling (C++)

This method returns a Binary String value (with length lpSize); after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

SendData Method (SMPP Class)

This method sends raw data to Recipients .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* SendData(const char* lpData, int lenData);

Unicode (Windows)
LPWSTR SendData(LPCSTR lpData, INT lenData);

char* ipworks_smpp_senddata(void* lpObj, const char* lpData, int lenData);

QString SendData(QByteArray qbaData);

Remarks

This method sends raw data to Recipients. Up to 64 KB of additional data can be supplied at a time for transmission to the SMPPServer. Unlike the SendMessage method, this method can send to only one destination at a time. The target is whatever value is in the Recipients properties.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

SendMessage Method (SMPP Class)

This method sends a message to all recipients in the recipient list.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* SendMessage(const char* lpszMessage);

Unicode (Windows)
LPWSTR SendMessage(LPCWSTR lpszMessage);

char* ipworks_smpp_sendmessage(void* lpObj, const char* lpszMessage);

QString SendMessage(const QString& qsMessage);

Remarks

This method sends a message to all recipients in the recipient list. The return value of this method is the server-assigned identifier of the message. The maximum size of the message sent is 256 bytes.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

Connected Event (SMPP Class)

This event is fired after a successful bind operation.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireConnected(SMPPConnectedEventParams *e);

typedef struct {
  int StatusCode;
  const char *Description;
  int reserved;
} SMPPConnectedEventParams;


Unicode (Windows)
virtual INT FireConnected(SMPPConnectedEventParams *e);

typedef struct {
  INT StatusCode;
  LPCWSTR Description;
  INT reserved;
} SMPPConnectedEventParams;

#define EID_SMPP_CONNECTED 1

virtual INT IPWORKS_CALL FireConnected(INT &iStatusCode, LPSTR &lpszDescription);

class SMPPConnectedEventParams {
public:
  int StatusCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Connected(SMPPConnectedEventParams *e);

// Or, subclass SMPP and override this emitter function.
virtual int FireConnected(SMPPConnectedEventParams *e) {...}

Remarks

After establishing a socket connection to the SMPPServer, the class will attempt to send a bind as a transmitter command. Upon completion of this operation, the server will respond with either a success or failure state, which will be reflected in the Connected event's parameters.

StatusCode will contain the command status (error code) returned by the server. For a StatusCode of 0, Description will be OK. Otherwise, it will contain a standard interpretation of the error.

ConnectionStatus Event (SMPP Class)

This event is fired to indicate changes in the connection state.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireConnectionStatus(SMPPConnectionStatusEventParams *e);

typedef struct {
  const char *ConnectionEvent;
  int StatusCode;
  const char *Description;
  int reserved;
} SMPPConnectionStatusEventParams;


Unicode (Windows)
virtual INT FireConnectionStatus(SMPPConnectionStatusEventParams *e);

typedef struct {
  LPCWSTR ConnectionEvent;
  INT StatusCode;
  LPCWSTR Description;
  INT reserved;
} SMPPConnectionStatusEventParams;

#define EID_SMPP_CONNECTIONSTATUS 2

virtual INT IPWORKS_CALL FireConnectionStatus(LPSTR &lpszConnectionEvent, INT &iStatusCode, LPSTR &lpszDescription);

class SMPPConnectionStatusEventParams {
public:
  const QString &ConnectionEvent();

  int StatusCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void ConnectionStatus(SMPPConnectionStatusEventParams *e);

// Or, subclass SMPP and override this emitter function.
virtual int FireConnectionStatus(SMPPConnectionStatusEventParams *e) {...}

Remarks

The ConnectionStatus event is fired when the connection state changes: for example, completion of a firewall or proxy connection or completion of a security handshake.

The ConnectionEvent parameter indicates the type of connection event. Values may include the following:

Disconnected Event (SMPP Class)

This event is fired when connection to the SMS service is lost.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireDisconnected(SMPPDisconnectedEventParams *e);

typedef struct {
  int StatusCode;
  const char *Description;
  int reserved;
} SMPPDisconnectedEventParams;


Unicode (Windows)
virtual INT FireDisconnected(SMPPDisconnectedEventParams *e);

typedef struct {
  INT StatusCode;
  LPCWSTR Description;
  INT reserved;
} SMPPDisconnectedEventParams;

#define EID_SMPP_DISCONNECTED 3

virtual INT IPWORKS_CALL FireDisconnected(INT &iStatusCode, LPSTR &lpszDescription);

class SMPPDisconnectedEventParams {
public:
  int StatusCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Disconnected(SMPPDisconnectedEventParams *e);

// Or, subclass SMPP and override this emitter function.
virtual int FireDisconnected(SMPPDisconnectedEventParams *e) {...}

Remarks

After sending an unbind operation to the server, this event will be fired containing the results of that operation. This event may also be fired if the socket connection to the service is lost.

If the event was fired because of an unbind operation, StatusCode will contain the command status set by the server. Otherwise, it will contain the socket code for the type of disconnection. For a status code value of 0, Description will contain OK. Otherwise, it will contain a standard interpretation of the value in StatusCode.

Error Event (SMPP Class)

This event is fired when the server detects an error.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireError(SMPPErrorEventParams *e);

typedef struct {
  int ErrorCode;
  const char *Description;
  int reserved;
} SMPPErrorEventParams;


Unicode (Windows)
virtual INT FireError(SMPPErrorEventParams *e);

typedef struct {
  INT ErrorCode;
  LPCWSTR Description;
  INT reserved;
} SMPPErrorEventParams;

#define EID_SMPP_ERROR 4

virtual INT IPWORKS_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);

class SMPPErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Error(SMPPErrorEventParams *e);

// Or, subclass SMPP and override this emitter function.
virtual int FireError(SMPPErrorEventParams *e) {...}

Remarks

If the server sends an error not related to a command sent from the class, the class will fire an Error event containing information related to the error.

ErrorCode will contain the code sent by the server, and Description will contain a standard interpretation of that code.

MessageIn Event (SMPP Class)

This event is fired upon receipt of a message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireMessageIn(SMPPMessageInEventParams *e);

typedef struct {
  const char *SourceAddress;
  const char *ScheduleDeliveryTime;
  const char *ValidityPeriod;
  const char *Message;
  int MessagePart;
  int MessagePartCount;
  int MessagePartReference;
  const char *DestinationAddress;
  int ResponseErrorCode;
  int reserved;
} SMPPMessageInEventParams;


Unicode (Windows)
virtual INT FireMessageIn(SMPPMessageInEventParams *e);

typedef struct {
  LPCWSTR SourceAddress;
  LPCWSTR ScheduleDeliveryTime;
  LPCWSTR ValidityPeriod;
  LPCWSTR Message;
  INT MessagePart;
  INT MessagePartCount;
  INT MessagePartReference;
  LPCWSTR DestinationAddress;
  INT ResponseErrorCode;
  INT reserved;
} SMPPMessageInEventParams;

#define EID_SMPP_MESSAGEIN 5

virtual INT IPWORKS_CALL FireMessageIn(LPSTR &lpszSourceAddress, LPSTR &lpszScheduleDeliveryTime, LPSTR &lpszValidityPeriod, LPSTR &lpszMessage, INT &iMessagePart, INT &iMessagePartCount, INT &iMessagePartReference, LPSTR &lpszDestinationAddress, INT &iResponseErrorCode);

class SMPPMessageInEventParams {
public:
  const QString &SourceAddress();

  const QString &ScheduleDeliveryTime();

  const QString &ValidityPeriod();

  const QString &Message();

  int MessagePart();

  int MessagePartCount();

  int MessagePartReference();

  const QString &DestinationAddress();

  int ResponseErrorCode();
  void SetResponseErrorCode(int iResponseErrorCode);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void MessageIn(SMPPMessageInEventParams *e);

// Or, subclass SMPP and override this emitter function.
virtual int FireMessageIn(SMPPMessageInEventParams *e) {...}

Remarks

When a message is received, the SMPP class will parse the sender's message into the SourceAddress, ScheduleDeliveryTime, ValidityPeriod, and Message fields.

The SourceAddress parameter is the address of the originator of the message.

The DestinationAddress parameter holds the address of the recipient.

The ScheduleDeliveryTime parameter is the delivery time at which the short message is scheduled to be forwarded to another Message Center (MC). This will be an empty string if it is not scheduled.

The ValidityPeriod parameter is applicable only if this short message is being forwarded to another MC. When this occurs, it specifies how long the receiving MC should retain the Short Message (SM) and continue trying to deliver it. This will be an empty string if the current validity period is unavailable.

The Message parameter is the plaintext portion of the message body.

If the incoming message is a part of a larger message (the message was split up into several parts), the MessagePartCount, MessagePart, and MessagePartReference parameters will be set. MessagePartCount will hold the total number of parts for the message. MessagePart will indicate the current part's location in the message to determine the order when reassembling the message. This will be a value from 1 to MessagePartCount. MessagePartReference holds a reference value that will be the same across all parts for the message.

The ResponseErrorCode parameter may be set to return an error condition to the server. This corresponds to the command_status protocol-level field of the response.

MessageStatus Event (SMPP Class)

This event is fired upon receipt of a message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireMessageStatus(SMPPMessageStatusEventParams *e);

typedef struct {
  const char *MessageId;
  int MessageState;
  int MessageError;
  const char *FinalDate;
  int reserved;
} SMPPMessageStatusEventParams;


Unicode (Windows)
virtual INT FireMessageStatus(SMPPMessageStatusEventParams *e);

typedef struct {
  LPCWSTR MessageId;
  INT MessageState;
  INT MessageError;
  LPCWSTR FinalDate;
  INT reserved;
} SMPPMessageStatusEventParams;

#define EID_SMPP_MESSAGESTATUS 6

virtual INT IPWORKS_CALL FireMessageStatus(LPSTR &lpszMessageId, INT &iMessageState, INT &iMessageError, LPSTR &lpszFinalDate);

class SMPPMessageStatusEventParams {
public:
  const QString &MessageId();

  int MessageState();

  int MessageError();

  const QString &FinalDate();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void MessageStatus(SMPPMessageStatusEventParams *e);

// Or, subclass SMPP and override this emitter function.
virtual int FireMessageStatus(SMPPMessageStatusEventParams *e) {...}

Remarks

When a CheckMessageStatus is called, the SMPP class will fetch the status of the message represented by MessageId from the server, parse the response, and fire MessageStatus.

MessageState represents the last known state the message was left in on the SMPPServer. This code is version specific. For v3.4:

MessageError will contain an error code representing any failure encountered during message delivery. This code may be vendor-specific.

FinalDate contains a human-readable string representing the date on which the message was delivered. If the message was not delivered, this parameter will be empty.

PITrail Event (SMPP Class)

This event is fired once for each protocol data unit (PDU) sent between the client and server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FirePITrail(SMPPPITrailEventParams *e);

typedef struct {
  int Direction;
  const char *PDU;
  int lenPDU;
  int CommandLength;
  int CommandId;
  const char *CommandDescription;
  const char *CommandStatus;
  int SequenceNumber;
  int reserved;
} SMPPPITrailEventParams;


Unicode (Windows)
virtual INT FirePITrail(SMPPPITrailEventParams *e);

typedef struct {
  INT Direction;
  LPCSTR PDU;
  INT lenPDU;
  INT CommandLength;
  INT CommandId;
  LPCWSTR CommandDescription;
  LPCWSTR CommandStatus;
  INT SequenceNumber;
  INT reserved;
} SMPPPITrailEventParams;

#define EID_SMPP_PITRAIL 7

virtual INT IPWORKS_CALL FirePITrail(INT &iDirection, LPSTR &lpPDU, INT &lenPDU, INT &iCommandLength, INT &iCommandId, LPSTR &lpszCommandDescription, LPSTR &lpszCommandStatus, INT &iSequenceNumber);

class SMPPPITrailEventParams {
public:
  int Direction();

  const QByteArray &PDU();

  int CommandLength();

  int CommandId();

  const QString &CommandDescription();

  const QString &CommandStatus();

  int SequenceNumber();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void PITrail(SMPPPITrailEventParams *e);

// Or, subclass SMPP and override this emitter function.
virtual int FirePITrail(SMPPPITrailEventParams *e) {...}

Remarks

Whenever either the class or the SMPPServer sends any data across the connection, the class will fire a PITrail event containing that data. It will usually be in SMPP-PDU format.

A PDU will contain at least the SMPP header, which is always 16 bytes long. The first four bytes represent the total length of the PDU, including the 16-byte header. The next four bytes are the command Id associated with the PDU. The command Id of a response PDU is always the command Id to which it is responding plus 0x80000000.

The class parses the values contained in the PDU header into the appropriate fields. The CommandLength, CommandId, CommandStatus, and SequenceNumber parameters contain these parsed values.

The third set of four bytes are the command status (status code) of the command. All originating commands will have a status code of 0x00000000, which will be ignored by the receiver. The field is only set in response PDUs to indicate the status of the originating command. The final four bytes represent the sequence number of the command. All response PDUs will contain the same sequence number as the originating command.

ReadyToSend Event (SMPP Class)

This event is fired when the class is ready to send data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireReadyToSend(SMPPReadyToSendEventParams *e);

typedef struct {
  int reserved;
} SMPPReadyToSendEventParams;


Unicode (Windows)
virtual INT FireReadyToSend(SMPPReadyToSendEventParams *e);

typedef struct {
  INT reserved;
} SMPPReadyToSendEventParams;

#define EID_SMPP_READYTOSEND 8

virtual INT IPWORKS_CALL FireReadyToSend();

class SMPPReadyToSendEventParams {
public:
  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void ReadyToSend(SMPPReadyToSendEventParams *e);

// Or, subclass SMPP and override this emitter function.
virtual int FireReadyToSend(SMPPReadyToSendEventParams *e) {...}

Remarks

The ReadyToSend event indicates that the underlying Transmission Control Protocol (TCP)/IP subsystem is ready to accept data after a failed DataToSend. This event also is fired immediately after a connection to the remote host is established.

SSLServerAuthentication Event (SMPP Class)

Fired after the server presents its certificate to the client.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSLServerAuthentication(SMPPSSLServerAuthenticationEventParams *e);

typedef struct {
  const char *CertEncoded;
  int lenCertEncoded;
  const char *CertSubject;
  const char *CertIssuer;
  const char *Status;
  int Accept;
  int reserved;
} SMPPSSLServerAuthenticationEventParams;


Unicode (Windows)
virtual INT FireSSLServerAuthentication(SMPPSSLServerAuthenticationEventParams *e);

typedef struct {
  LPCSTR CertEncoded;
  INT lenCertEncoded;
  LPCWSTR CertSubject;
  LPCWSTR CertIssuer;
  LPCWSTR Status;
  BOOL Accept;
  INT reserved;
} SMPPSSLServerAuthenticationEventParams;

#define EID_SMPP_SSLSERVERAUTHENTICATION 9

virtual INT IPWORKS_CALL FireSSLServerAuthentication(LPSTR &lpCertEncoded, INT &lenCertEncoded, LPSTR &lpszCertSubject, LPSTR &lpszCertIssuer, LPSTR &lpszStatus, BOOL &bAccept);

class SMPPSSLServerAuthenticationEventParams {
public:
  const QByteArray &CertEncoded();

  const QString &CertSubject();

  const QString &CertIssuer();

  const QString &Status();

  bool Accept();
  void SetAccept(bool bAccept);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SSLServerAuthentication(SMPPSSLServerAuthenticationEventParams *e);

// Or, subclass SMPP and override this emitter function.
virtual int FireSSLServerAuthentication(SMPPSSLServerAuthenticationEventParams *e) {...}

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

Fired when secure connection progress messages are available.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSLStatus(SMPPSSLStatusEventParams *e);

typedef struct {
  const char *Message;
  int reserved;
} SMPPSSLStatusEventParams;


Unicode (Windows)
virtual INT FireSSLStatus(SMPPSSLStatusEventParams *e);

typedef struct {
  LPCWSTR Message;
  INT reserved;
} SMPPSSLStatusEventParams;

#define EID_SMPP_SSLSTATUS 10

virtual INT IPWORKS_CALL FireSSLStatus(LPSTR &lpszMessage);

class SMPPSSLStatusEventParams {
public:
  const QString &Message();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SSLStatus(SMPPSSLStatusEventParams *e);

// Or, subclass SMPP and override this emitter function.
virtual int FireSSLStatus(SMPPSSLStatusEventParams *e) {...}

Remarks

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

Config Settings (SMPP Class)

SMPP Config Settings

[UDH1],[MessagePart1];[UDH2],[MessagePart2];[UDH3],[MessagePart3]

TCPClient Config Settings

SSL Config Settings

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

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

Socket Config Settings

Base Config Settings

Trappable Errors (SMPP Class)

Error Handling (C++)

Call the GetLastErrorCode() method to obtain the last called method's result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

SMPP 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