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

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

SMPP.Connected Property

This property indicates whether or not the class is bound.

Syntax

isConnected(): boolean;

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.

SMPP.Firewall Property

A set of properties related to firewall access.

Syntax

getFirewall(): Firewall;
setFirewall(firewall: Firewall): void;

Default Value

Remarks

This is a Firewall type property which contains fields describing the firewall through which the class will attempt to connect.

SMPP.Idle Property

The current status of the class.

Syntax

isIdle(): boolean;

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.

SMPP.LocalHost Property

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

Syntax

getLocalHost(): string;
setLocalHost(localHost: string): void;

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.

SMPP.MessageExpiration Property

This property denotes the validity period of the current message.

Syntax

getMessageExpiration(): string;
setMessageExpiration(messageExpiration: string): void;

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

SMPP.MessageId Property

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

Syntax

getMessageId(): string;

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.

SMPP.MessagePriority Property

This property indicates the priority level of the current message.

Syntax

getMessagePriority(): SmppMessagePriorities;
setMessagePriority(messagePriority: SmppMessagePriorities): void;

enum SmppMessagePriorities {
  smppMessagePriorityLow,
  smppMessagePriorityNormal,
  smppMessagePriorityHigh,
  smppMessagePriorityUrgent
}

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.

SMPP.Password Property

This property contains the user's password.

Syntax

getPassword(): string;
setPassword(password: string): void;

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.

SMPP.Protocol Property

This property defines the SMPP protocol to be used.

Syntax

getProtocol(): SmppProtocols;
setProtocol(protocol: SmppProtocols): void;

enum SmppProtocols {
  smppSMPP,
  smppCIMD2
}

Default Value

0

Remarks

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

SMPP.Recipients Property

This property includes the list of message recipients.

Syntax

getRecipients(): SMPPRecipientList;
setRecipients(recipients: SMPPRecipientList): void;

Default Value

Remarks

This property is used to specify the recipient(s) of the message. Each recipient is represented by an SMPPRecipient type, which contains fields for the address and type of address for the recipient.

An AddRecipient method also may be used to add recipients to this collection property.

SMPP.ScheduledDelivery Property

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

Syntax

getScheduledDelivery(): string;
setScheduledDelivery(scheduledDelivery: string): void;

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

SMPP.SenderAddress Property

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

Syntax

getSenderAddress(): string;
setSenderAddress(senderAddress: string): void;

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.

SMPP.ServiceType Property

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

Syntax

getServiceType(): SmppServiceTypes;
setServiceType(serviceType: SmppServiceTypes): void;

enum SmppServiceTypes {
  smppServiceDefault,
  smppServiceCMT,
  smppServiceCPT,
  smppServiceVMN,
  smppServiceVMA,
  smppServiceWAP,
  smppServiceUSSD,
  smppServiceCBS
}

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:

SMPP.SMPPPort Property

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

Syntax

getSMPPPort(): number;
setSMPPPort(SMPPPort: number): void;

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.

SMPP.SMPPServer Property

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

Syntax

getSMPPServer(): string;
setSMPPServer(SMPPServer: string): void;

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.

SMPP.SMPPVersion Property

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

Syntax

getSMPPVersion(): SmppSMPPVersions;
setSMPPVersion(SMPPVersion: SmppSMPPVersions): void;

enum SmppSMPPVersions {
  smppVersion50,
  smppVersion34,
  smppVersion33
}

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.

SMPP.SSLAcceptServerCert Property

Instructs the class to unconditionally accept the server certificate that matches the supplied certificate.

Syntax

getSSLAcceptServerCert(): Certificate;
setSSLAcceptServerCert(SSLAcceptServerCert: Certificate): void;

Default Value

Remarks

If it finds any issues with the certificate presented by the server, the class will normally terminate the connection with an error.

You may override this behavior by supplying a value for SSLAcceptServerCert. If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally.

Please note that this functionality is provided only for cases where you otherwise know that you are communicating with the right server. If used improperly, this property may create a security breach. Use it at your own risk.

SMPP.SSLCert Property

The certificate to be used during SSL negotiation.

Syntax

getSSLCert(): Certificate;
setSSLCert(SSLCert: Certificate): void;

Default Value

Remarks

The digital certificate that the class will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the field to the encoded certificate. To select a certificate, use the store and subject fields.

SMPP.SSLEnabled Property

Whether TLS/SSL is enabled.

Syntax

