Skip to content

Latest commit

 

History

History
101 lines (79 loc) · 2.41 KB

APIDOC.MD

File metadata and controls

101 lines (79 loc) · 2.41 KB
Raw

API Doc

Auth

Getting QR Code GET : /auth/getqr

Used to get a QR Code to Log into Whatsapp Web - If not logged in, returns a QR Code - If logged in, returns a "Authenticated" message.

Chat

Sending Messages POST : /chat/sendmessage/<phone_number>

Request Body

  • message - contains the message to be sent

Sending Images POST : /chat/sendimage/<phone_number>

Request Body

  • image - contains the base64 encoded / URL of image to be sent
  • caption - (optional) - contains caption for the message

Sending PDF POST : /chat/sendpdf/<phone_number>

Request Body

  • pdf - contains the base64 encoded / URL of pdf to be sent

Sending Locations POST : /chat/sendlocation/<phone_number>

Request Body

  • latitude - contains the string of latitude
  • longitude - contains the string of longitude
  • description - (optional) - contains description for the location

Get Chat By Id GET : /chat/getchatbyid/<phone_number>

Returns a Chat

Get Chats GET : /chat/getchats

Returns an Array of all Chats

Group Chat

Sending Messages to Group POST : /group/sendmessage/<Group_Name>

Request Body

  • message - contains the message to be sent

Sending Images POST : /group/sendimage/<Group_Name>

Request Body

  • image - contains the base64 encoded / URL of image to be sent
  • caption - (optional) - contains caption for the message

Sending PDF POST : /group/sendpdf/<Group_Name>

Request Body

  • pdf - contains the base64 encoded / URL of pdf to be sent

Sending Locations POST : /group/sendlocation/<Group_Name>

Request Body

  • latitude - contains the string of latitude
  • longitude - contains the string of longitude
  • description - (optional) - contains description for the location

Contact

Get Contacts GET : /contact/getcontacts

Returns an Array of Contacts of the Current Instance

Get Contact GET : /contact/getcontact/<phone_number>

Returns a Contact

Get Profile Pic GET : /contact/getprofilepic/<phone_number>

Returns a URL of the User's Profile Picture if Privacy Settings allow it

Is Registered User GET : /contact/isregistereduser/<phone_number>

Returns if a given User is registered on Whatsapp

NOTE: Do not use nodemon to run this, as it messes with the authentication process.