1.0.9 β€’ Published 10 months ago

@raphaelvserafim/client-api-whatsapp v1.0.9

Weekly downloads
-
License
MIT
Repository
github
Last release
10 months ago

WhatsApp API

About Our WhatsApp API

πŸ”“ Unlock the Potential of WhatsApp: Powerful Integration with Our Unofficial API!

Efficient Group Management on WhatsApp

πŸ“‹ Our stable, though unofficial, API allows for efficient management of WhatsApp groups. Simplify administration, and easily add or remove members.

Versatile Message Sending

πŸ’¬ With our API, you can send text, audio, video, and image messages quickly and easily. Adapt to your business communication needs comprehensively.

Receive Instant Events

πŸ”” Stay updated with our API, receiving real-time events when new messages are received. Stay connected and agile in responding to interactions on WhatsApp.

πŸ”— Create Your Account: Visit https://api-wa.me/sign-up to create your account and start using our API today!

🎁 Special Discount: Use the coupon GIT20 and get 20% off on your first instance!

Contact Support

Installation

npm i @raphaelvserafim/client-api-whatsapp
yarn add @raphaelvserafim/client-api-whatsapp
import { WhatsApp, StatusPresence, TypeMessage, } from '@raphaelvserafim/client-api-whatsapp';

const whatsapp = new WhatsApp({ server: "https://us.api-wa.me", key: "12345678" });

const to = "559999999999" //  If you want to send it to the group = 123456789@us

Get Information

whatsapp.info().then((response) => {
  console.log(response)
}).catch(console.error)

Connect to WhatsApp

whatsapp.connect().then((response) => {
 console.log(response)
}).catch(console.error);

Logout

whatsapp.logout().then((response) => {
 console.log(response)
}).catch(console.error);

Get Contacts

whatsapp.contacts().then((response) => {
 console.log(response)
}).catch(console.error)

Send Messages

Presence

whatsapp.sendMessage({
  type: TypeMessage.PRESENCE,
  body: {
    to: to,
    status: StatusPresence.COMPOSING
  }
}).then((response) => {
 console.log(response)
}).catch(console.error)

Text

whatsapp.sendMessage({
  type: TypeMessage.TEXT,
  body: {
    to: to,
    text: "Hey"
  }
}).then((response) => {
 console.log(response)
}).catch(console.error)

CobranΓ§a Pix

whatsapp.sendMessage({
  type: TypeMessage.BUTTON_PIX,
  body:  {
  to: "14375223417",
  title: "Pizza",
  text: "Pizza ",
  referenceId: "apiwame",
  code: "0020",
  key: "23711695000115",
  merchantName: "CACHE SISTEMAS WEB",
  keyType: "CNPJ",
  items: [
    {
      id: "123",
      name: "Pizza G",
      price: 10,
      quantity: 10
    },
  ],
  subtotal: "90",
  totalAmount: "100"
}
}).then((response) => {
 console.log(response)
}).catch(console.error)

Buttons Reply

whatsapp.sendMessage({
  type: TypeMessage.BUTTON_REPLY,
  body: {
  to: "14375223417",
  header: {
    title: "Example Header",
  },
  text: "This is a test",
  footer: "choose an option",
  buttons: [
    {
      type: "quick_reply",
      id: "uniqId1",
      text: "Yes"
    },
    {
      type: "quick_reply",
      id: "uniqId2",
      text: "No"
    }
  ]
}
}).then((response) => {
 console.log(response)
}).catch(console.error)

Buttons ACTION

whatsapp.sendMessage({
  type: TypeMessage.BUTTON_ACTION,
  body: {
  to: "14375223417",
  header: {
    title: "Example Header",
  },
  text: "This is a test",
  footer: "choose an option",
  buttons: [
   {
      type: "cta_copy",
      copy_code: "1234567890",
      text: "Copy barcode"
    },
    {
      type: "cta_url",
      url: "https://api-wa.me",
      text: "Access the website"
    },
    {
      type: "cta_call",
      phone_number: "+5566996852025",
      text: "Call us"
    }
  ]
}
}).then((response) => {
 console.log(response)
}).catch(console.error)