isSSLEnabled(): boolean;
setSSLEnabled(SSLEnabled: boolean): void;

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.

SMPP.SSLProvider Property

This specifies the SSL/TLS implementation to use.

Syntax

getSSLProvider(): SmppSSLProviders;
setSSLProvider(SSLProvider: SmppSSLProviders): void;

enum SmppSSLProviders {
  sslpAutomatic,
  sslpPlatform,
  sslpInternal
}

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 the platform implementation will be used by default in all cases in the JavaScript edition.

Note: The Internal provider is not support at this time.

SMPP.SSLServerCert Property

The server certificate for the last established connection.

Syntax

getSSLServerCert(): Certificate;

Default Value

Remarks

SSLServerCert contains the server certificate for the last established connection.

SSLServerCert is reset every time a new connection is attempted.

This property is read-only.

SMPP.SSLStartMode Property

Determines how the class starts the SSL negotiation.

Syntax

getSSLStartMode(): SmppSSLStartModes;
setSSLStartMode(SSLStartMode: SmppSSLStartModes): void;

enum SmppSSLStartModes {
  sslAutomatic,
  sslImplicit,
  sslExplicit,
  sslNone
}

Default Value

3

Remarks

The SSLStartMode property may have one of the following values:

SMPP.SystemType Property

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

Syntax

getSystemType(): string;
setSystemType(systemType: string): void;

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.

SMPP.Timeout Property

A timeout for the class.

Syntax

getTimeout(): number;
setTimeout(timeout: number): void;

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 .

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.

SMPP.UserId Property

This property is used for identification with the SMPP service.

Syntax

getUserId(): string;
setUserId(userId: string): void;

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.

SMPP.addRecipient Method

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

Syntax

async smpp.addRecipient(recipientType : number, recipientAddress : string): Promise<void>

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:

SMPP.cancelMessage Method

This method will cancel the specified message.

Syntax

async smpp.cancelMessage(messageId : string): Promise<void>

Remarks

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

SMPP.checkLink Method

This method will check the connection to the server.

Syntax

async smpp.checkLink(): Promise<void>

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.

SMPP.checkMessageStatus Method

This method will retrieve the status of the specified message.

Syntax

async smpp.checkMessageStatus(messageId : string): Promise<void>

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.

SMPP.config Method

Sets or retrieves a configuration setting.

Syntax

async smpp.config(configurationString : string): Promise<string>

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.

SMPP.connect Method

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

Syntax

async smpp.connect(): Promise<void>

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.

SMPP.connectTo Method

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

Syntax

async smpp.connectTo(userId : string, password : string): Promise<void>

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.

SMPP.disconnect Method

This method will disconnect from the SMPP service.

Syntax

async smpp.disconnect(): Promise<void>

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.

SMPP.doEvents Method

This method processes events from the internal message queue.

Syntax

async smpp.doEvents(): Promise<void>

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.

SMPP.interrupt Method

Interrupt the current method.

Syntax

async smpp.interrupt(): Promise<void>

Remarks

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

SMPP.replaceMessage Method

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

Syntax

async smpp.replaceMessage(messageId : string, newMessage : string): Promise<void>

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.

SMPP.reset Method

Reset the class.

Syntax

async smpp.reset(): Promise<void>

Remarks

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

SMPP.sendCommand Method

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

Syntax

async smpp.sendCommand(commandId : number, payload : Uint8Array): Promise<Uint8Array>

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.

SMPP.sendData Method

This method sends raw data to Recipients .

Syntax

async smpp.sendData(data : Uint8Array): Promise<string>

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.

SMPP.sendMessage Method

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

Syntax

async smpp.sendMessage(message : string): Promise<string>

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.

SMPP.Connected Event

This event is fired after a successful bind operation.

Syntax

smpp.on('Connected', listener: (e: {readonly statusCode: number, readonly description: string}) => void )

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.

SMPP.ConnectionStatus Event

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

Syntax

smpp.on('ConnectionStatus', listener: (e: {readonly connectionEvent: string, readonly statusCode: number, readonly description: string}) => void )

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:

SMPP.Disconnected Event

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

Syntax

smpp.on('Disconnected', listener: (e: {readonly statusCode: number, readonly description: string}) => void )

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.

SMPP.Error Event

This event is fired when the server detects an error.

Syntax

smpp.on('Error', listener: (e: {readonly errorCode: number, readonly description: string}) => void )

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.

SMPP.MessageIn Event

This event is fired upon receipt of a message.

Syntax

