Skip to content

solufyapp/evolution-sdk

Repository files navigation

@solufy/evolution-sdk

Unofficial SDK for the Evolution Whatsapp API (v2).

Installation

npm install @solufy/evolution-sdk
// or
yarn add @solufy/evolution-sdk
// or
pnpm add @solufy/evolution-sdk

Getting Started

import { EvolutionClient } from "@solufy/evolution-sdk"
// const { EvolutionClient } = require("@solufy/evolution-sdk")

const client = new EvolutionClient({
  serverUrl: "Your server url",
  instance: "Your instance",
  token: "Global api key or instance token"
})

Features

  • Check numbers

    client.chats.check("551199999999", "552299999999")
  • Find chats and groups

    client.chats.findAll()
    
    client.groups.findAll()
    client.groups.findByJid("999999999999999999@g.us")
    client.groups.findByInviteCode("0000000000000000000000")
  • Send messages

    There are available these types of messages: audio, contact, document, image, location, poll, sticker, text, video and voice.

    client.messages.sendText({
      number: "+551199999999",
      text: "Hi!",
      delay: 1000,
    })

API Documentation

Check the official API documentation for more information about their service.

Contributing

Feel free to contribute with suggestions or bug reports at our GitHub repository.

Authors