TextOverSMPP Client Component

This documentation covers details regarding the TextOver SMPP Component

Contact TextOver to order a free trial component.

Introduction

The SMPP Component allows clients to connect to an SMPP server and send or receive SMS.

Methods

ActivateLicense
Bind
EnquireLink
Send
UnBind

Properties

AddressNPI
AddressTON
AutoEnquireSeconds
AutoUnbindOnDestroy
Bound
BoundAs
Busy
Connected
LastError
Secret
SystemID
SystemType

Events

onUnBound
onBound
onLinkOK
onMessageDelivered
onMessageSubmitted

 

 

Methods

ActivateLicense(LicenseNumber,MobileNumber,Password)

This function is used to activate the component. It must be called for each instance of TextOverSMPP.

LicenseNumber - This is a string containing the license number provided by TextOver.
MobileNumber - This is a string which should contain the TextOver account mobile number.
Password - This is a string which should contain the TextOver account password.

Note: A TextOver account is required for all purchases, however no purchase of credits is necassary.

Bind(BindAs, HostIP, HostPort)

This function will cause the component to begin binding with the SMPP Server. Make sure you have set the login credentials before calling this function.

BindAs - This informs the SMPP Client how to connect to the SMPP Server.
HostIP - String containing the IPAddress of the SMPP Server.
HostPort - The port number of the SMPP Server.

EnquireLink Returns Boolean

Calling this function will check whether the SMPP Client is still bound to the server. It is return true if bound. Otherwise it will return false.

Send(Message, Optional WaitForID)

This function is used to send sms to the SMPP Server.

Message - This is an instance for MessageObject which must be created prior to sending.
WaitForID - This will cause the component to wait for a MessageID from the SMPP Server before returning. The message ID is returned within the original Message parameter.

UnBind

Use this method to unbind from the SMPP Server and disconnect.

Properties

AddressNPI

This property is the Numbering Plan Indicator (NPI) for the ESME. Please check with the SMPP Server provider for settings.

AddressTON

This property is the Type of Number of the ESME. Please check with the SMPP Server provider for settings.

AutoEnquireSeconds

When set, the component will execute the EnquireLink function every X seconds. Set to 0 to stop all automatic checks. Most SMPP Servers require a check every 30 to 60 seconds. Check with your SMPP Server Provider for more details.

AutoUnbindOnDestroy

This will cause the component to automatically called the UnBind function if it is being destroyed.

Bound

Read-only. This indicates whether the component is currently bound. We recommend not to trust this property. We recommend using EnquireLink to check the current status.

BoundAs

Read-only. Indicates what mode the component is currently in. eg. Transmitter, Receiver, Transceiver.

Busy

This indicates whether the component is busy handling requests to send sms.

Connected

This indicates whether the component is connected. This is not the same as being bound. If the component is connected but hasn't completed the authentication process, Connected will be true, but bound will be false.

LastError

This indicates the LastError from the SMPP Server.

Secret

This should be set to the SMPP server account password.

SystemID

Also known as username and userid. This should be set to the SMPP Server Account username/systemID/userID.

SystemType

Please ask your SMPP Server Provider for this setting.

Events

onUnBound

This event is raised when the SMPP Component Unbounds.

onBound

This event is raised when the SMPP Component completes the bind process.

onLinkOK

When AutoEnquireLink is set, this event is raised each time the SMPP Server is successfully contacted.

onMessageDelivered

This is raised when the SMPP Server sends the client a delivery report.

onMessageSubmitted

This is raised when the component submits a Message to the SMPP Server.