smpp.on('MessageIn', listener: (e: {readonly sourceAddress: string, readonly scheduleDeliveryTime: string, readonly validityPeriod: string, readonly message: string, readonly messagePart: number, readonly messagePartCount: number, readonly messagePartReference: number, readonly destinationAddress: string, responseErrorCode: number}) => void )

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.

SMPP.MessageStatus Event

This event is fired upon receipt of a message.

Syntax

smpp.on('MessageStatus', listener: (e: {readonly messageId: string, readonly messageState: number, readonly messageError: number, readonly finalDate: string}) => void )

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.

SMPP.PITrail Event

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

Syntax

smpp.on('PITrail', listener: (e: {readonly direction: number, readonly PDU: string, readonly PDUB: Uint8Array, readonly commandLength: number, readonly commandId: number, readonly commandDescription: string, readonly commandStatus: string, readonly sequenceNumber: number}) => void )

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.

SMPP.ReadyToSend Event

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

Syntax

smpp.on('ReadyToSend', listener: (e: {}) => void )

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.

SMPP.SSLServerAuthentication Event

Fired after the server presents its certificate to the client.

Syntax

smpp.on('SSLServerAuthentication', listener: (e: {readonly certEncoded: string, readonly certEncodedB: Uint8Array, readonly certSubject: string, readonly certIssuer: string, readonly status: string, accept: boolean}) => void )

Remarks

This event fires with information about the server certificate. The Status property shows why verification failed (otherwise, Status contains the string "OK"). To manually accept an untrusted certificate, the SSLAcceptAnyServerCert setting must be set to True before intiating the connection.

SMPP.SSLStatus Event

Shows the progress of the secure connection.

Syntax

smpp.on('SSLStatus', listener: (e: {readonly message: string}) => void )

Remarks

The event is fired for informational and logging purposes only. Used to track the progress of the connection.

Certificate Type

This is the digital certificate being used.

Remarks

This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.

Fields

Constructors

public Certificate();

Creates a Certificate instance whose properties can be set. This is useful for use with CERTMGR when generating new certificates.

public Certificate(String certificateFile);

Opens CertificateFile and reads out the contents as an X509 public key.

public Certificate(byte[] certificateData);

Parses CertificateData as an X509 public key.

public Certificate(int certStoreType, String store, String storePassword, String subject);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).

public Certificate(int certStoreType, String store, String storePassword, String subject, String configurationString);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. ConfigurationString is a newline separated list of name-value pairs that may be used to modify the default behavior. Possible values include "PersistPFXKey", which shows whether or not the PFX key is persisted after performing operations with the private key. This correlates to the PKCS12_NO_PERSIST_KEY CyrptoAPI option. The default value is True (the key is persisted). "Thumbprint" - a MD5, SHA1, or SHA256 thumbprint of the certificate to load. When specified, this value is used to select the certificate in the store. This is applicable to cstUser, cstMachine, cstPublicKeyFile, and cstPFXFile store types. "UseInternalSecurityAPI" shows whether the platform (default) or the internal security API is used when performing certificate-related operations. After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).

public Certificate(int certStoreType, String store, String storePassword, byte[] encoded);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will load Encoded as an X509 certificate and search the opened store for a corresponding private key.

public Certificate(int certStoreType, byte[] storeBlob, String storePassword, String subject);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. StoreBlob is a string (binary- or base64-encoded) containing the certificate data. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).

public Certificate(int certStoreType, byte[] storeBlob, String storePassword, String subject, String configurationString);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. StoreBlob is a string (binary- or base64-encoded) containing the certificate data. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).

public Certificate(int certStoreType, byte[] storeBlob, String storePassword, byte[] encoded);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a string (binary- or base64-encoded) containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will load Encoded as an X509 certificate and search the opened store for a corresponding private key.

Firewall Type

This is the firewall the class will connect through.

Remarks

When connecting through a firewall, this type is used to specify different properties of the firewall, such as the firewall and the .

Fields

Constructors

public Firewall();

SMPPRecipient Type

This type describes a recipient of the SMPP message.

Remarks

This type describes a recipient of the SMPP message that is being sent. The fields describe the of recipient and the of the recipient of the message.

Fields

Constructors

public SMPPRecipient();

public SMPPRecipient(String address);

public SMPPRecipient(String address, int recipientType);

Config Settings (class ipworks.smpp)

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 (class ipworks.smpp)

SMPP Errors

TCPClient Errors

SSL Errors

TCP/IP Errors