Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/fratzinger/feathers-messagebird

Last synced: 5 days ago
JSON representation

Host: GitHub
URL: https://github.com/fratzinger/feathers-messagebird
Owner: fratzinger
License: mit
Created: 2022-01-09T09:42:55.000Z (almost 3 years ago)
Default Branch: main
Last Pushed: 2022-01-09T17:09:57.000Z (almost 3 years ago)
Last Synced: 2024-10-17T13:57:50.644Z (26 days ago)
Language: TypeScript
Size: 154 KB
Stars: 1
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

awesome-feathersjs - feathers-messagebird - A [Messagebird](https://messagebird.com/) API service adapter for FeathersJS (Plugins / Email and SMS)

README

        # feathers-messagebird

A [feathers.js](https://feathersjs.com/) service adapter for [messagebird](https://messagebird.com).

[![npm](https://img.shields.io/npm/v/feathers-messagebird)](https://www.npmjs.com/package/feathers-messagebird)

[![libraries.io](https://img.shields.io/librariesio/release/npm/feathers-messagebird)](https://libraries.io/npm/feathers-messagebird)

[![npm](https://img.shields.io/npm/dm/feathers-messagebird)](https://www.npmjs.com/package/feathers-messagebird)

[![GitHub license](https://img.shields.io/github/license/fratzinger/feathers-messagebird)](https://github.com/fratzinger/feathers-messagebird/blob/master/LICENSE)

## Installation

```bash

npm i feathers-messagebird

```

Also see:

- https://github.com/messagebird/messagebird-nodejs

- https://dashboard.messagebird.com/en/developers/access

- https://developers.messagebird.com/tutorials/send-sms-node

## Supported features

- [x] Messages

  - [create](https://developers.messagebird.com/api/sms-messaging/#send-outbound-sms) -> `create` method

  - [list](https://developers.messagebird.com/api/sms-messaging/#list-messages) -> `find` method

  - [read](https://developers.messagebird.com/api/sms-messaging/#view-an-sms) -> `get` method

  - [delete](https://developers.messagebird.com/api/sms-messaging/#available-http-methods) -> `remove` method

## Todo (contributions welcome)

- [ ] [Verify](https://developers.messagebird.com/quickstarts/verify-overview/)

- [ ] [Lookup](https://developers.messagebird.com/quickstarts/lookup-overview/)

- [ ] [WhatsApp](https://developers.messagebird.com/quickstarts/whatsapp-overview/)

## Usage

```js

const { MessageBirdSmsService } = require("feathers-messagebird");

app.use("/sms", new MessageBirdSmsService({

  accessKey: "YOUR_ACCESS_KEY" // get your accessKey: https://dashboard.messagebird.com/en/developers/access

}))

app.service("sms").create({

  originator : '31970XXXXXXX',

  recipients : [ '31970YYYYYYY' ],

  body : 'Hello World, I am a text message and I was hatched by Javascript code!'

})

```

## Testing

Simply run `npm test` and all your tests in the `test/` directory will be run. It has full support for *Visual Studio Code*. You can use the debugger to set breakpoints.

## License

Licensed under the [MIT license](LICENSE).