Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/swapnilsoni1999/messages-web
:iphone: SMS gateway using your own phone!
https://github.com/swapnilsoni1999/messages-web
google-messages nodejs puppeteer sms-api sms-gateway
Last synced: 4 days ago
JSON representation
:iphone: SMS gateway using your own phone!
- Host: GitHub
- URL: https://github.com/swapnilsoni1999/messages-web
- Owner: SwapnilSoni1999
- Created: 2021-02-26T12:07:12.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-01-04T19:08:33.000Z (12 months ago)
- Last Synced: 2024-12-08T11:40:33.635Z (14 days ago)
- Topics: google-messages, nodejs, puppeteer, sms-api, sms-gateway
- Language: TypeScript
- Homepage:
- Size: 117 KB
- Stars: 99
- Watchers: 6
- Forks: 27
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Google Messages Cli Client
### What is this?
- this is a [Google Messages](https://messages.android.com) Client library to send message with a backend .eg. with express to send otp messages. This module uses your own number to work as a sms gateway api and you can send message to other person with your own number.
### How to use
1. install the package from [npm](https://npmjs.com/package/messages-web)
```sh
npm install messages-web
```
2. Use it
- Without credentials
```js
const { default: MessagesClient } = require('messages-web')
const fs = require('fs')
const client = new MessagesClient()
client.on('qr-code', (base64Image) => {
// example code to save image
fs.writeFileSync('qr.jpg', base64Image.replace(/^data:image\/png;base64,/, ""), { encoding: 'base64' })
// your code
})
client.on('authenticated', async (service) => {
const inbox = service.getInbox()
const credentials = await client.getCredentials()
fs.writeFileSync('credentials.json', JSON.stringify(credentials, null, '\t'))
await client.quit()
})
```
Then you can use `credentials.json` file to login
- With credentials
```js
const { default: MessagesClient } = require('messages-web')
const credentials = MessagesClient.loadCredentialFile('credentials.json')
const client = new MessagesClient({ credentials })
client.on('authenticated', async (service) => {
const inbox = await service.getInbox()
console.log('Inbox', inbox)
await client.quit()
})
```
3. send message
```js
const { default: MessagesClient } = require('messages-web')
const credentials = MessagesClient.loadCredentialFile('credentials.json')
const client = new MessagesClient({ credentials })
client.on('authenticated', async (service) => {
console.log('Sending message...')
await service.sendMessage('+91987654321', 'Test message from SMS Client.')
console.log('Done!')
await client.quit()
})
```
**Note**: `sendMessage` takes first arg as number with `countryCode + Number` second arg as TextMessage
- Examples are given [here](https://github.com/SwapnilSoni1999/messages-web/tree/main/examples).
### Todos
- add pagination in getInbox
- add sendMessage in Service
- add public method in client to save credentials to a file
- sendMessage: parse to var to check if country code is included or not
- Rewrite docs with proper details
- detect if phone is not connected
- detect if web client is open in another browser or not
# License
ISC - Swapnil Soni ©