# mekongsms

> MekongSMS client

Latest version **0.0.5** (published 2023-10-04) · MIT license · 0 weekly downloads

## Install

```sh
npm install mekongsms
pnpm add mekongsms
yarn add mekongsms
bun add mekongsms
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.5 |
| Published | 2023-10-04 |
| First published | 2023-09-29 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >=12 |
| Dependencies | 2 |
| Unpacked size | 5.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Seanghay Yath |
| Maintainers | seanghay |

## Links

- npm: https://www.npmjs.com/package/mekongsms
- Repository: https://github.com/seanghay/mekongsms
- Homepage: https://github.com/seanghay/mekongsms#readme
- Issues: https://github.com/seanghay/mekongsms/issues
- npm.io page: https://npm.io/package/mekongsms

## Dependencies (2)

- [md5](https://npm.io/package/md5.md) ^2.3.0
- [axios](https://npm.io/package/axios.md) ^1.5.1

## Recent versions

- 0.0.5 (latest) — 2023-10-04
- 0.0.4 — 2023-10-04
- 0.0.3 — 2023-09-29
- 0.0.2 — 2023-09-29
- 0.0.1 — 2023-09-29

## README

### MekongSMS Node.js Client (Unofficial)

This implementation is based on MekongSMS API version 2.1.

### Install

```shell
npm install mekongsms
```

## Usage

Initialize MekongSMS client.

```javascript
const client = new MekongSMS({
	endpoint: "https://sandbox.mekongsms.com",
	username: "example@example.com",
	password: "example",
});
```

### Send SMS

Send an SMS to one or multitple phone numbers.

```javascript
await client.send({
	international: false,
	phoneNumbers: ["85512345678", "85512345679", "85512345688"],
	text: "Hello, world",
	customData: "user_01",
	sender: "Example",
	statusCallback: "https://example.com/callback"
});
```

### Check Credits

Check available credit associated with the account. 

```javascript
const value = await client.credits();
// => { "credit": 1234 }
```


### License

MIT

---
_Source: https://npm.io/package/mekongsms · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
