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

class 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 on_ssl_server_authentication event allows you to check the server identity and other security attributes. The on_ssl_status 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 smpp_server, smpp_port, and, if needed, the smpp_version 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 add_recipient method to add recipients one at a time to the recipient list. After all recipients have been added, a single call to the send_message method will transmit the specified message. If the send is successful, the method will set and return the value of the message_id property. Otherwise, an on_error event will fire for each unsuccessful message destination.

The Smpp Class supports message and data transmission, as well as auxiliary operations, such as check_message_status and replace_message. All nonimplemented features of the protocol are supported through the send_command method and on_pi_trail 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

This property indicates whether or not the class is bound.

Syntax

def get_connected() -> bool: ...

connected = property(get_connected, None)

Default Value

FALSE

Remarks

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

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

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

This property is read-only.

firewall_auto_detect Property

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

Syntax

def get_firewall_auto_detect() -> bool: ...
def set_firewall_auto_detect(value: bool) -> None: ...

firewall_auto_detect = property(get_firewall_auto_detect, set_firewall_auto_detect)

Default Value

FALSE

Remarks

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

firewall_type Property

This property determines the type of firewall to connect through.

Syntax

def get_firewall_type() -> int: ...
def set_firewall_type(value: int) -> None: ...

firewall_type = property(get_firewall_type, set_firewall_type)

Default Value

0

Remarks

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

firewall_host Property

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

Syntax

def get_firewall_host() -> str: ...
def set_firewall_host(value: str) -> None: ...

firewall_host = property(get_firewall_host, set_firewall_host)

Default Value

""

Remarks

This property contains the name or IP address of firewall (optional). If a firewall_host 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.

firewall_password Property

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

Syntax

def get_firewall_password() -> str: ...
def set_firewall_password(value: str) -> None: ...

firewall_password = property(get_firewall_password, set_firewall_password)

Default Value

""

Remarks

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

firewall_port Property

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

Syntax

def get_firewall_port() -> int: ...
def set_firewall_port(value: int) -> None: ...

firewall_port = property(get_firewall_port, set_firewall_port)

Default Value

0

Remarks

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

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

firewall_user Property

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

Syntax

def get_firewall_user() -> str: ...
def set_firewall_user(value: str) -> None: ...

firewall_user = property(get_firewall_user, set_firewall_user)

Default Value

""

Remarks

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

idle Property

The current status of the class.

Syntax

def get_idle() -> bool: ...

idle = property(get_idle, None)

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.

local_host Property

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

Syntax

def get_local_host() -> str: ...
def set_local_host(value: str) -> None: ...

local_host = property(get_local_host, set_local_host)

Default Value

""

Remarks

The local_host 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 local_host 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: local_host is not persistent. You must always set it in code, and never in the property window.

message_expiration Property

This property denotes the validity period of the current message.

Syntax

def get_message_expiration() -> str: ...
def set_message_expiration(value: str) -> None: ...

message_expiration = property(get_message_expiration, set_message_expiration)

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

message_id Property

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

Syntax

def get_message_id() -> str: ...

message_id = property(get_message_id, None)

Default Value

""

Remarks

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

This property is read-only.

message_priority Property

This property indicates the priority level of the current message.

Syntax

def get_message_priority() -> int: ...
def set_message_priority(value: int) -> None: ...

message_priority = property(get_message_priority, set_message_priority)

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.

password Property

This property contains the user's password.

Syntax

def get_password() -> str: ...
def set_password(value: str) -> None: ...

password = property(get_password, set_password)

Default Value

""

Remarks

This property contains the user's password. When binding to the smpp_server, 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 user_id and this property before connecting; or (2) by setting those two properties and calling send_message while not connected.

protocol Property

This property defines the SMPP protocol to be used.

Syntax

def get_protocol() -> int: ...
def set_protocol(value: int) -> None: ...

protocol = property(get_protocol, set_protocol)

Default Value

0

Remarks

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

recipient_count Property

The number of records in the Recipient arrays.

Syntax

def get_recipient_count() -> int: ...
def set_recipient_count(value: int) -> None: ...

