Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/solufyapp/evolution-sdk
Unofficial SDK for Evolution Whatsapp API
https://github.com/solufyapp/evolution-sdk
Last synced: about 2 months ago
JSON representation
Unofficial SDK for Evolution Whatsapp API
- Host: GitHub
- URL: https://github.com/solufyapp/evolution-sdk
- Owner: solufyapp
- License: mit
- Created: 2024-10-02T15:44:47.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-10-31T19:10:49.000Z (about 2 months ago)
- Last Synced: 2024-10-31T19:59:27.181Z (about 2 months ago)
- Language: TypeScript
- Size: 82 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
@solufy/evolution-sdk
Unofficial SDK for the Evolution Whatsapp API (v2).
## Installation
```bash
npm install @solufy/evolution-sdk
// or
yarn add @solufy/evolution-sdk
// or
pnpm add @solufy/evolution-sdk
```
## Getting Started
```ts
import { EvolutionClient } from "@solufy/evolution-sdk"
// const { EvolutionClient } = require("@solufy/evolution-sdk")
const cccccccccc = new EvolutionClient({
serverUrl: "Your server url",
instance: "Your instance",
token: "Global api key or instance token"
})
```
## Features
- **Check numbers**
```ts
client.chats.check("551199999999", "552299999999")
```
- **Find chats and groups**
```ts
client.chats.findAll()
client.groups.findAll()
client.groups.findByJid("[email protected]")
client.groups.findByInviteCode("0000000000000000000000")
```
- **Send messages**
There are available these types of messages: **audio**, **contact**, **document**, **image**, **location**, **poll**, **sticker**, **text**, **video** and **voice**.
```ts
client.messages.sendText({
number: "+551199999999",
text: "Hi!",
delay: 1000,
})
```
## API Documentation
Check the [official API documentation](https://doc.evolution-api.com/v2) for more information about their service.
## Contributing
Feel free to contribute with suggestions or bug reports at our [GitHub repository](https://github.com/solufyapp/evolution-sdk).
## Authors
- [@joaotonaco](https://github.com/joaotonaco)