C# SMS API class members

The C# SMS API class is called SMSClient. It contains methods that allow you to log into the SMS Gateway and to send and receive SMS messages. The following table lists the members of this class.

C# SMS API methods

     Name Description
login Use this function to log into the SMS Gateway with your username and password. (To obtain a username and a password you should open the Management Console as admin and create a standard user.)
logout Call this function to logout from the SMS Gateway. This function frees resources in the server, so it is recommended to use it. (Note: if you do not call this function the server will free resources after a period of inactivity)
sendMessage You can use this function to post an SMS to the SMS Gateway. The gateway will return a message id, and later it will notify you application about when the message was delivered to the network and when the message was delivered to the handset. You can use this function to post text messages or binary messages, such as WAP Push, Oplogos, Ringtones, etc.
log You can use this function to write a log entry on the server into the logfile belonging to the logged in user.
keepAlive Usually you will not use this function. However it is available if you wish to "ping" the server. Keepalive can be used to detect if the server is available or not.
Renewal This function is used by .NET remoting to manage object lifetimes. You do not need to use this function.

C# SMS API events

     Name Description
onMessageDeliveredToNetwork This event is invoked by the SMS Gateway when the SMS message was accepted by the mobile network for delivery.
onMessageDeliveredToHandset This event is invoked by the SMS Gateway when the SMS message was delivered to the recipient handset. This event can happen later then the onMessageDeliveredToNetwork event, because it is possible that the destination mobile handset is out of network coverage or is switched off for some time.
onMessageDeliveryFailed This event is invoked by the SMS Gateway if the message cannot be delivered. This can happen if the mobile network operator does not accept the message for example because the destination number is invalid, or there is not enough money in the account. This event is also invoked if the mobile network operator has accepted the message for delivery but the destination handset was never switched on so delivery became impossible.
onMessageReceived This event is invoked by the SMS Gateway if a mobile originated message is received.

More information