recipient_count = property(get_recipient_count, set_recipient_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

• recipient_address
• recipient_type

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

recipient_address Property

This property contains the email address of a particular recipient.

Syntax

def get_recipient_address(recipient_index: int) -> str: ...
def set_recipient_address(recipient_index: int, value: str) -> None: ...

Default Value

""

Remarks

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

For a recipient type of normal, the value in the recipient_address 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 smpp_server.

The recipient_index parameter specifies the index of the item in the array. The size of the array is controlled by the recipient_count property.

recipient_type Property

This property contains the type of a particular recipient.

Syntax

def get_recipient_type(recipient_index: int) -> int: ...
def set_recipient_type(recipient_index: int, value: int) -> None: ...

Default Value

0

Remarks

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

For a recipient type of normal, the value in recipient_address 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 smpp_server.

Valid values for RecipientType are as follows:

The recipient_index parameter specifies the index of the item in the array. The size of the array is controlled by the recipient_count property.

scheduled_delivery Property

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

Syntax

def get_scheduled_delivery() -> str: ...
def set_scheduled_delivery(value: str) -> None: ...

scheduled_delivery = property(get_scheduled_delivery, set_scheduled_delivery)

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

sender_address Property

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

Syntax

def get_sender_address() -> str: ...
def set_sender_address(value: str) -> None: ...

sender_address = property(get_sender_address, set_sender_address)

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

service_type Property

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

Syntax

def get_service_type() -> int: ...
def set_service_type(value: int) -> None: ...

service_type = property(get_service_type, set_service_type)

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_port Property

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

Syntax

def get_smpp_port() -> int: ...
def set_smpp_port(value: int) -> None: ...

smpp_port = property(get_smpp_port, set_smpp_port)

Default Value

2775

Remarks

For an implicit Secure Sockets Layer (SSL), use port 3551 (please refer to the ssl_start_mode 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_server Property

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

Syntax

def get_smpp_server() -> str: ...
def set_smpp_server(value: str) -> None: ...

smpp_server = property(get_smpp_server, set_smpp_server)

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_version Property

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

Syntax

def get_smpp_version() -> int: ...
def set_smpp_version(value: int) -> None: ...

smpp_version = property(get_smpp_version, set_smpp_version)

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.

ssl_accept_server_cert_encoded Property

This is the certificate (PEM/Base64 encoded).

Syntax

def get_ssl_accept_server_cert_encoded() -> bytes: ...
def set_ssl_accept_server_cert_encoded(value: bytes) -> None: ...

ssl_accept_server_cert_encoded = property(get_ssl_accept_server_cert_encoded, set_ssl_accept_server_cert_encoded)

Default Value

""

Remarks

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

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

ssl_cert_encoded Property

This is the certificate (PEM/Base64 encoded).

Syntax

def get_ssl_cert_encoded() -> bytes: ...
def set_ssl_cert_encoded(value: bytes) -> None: ...

ssl_cert_encoded = property(get_ssl_cert_encoded, set_ssl_cert_encoded)

Default Value

""

Remarks

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

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

ssl_cert_store Property

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

Syntax

def get_ssl_cert_store() -> bytes: ...
def set_ssl_cert_store(value: bytes) -> None: ...

ssl_cert_store = property(get_ssl_cert_store, set_ssl_cert_store)

Default Value

"MY"

Remarks

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

The ssl_cert_store_type property denotes the type of the certificate store specified by ssl_cert_store. If the store is password protected, specify the password in ssl_cert_store_password.

ssl_cert_store is used in conjunction with the ssl_cert_subject property to specify client certificates. If ssl_cert_store has a value, and ssl_cert_subject or ssl_cert_encoded is set, a search for a certificate is initiated. Please see the ssl_cert_subject 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).

ssl_cert_store_password Property

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

Syntax

def get_ssl_cert_store_password() -> str: ...
def set_ssl_cert_store_password(value: str) -> None: ...

ssl_cert_store_password = property(get_ssl_cert_store_password, set_ssl_cert_store_password)

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.

ssl_cert_store_type Property

This is the type of certificate store for this certificate.

Syntax

def get_ssl_cert_store_type() -> int: ...
def set_ssl_cert_store_type(value: int) -> None: ...

ssl_cert_store_type = property(get_ssl_cert_store_type, set_ssl_cert_store_type)

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:

ssl_cert_subject Property

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

Syntax

def get_ssl_cert_subject() -> str: ...
def set_ssl_cert_subject(value: str) -> None: ...

ssl_cert_subject = property(get_ssl_cert_subject, set_ssl_cert_subject)

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.

ssl_enabled Property

Whether TLS/SSL is enabled.

Syntax

def get_ssl_enabled() -> bool: ...
def set_ssl_enabled(value: bool) -> None: ...

ssl_enabled = property(get_ssl_enabled, set_ssl_enabled)

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 ssl_start_mode. Setting ssl_start_mode will automatically update this property value.

ssl_provider Property

This specifies the SSL/TLS implementation to use.

Syntax

def get_ssl_provider() -> int: ...
def set_ssl_provider(value: int) -> None: ...

ssl_provider = property(get_ssl_provider, set_ssl_provider)

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.

ssl_server_cert_encoded Property

This is the certificate (PEM/Base64 encoded).

Syntax

def get_ssl_server_cert_encoded() -> bytes: ...

ssl_server_cert_encoded = property(get_ssl_server_cert_encoded, None)

Default Value

""

Remarks

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

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

This property is read-only.

ssl_start_mode Property

Determines how the class starts the SSL negotiation.

Syntax

def get_ssl_start_mode() -> int: ...
def set_ssl_start_mode(value: int) -> None: ...

ssl_start_mode = property(get_ssl_start_mode, set_ssl_start_mode)

Default Value

3

Remarks

The ssl_start_mode property may have one of the following values:

system_type Property

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

Syntax

def get_system_type() -> str: ...
def set_system_type(value: str) -> None: ...

system_type = property(get_system_type, set_system_type)

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.

timeout Property

A timeout for the class.

Syntax

def get_timeout() -> int: ...
def set_timeout(value: int) -> None: ...

timeout = property(get_timeout, set_timeout)

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

user_id Property

This property is used for identification with the SMPP service.

Syntax

def get_user_id() -> str: ...
def set_user_id(value: str) -> None: ...

user_id = property(get_user_id, set_user_id)

Default Value

""

Remarks

This property is used for identification with the SMPP service. When binding to the smpp_server, 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 user_id and password properties before connecting; or (2) by setting those two properties and calling send_message while not connected.

add_recipient Method

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

Syntax

def add_recipient(recipient_type: int, recipient_address: str) -> None: ...

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:

cancel_message Method

This method will cancel the specified message.

Syntax

def cancel_message(message_id: str) -> None: ...

Remarks

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

check_link Method

This method will check the connection to the server.

Syntax

def check_link() -> None: ...

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.

check_message_status Method

This method will retrieve the status of the specified message.

Syntax

def check_message_status(message_id: str) -> None: ...

Remarks

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

config Method

Sets or retrieves a configuration setting.

Syntax

def config(configuration_string: str) -> str: ...

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.

connect Method

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

Syntax

def connect() -> None: ...

Remarks

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

connect_to Method

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

Syntax

def connect_to(user_id: str, password: str) -> None: ...

Remarks

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

disconnect Method

This method will disconnect from the SMPP service.

Syntax

def disconnect() -> None: ...

Remarks

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

do_events Method

This method processes events from the internal message queue.

Syntax

def do_events() -> None: ...

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.

interrupt Method

Interrupt the current method.

Syntax

def interrupt() -> None: ...

Remarks

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

replace_message Method

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

Syntax

def replace_message(message_id: str, new_message: str) -> None: ...

Remarks

Assuming that a message on the smpp_server 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.

reset Method

Reset the class.

Syntax

def reset() -> None: ...

Remarks

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

send_command Method

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

Syntax

def send_command(command_id: int, payload: bytes) -> bytes: ...

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.

send_data Method

This method sends raw data to Recipients .

Syntax

def send_data(data: bytes) -> str: ...

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 smpp_server. Unlike the send_message method, this method can send to only one destination at a time. The target is whatever value is in the recipients properties.

send_message Method

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

Syntax

def send_message(message: str) -> str: ...

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.

on_connected Event

This event is fired after a successful bind operation.

Syntax

class SMPPConnectedEventParams(object):
  @property
  def status_code() -> int: ...

  @property
  def description() -> str: ...

# In class SMPP:
@property
def on_connected() -> Callable[[SMPPConnectedEventParams], None]: ...
@on_connected.setter
def on_connected(event_hook: Callable[[SMPPConnectedEventParams], None]) -> None: ...

Remarks

After establishing a socket connection to the smpp_server, 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 on_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.

on_connection_status Event

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

Syntax

class SMPPConnectionStatusEventParams(object):
  @property
  def connection_event() -> str: ...

  @property
  def status_code() -> int: ...

  @property
  def description() -> str: ...

# In class SMPP:
@property
def on_connection_status() -> Callable[[SMPPConnectionStatusEventParams], None]: ...
@on_connection_status.setter
def on_connection_status(event_hook: Callable[[SMPPConnectionStatusEventParams], None]) -> None: ...

Remarks

The on_connection_status 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:

on_disconnected Event

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

Syntax

class SMPPDisconnectedEventParams(object):
  @property
  def status_code() -> int: ...

  @property
  def description() -> str: ...

# In class SMPP:
@property
def on_disconnected() -> Callable[[SMPPDisconnectedEventParams], None]: ...
@on_disconnected.setter
def on_disconnected(event_hook: Callable[[SMPPDisconnectedEventParams], None]) -> None: ...

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.

on_error Event

This event is fired when the server detects an error.

Syntax

class SMPPErrorEventParams(object):
  @property
  def error_code() -> int: ...

  @property
  def description() -> str: ...

# In class SMPP:
@property
def on_error() -> Callable[[SMPPErrorEventParams], None]: ...
@on_error.setter
def on_error(event_hook: Callable[[SMPPErrorEventParams], None]) -> None: ...

Remarks

If the server sends an error not related to a command sent from the class, the class will fire an on_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.

on_message_in Event

This event is fired upon receipt of a message.

Syntax

class SMPPMessageInEventParams(object):
  @property
  def source_address() -> str: ...

  @property
  def schedule_delivery_time() -> str: ...

  @property
  def validity_period() -> str: ...

  @property
  def message() -> str: ...

  @property
  def message_part() -> int: ...

  @property
  def message_part_count() -> int: ...

  @property
  def message_part_reference() -> int: ...

  @property
  def destination_address() -> str: ...

  @property
  def response_error_code() -> int: ...
  @response_error_code.setter
  def response_error_code(value) -> None: ...

# In class SMPP:
@property
def on_message_in() -> Callable[[SMPPMessageInEventParams], None]: ...
@on_message_in.setter
def on_message_in(event_hook: Callable[[SMPPMessageInEventParams], None]) -> None: ...

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.

on_message_status Event

This event is fired upon receipt of a message.

Syntax

class SMPPMessageStatusEventParams(object):
  @property
  def message_id() -> str: ...

  @property
  def message_state() -> int: ...

  @property
  def message_error() -> int: ...

  @property
  def final_date() -> str: ...

# In class SMPP:
@property
def on_message_status() -> Callable[[SMPPMessageStatusEventParams], None]: ...
@on_message_status.setter
def on_message_status(event_hook: Callable[[SMPPMessageStatusEventParams], None]) -> None: ...

Remarks

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

MessageState represents the last known state the message was left in on the smpp_server. 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.

on_pi_trail Event

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

Syntax

class SMPPPITrailEventParams(object):
  @property
  def direction() -> int: ...

  @property
  def pdu() -> bytes: ...

  @property
  def command_length() -> int: ...

  @property
  def command_id() -> int: ...

  @property
  def command_description() -> str: ...

  @property
  def command_status() -> str: ...

  @property
  def sequence_number() -> int: ...

# In class SMPP:
@property
def on_pi_trail() -> Callable[[SMPPPITrailEventParams], None]: ...
@on_pi_trail.setter
def on_pi_trail(event_hook: Callable[[SMPPPITrailEventParams], None]) -> None: ...

Remarks

Whenever either the class or the smpp_server sends any data across the connection, the class will fire a on_pi_trail 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.

on_ready_to_send Event

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

Syntax

class SMPPReadyToSendEventParams(object):
# In class SMPP:
@property
def on_ready_to_send() -> Callable[[SMPPReadyToSendEventParams], None]: ...
@on_ready_to_send.setter
def on_ready_to_send(event_hook: Callable[[SMPPReadyToSendEventParams], None]) -> None: ...

Remarks

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

on_ssl_server_authentication Event

Fired after the server presents its certificate to the client.

Syntax

class SMPPSSLServerAuthenticationEventParams(object):
  @property
  def cert_encoded() -> bytes: ...

  @property
  def cert_subject() -> str: ...

  @property
  def cert_issuer() -> str: ...

  @property
  def status() -> str: ...

  @property
  def accept() -> bool: ...
  @accept.setter
  def accept(value) -> None: ...

# In class SMPP:
@property
def on_ssl_server_authentication() -> Callable[[SMPPSSLServerAuthenticationEventParams], None]: ...
@on_ssl_server_authentication.setter
def on_ssl_server_authentication(event_hook: Callable[[SMPPSSLServerAuthenticationEventParams], None]) -> None: ...

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.

on_ssl_status Event

Fired when secure connection progress messages are available.

Syntax

class SMPPSSLStatusEventParams(object):
  @property
  def message() -> str: ...

# In class SMPP:
@property
def on_ssl_status() -> Callable[[SMPPSSLStatusEventParams], None]: ...
@on_ssl_status.setter
def on_ssl_status(event_hook: Callable[[SMPPSSLStatusEventParams], None]) -> None: ...

Remarks

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

SMPP Config Settings

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

SMPP Errors

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