List Menu

whatsapp.sendMessage({
  type: TypeMessage.MENU,
  body: {
  to: "14375223417",
  buttonText: "Menu",
  text: "string",
  title: "Menu",
  description: "Description",
  footer: "footer",
  sections: [
    {
      title: "Pizza",
      rows: [
        {
          title: "Pizza 01",
          description: "Example pizza 01",
          rowId: "1"
        }
      ]
    }
  ]
}
}).then((response) => {
 console.log(response)
}).catch(console.error)

POLL

whatsapp.sendMessage({
  type: TypeMessage.POLL,
  body: {
  to: "14375223417",
  name: "Do you like PHP?",
  options: [
    "Yes",
    "No"
  ],
}
}).then((response) => {
 console.log(response)
}).catch(console.error)

Link

whatsapp.sendMessage({
  type: TypeMessage.LINK,
  body: {
    to: to,
    text: "\n",
    title:"API WhatsApp",
    description:"Simplify communication, send messages in a versatile way and achieve exceptional results for your business",
    thumbnailUrl:"",
    sourceUrl:"https://api-wa.me",
  }
}).then((response) => {
 console.log(response)
}).catch(console.error)

Audio

whatsapp.sendMessage({
  type: TypeMessage.AUDIO,
  body: {
    to: to,
    url: ""
  }
}).then((response) => {
 console.log(response)
}).catch(console.error)

Image

whatsapp.sendMessage({
  type: TypeMessage.IMAGE,
  body: {
    to: to,
    url: ""
  }
}).then((response) => {
 console.log(response)
}).catch(console.error)

Video

whatsapp.sendMessage({
  type: TypeMessage.VIDEO,
  body: {
    to: to,
    url: ""
  }
}).then((response) => {
 console.log(response)
}).catch(console.error)

Document

whatsapp.sendMessage({
  type: TypeMessage.DOCUMENT,
  body: {
    to: to,
    url: "",
    mimetype: "",
    fileName: ""
  }
}).then((response) => {
 console.log(response)
}).catch(console.error)

Contact

whatsapp.sendMessage({
  type: TypeMessage.CONTACT,
  body: {
    to: to,
    contact: {
      fullName: "Raphael",
      phoneNumber: to,
      organization: "api-wa.me"
    }
  }
}).then((response) => {
 console.log(response)
}).catch(console.error)

Reaction

whatsapp.sendMessage({
  type: TypeMessage.REACTION,
  body: {
    to: to,
    msgId: "ASDDF872AHDURBSG",
    text: "πŸ€–"
  }
}).then((response) => {
 console.log(response)
}).catch(console.error)

All types of submissions you can respond to a message, so for example

Text

whatsapp.sendMessage({
  type: TypeMessage.TEXT,
  body: {
    msgId: "SKJH455AJKJ",
    to: to,
    text: "Hey"
  }
}, true ).then((response) => {
 console.log(response)
}).catch(console.error)

Group Management

List Groups

whatsapp.groups().then((response) => {
 console.log(response)
}).catch(console.error)

Group Information

whatsapp.infoGroup("123456789@us").then((response) => {
 console.log(response)
}).catch(console.error)

Create a Group

whatsapp.createGroup("Devs", [to]).then((response) => {
 console.log(response)
}).catch(console.error)

Update a Group

whatsapp.updateGroup("123456789@us", "Devs", "Only developers !").then((response) => {
 console.log(response)
}).catch(console.error)
1.0.9

10 months ago

1.0.8

11 months ago

1.0.7

11 months ago

1.0.6

2 years ago

1.0.5

2 years ago

1.0.4

2 years ago

1.0.3

2 years ago

1.0.2

2 years ago

1.0.1

2 years ago

1.0.0

2 years ago