Updated readme

This commit is contained in:
2015-04-08 10:10:18 +02:00
parent 7a4ed47e02
commit 65be6142ca
+46 -10
View File
@@ -1,35 +1,71 @@
# Larv IT SMPP # Larv IT SMPP
This is a simplified implementation of the SMPP protocol. It only supports transciever mode and all messages are sent via the "data_sm" command. This is a simplified implementation of the SMPP protocol.
## Client ## Client
### Simplest possible
This will setup a client that connects to localhost, port 2775 without username or password and send a message. This will setup a client that connects to localhost, port 2775 without username or password and send a message.
var larvitsmpp = require('larvitsmpp'); var larvitsmpp = require('larvitsmpp');
larvitsmpp.client(function(err, clientSession) { larvitsmpp.client(function(err, clientSession) {
clientSession.send({ clientSession.send({
'sender': 46701113311, 'from': '46701113311',
'receiver': 46709771337, 'to': '46709771337',
'message': 'Hello world' 'message': 'Hello world'
}, function(err, res) { });
// Gracefully close connection
clientSession.unbind();
});
### Some connection parameters and DLR
This will setup a client that connects to given host, port with username and password, send a password and retrieve a DLR.
larvitsmpp.client({
'host': 'smpp.somewhere.com',
'port': 2775,
'username': 'foo',
'password': 'bar'
}, function(err, clientSession) {
if (err) {
throw err;
}
clientSession.sendSms({
'from': '46701113311',
'to': '46709771337',
'message': '«baff»',
'dlr': true
}, function(err, smsId, retPduObj) {
if (err) { if (err) {
throw err; throw err;
} }
if (res) { console.log('SMS sent, smsId: ' + smsId);
console.log('Woho! Message sent'); console.log('Return PDU object:');
} else { console.log(retPduObj);
console.log('Server did not accept :(');
}
}); });
clientSession.close(); clientSession.on('dlr', function(dlr, dlrPduObj) {
console.log('DLR received:');
console.log(dlr);
console.log('DLR PDU object:');
console.log(dlrPduObj);
// Gracefully close connection
clientSession.unbind();
});
}); });
## Server ## Server
### Simplest possible
This will setup a password less server on localhost, port 2775 and console.log() incomming commands. This will setup a password less server on localhost, port 2775 and console.log() incomming commands.
var larvitsmpp = require('larvitsmpp'); var larvitsmpp = require('larvitsmpp');