apistore-sms/README.md

Send SMS with Node.js via API Store SMS service.

<img src="http://www.apistore.co.kr/img/service_img/20140807101212708.png" align="left" width="200px" height="128px"/>

### **API Store SMS for Node**
> *A transporter for SMS/LMS/MMS via API Store SMS service*

[![npm version](https://badge.fury.io/js/apistore-sms.svg)](https://badge.fury.io/js/apistore-sms)
[![MIT Licence](https://badges.frapsoft.com/os/mit/mit.svg?v=103)](https://opensource.org/licenses/mit-license.php)
[![Open Source Love](https://badges.frapsoft.com/os/v1/open-source.svg?v=103)](https://github.com/ellerbrock/open-source-badge/)


<br />

[**APIStore-SMS**](https://github.com/posquit0/node-apistore-sms)는 [API Store](http://www.apistore.co.kr/api/apiView.do?service_seq=151)에서 제공하는 SMS API를 Node.js에서 쉽게 활용하기 위하여 작성된 클라이언트 모듈입니다.

- 이용 중 발생한 문제에 대하여 책임지지 않습니다.
- 최초 작성은 자동차 렌트 플랫폼 [CARPLAT](https://www.carplat.co.kr)에서 사용하기 위하여 작성되었습니다.

## <a name="installation">Installation

```bash
$ npm install apistore-sms
```


## <a name="usage">Usage

- 모든 메소드는 [Promise](http://www.html5rocks.com/ko/tutorials/es6/promises/)를 반환

```node
var apistore = require('apistore-sms').createClient({
  apiKey: 'YOUR_API_KEY',
  apiId: 'YOUR_ID'
});

// SMS 전송 (단일 수신자)
apistore.sendSMS({
  from: '15885588', // 발신자 번호
  to: '01012345678', // 수신자 번호
  text: 'Hot! Hot!', // 내용
  subject: '넘나맛있는', // 제목(optional)
  at: '20160801235959', // 예약시간(optional)
  author: 'Pizza Huuut' // 발신자 이름(optional)
}).then(function (cmid) {
  console.log(cmid); // 메시지 아이디
}).catch(function (error) {
  console.log(error);
});

// SMS 전송 (복수 수신자)
apistore.sendSMS({
  from: '15885588', // 발신자 번호
  to: ['01012345678', '010-2345-6789'], // 수신자 번호
  text: 'Hot! Hot!', // 내용
  subject: '넘나맛있는', // 제목(optional)
  at: '20160801235959', // 예약시간(optional)
  author: 'Pizza Huuut' // 발신자 이름(optional)
}).then(function (cmid) {
  console.log(cmid); // 메시지 아이디
}).catch(function (error) {
  console.log(error);
});

// LMS 전송
apistore.sendLMS({
  from: '15885588', // 발신자 번호
  to: '01012345678', // 수신자 번호
  text: 'Hot! Hot!', // 내용
  subject: '넘나맛있는', // 제목(optional)
  at: '20160801235959', // 예약시간(optional)
  author: 'Pizza Huuut' // 발신자 이름(optional)
}).then(function (cmid) {
  console.log(cmid); // 메시지 아이디
}).catch(function (error) {
  console.log(error);
});

// MMS 전송
apistore.sendLMS({
  from: '15885588', // 발신자 번호
  to: '01012345678', // 수신자 번호
  text: 'Hot! Hot!', // 내용
  subject: '넘나맛있는', // 제목(optional)
  file: path.join(__dirname, 'test.jpg'), // or fs.createReadStream(filepath)
  at: '20160801235959', // 예약시간(optional)
  author: 'Pizza Huuut' // 발신자 이름(optional)
}).then(function (cmid) {
  console.log(cmid); // 메시지 아이디
}).catch(function (error) {
  console.log(error);
});

// Report 보기
apistore.getReport('your_cmid')
  .then(function (result) {
    console.log(result);
  }).catch(function (error) {
    console.log(error);
  });
```


## <a name="contact">Contact

If you have any questions, feel free to join me at [`#posquit0` on Freenode](irc://irc.freenode.net/posquit0) and ask away. Click [here](https://kiwiirc.com/client/irc.freenode.net/posquit0) to connect.


## <a name="license">License

- Claud D. Park <posquit0.bj@gmail.com>
- [MIT Liense](https://github.com/posquit0/node-apistore-sms/blob/master/LICENSE)