SMPP Class

Properties   Methods   Events   Configuration Settings   Errors  

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

Class Name

IPWorks_SMPP

Procedural Interface

 ipworks_smpp_open();
 ipworks_smpp_close($res);
 ipworks_smpp_register_callback($res, $id, $function);
 ipworks_smpp_get_last_error($res);
 ipworks_smpp_get_last_error_code($res);
 ipworks_smpp_set($res, $id, $index, $value);
 ipworks_smpp_get($res, $id, $index);
 ipworks_smpp_do_addrecipient($res, $recipienttype, $recipientaddress);
 ipworks_smpp_do_cancelmessage($res, $messageid);
 ipworks_smpp_do_checklink($res);
 ipworks_smpp_do_checkmessagestatus($res, $messageid);
 ipworks_smpp_do_config($res, $configurationstring);
 ipworks_smpp_do_connect($res, $userid, $password);
 ipworks_smpp_do_disconnect($res);
 ipworks_smpp_do_doevents($res);
 ipworks_smpp_do_interrupt($res);
 ipworks_smpp_do_replacemessage($res, $messageid, $newmessage);
 ipworks_smpp_do_sendcommand($res, $commandid, $payload);
 ipworks_smpp_do_senddata($res, $data);
 ipworks_smpp_do_sendmessage($res, $message);

Remarks

The Smpp Class will bind as a transceiver, and thus can send and receive messages from the server. Additionally, it can send single and multi-recipient messages, and 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-by-one 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 non-implemented features of the protocol are supported through the SendCommand method and PITrail event. Due to the nature of the protocol, all methods and operations are implemented synchronously.