https://github.com/posquit0/node-apistore-sms
Client for SMS/LMS/MMS API in Korea
https://github.com/posquit0/node-apistore-sms
apistore apistore-sms lms mms sms
Last synced: about 1 year ago
JSON representation
Client for SMS/LMS/MMS API in Korea
- Host: GitHub
- URL: https://github.com/posquit0/node-apistore-sms
- Owner: posquit0
- License: mit
- Created: 2016-07-22T15:14:26.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2023-10-31T17:02:44.000Z (over 2 years ago)
- Last Synced: 2025-03-28T18:50:32.028Z (about 1 year ago)
- Topics: apistore, apistore-sms, lms, mms, sms
- Language: JavaScript
- Size: 28.3 KB
- Stars: 12
- Watchers: 2
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
API Store SMS for Node
:email: A transporter for SMS/LMS/MMS via API Store SMS Service
**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)에서 사용하기 위하여 작성되었습니다.
## Installation
```bash
# NPM
$ npm install --save apistore-sms
# Yarn
$ yarn add apistore-sms
```
## 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);
});
```
## Contributing
This project follows the [**Contributor Covenant**](http://contributor-covenant.org/version/1/4/) Code of Conduct.
#### Bug Reports & Feature Requests
Please use the [issue tracker](https://github.com/posquit0/node-apistore-sms/issues) to report any bugs or ask feature requests.
## 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.
## License
Provided under the terms of the [MIT License](https://github.com/posquit0/node-apistore-sms/blob/master/LICENSE).
Copyright © 2017, [Byungjin Park](http://www.posquit0.com).