Klient JavaScript pozwalający na wysyłanie wiadomości SMS, MMS, VMS oraz zarządzanie kontem w serwisie SMSAPI.pl
$ npm install smsapi --save
var SMSAPI = require('smsapi'),
smsapi = new SMSAPI();
smsapi.authentication
.login('username', 'password')
.then(sendMessage)
.then(displayResult)
.catch(displayError);
function sendMessage(){
return smsapi.message
.sms()
.from('Info')
.to('605xxxxxx')
.message('My first message!')
.execute(); // return Promise
}
function displayResult(result){
console.log(result);
}
function displayError(err){
console.error(err);
}
var SMSAPI = require('smsapi'),
smsapi = new SMSAPI({
server: ‘https://api2.smsapi.pl/'
});
smsapi.authentication
.login('username', 'password')
.then(sendMessage)
.then(displayResult)
.catch(displayError);
function sendMessage(){
return smsapi.message
.sms()
.from('Info')
.to('605xxxxxx')
.message('My first message!')
.execute(); // return Promise
}
function displayResult(result){
console.log(result);
}
function displayError(err){
console.error(err);
}
Biblioteka pozwala na autentykację zarówno czystym hasłem, jak i hashem md5. Domyślnie używana jest metoda autentykacji Basic auth.
var promise = smsapi.authentication
.login('username', 'password');
var promise = smsapi.authentication
.loginHashed('username', '5f4dcc3b5aa765d61d8327deb882cf99');
Aby skorzystać z OAuth należy podczas tworzenia obiektu SMSAPI dodać parametr:
oauth.accessToken
var SMSAPI = require('smsapi'),
smsapi = new SMSAPI({
oauth: {
accessToken: 'twoj-access-token'
}
});
sendMessage()
.then(displayResult)
.catch(displayError);
function sendMessage(){
return smsapi.message
.sms()
.from('Info')
.to('605xxxxxx')
.message('My first message!')
.execute(); // return Promise
}
function displayResult(result){
console.log(result);
}
function displayError(err){
console.error(err);
}
Token można wygenerować w panelu SMSAPI pod adresem: https://ssl.smsapi.pl/webapp#/oauth/manage
Dokumentacja interfejsu REST API znajduje się pod adresem http://www.smsapi.pl/rest.
Wszystkie odwołania do API zwracają obiekt Promise
zgodny ze standardem Promises/A+. Użyta implementacja: https://github.com/tildeio/rsvp.js
- message
- sms
- mms
- vms
- points
- get
- sender
- add
- delete
- status
- default
- list
- hlr
- check
- user
- add
- delete
- update
- get
- list
- phonebook (deprecated)
- contact
- add
- get
- update
- list
- delete
- group
- get
- add
- update
- list
- delete
- contact
- contacts
- list
- add
- get
- update
- delete
- fields
- list
- add
- update
- delete
- groups
- list
- add
- get
- update
- delete
- assignments
- list
- add
- get
- delete
- permissions
- list
- add
- get
- update
- delete
- members
- add
- get
- delete
Dodatkowe przykłady użycia dostępnych operacji można znaleźć w testach (./test).
$ npm install mocha -g
$ npm install .
$ npm test