Jump to Content
API Reference
v1.0
Log In
API Reference
Search
Log In
v1.0
API Reference
When you joined or were added to a group
All
Pages
Start typing to search…
JUMP TO
GOWAPI - WhatsApp HTTP API
🖥️ Sessions (Devices)
List all sessions
get
Create a session
post
Get session information
get
Update a session
put
Delete the session
del
Get information about the authenticated account
get
Start the session
post
Stop the session
post
Logout from the session
post
Restart the session
post
Upsert and Start session
post
Stop (and Logout if asked) session
post
Logout and Delete session.
post
📱 Pairing Connection
Get QR code for pairing WhatsApp API.
get
Request authentication code.
post
🆔 Profile
Get my profile
get
Set my profile name
put
Set profile status (About)
put
Set profile picture
put
Delete profile picture
del
📤 Chatting
Send a text message
post
Send a text message
get
Send an image
post
Send a file
post
Send an voice message
post
Send a video
post
Send a text message with a CUSTOM link preview.
post
Send buttons message (interactive)
post
Send a list message (interactive)
post
/api/forwardMessage
post
/api/sendSeen
post
/api/startTyping
post
/api/stopTyping
post
React to a message with an emoji
put
Star or unstar a message
put
Send a poll with options
post
Vote on a poll
post
/api/sendLocation
post
/api/sendContactVcard
post
Reply on a button message
post
Get messages in a chat
get
Check number status
get
DEPRECATED - you can set "reply_to" field when sending text, image, etc
post
/api/sendLinkPreview
post
✅ Presence
Set session presence
post
Get all subscribed presence information.
get
Get the presence for the chat id. If it hasn't been subscribed - it also subscribes to it.
get
Subscribe to presence events for the chat.
post
📢 Channels
Get list of know channels
get
Create a new channel.
post
Delete the channel.
del
Get the channel info
get
Preview channel messages
get
Follow the channel.
post
Unfollow the channel.
post
Mute the channel.
post
Unmute the channel.
post
Search for channels (by view)
post
Search for channels (by text)
post
Get list of views for channel search
get
Get list of countries for channel search
get
Get list of categories for channel search
get
🟢 Status
Send text status
post
Send image status
post
Send voice status
post
Send video status
post
DELETE sent status
post
Generate message ID you can use to batch contacts
get
💬 Chats
Get chats
get
Get chats overview. Includes all necessary things to build UI "your chats overview" page - chat id, name, picture, last message. Sorting by last message timestamp
get
Get chats overview. Use POST if you have too many "ids" params - GET can limit it
post
Deletes the chat
del
Gets chat picture
get
Gets messages in the chat
get
Clears all messages from the chat
del
Read unread messages in the chat
post
Gets message by id
get
Deletes a message from the chat
del
Edits a message in the chat
put
Pins a message in the chat
post
Unpins a message in the chat
post
Archive the chat
post
Unarchive the chat
post
Unread the chat
post
🔑 Api Keys
Create a new API key
post
Get all API keys
get
Update an API key
put
Delete an API key
del
👤 Contacts
Get all contacts
get
Get contact basic info
get
Check phone number is registered in WhatsApp.
get
Gets the Contact's "about" info
get
Get contact's profile picture URL
get
Block contact
post
Unblock contact
post
Create or update contact
put
Get all known lids to phone number mapping
get
Get the number of known lids
get
Get phone number by lid
get
Get lid by phone number (chat id)
get
👥 Groups
Create a new group.
post
Get all groups.
get
Get info about the group before joining.
get
Join group via code
post
Get the number of groups.
get
Refresh groups from the server.
post
Get the group.
get
Delete the group.
del
Leave the group.
post
Get group picture
get
Set group picture
put
Delete group picture
del
Updates the group description.
put
Updates the group subject
put
Updates the group "info admin only" settings.
put
Get the group's 'info admin only' settings.
get
Update settings - who can send messages
put
Get settings - who can send messages
get
Gets the invite code for the group.
get
Invalidates the current group invite code and generates a new one.
post
Get participants
get
Get group participants.
get
Add participants
post
Remove participants
post
Promote participants to admin users.
post
Demotes participants to regular users.
post
📞 Calls
Reject incoming call
post
📅 Events
Send an event message
post
🏷️ Labels
Get all labels
get
Create a new label
post
Update a label
put
Delete a label
del
Get labels for the chat
get
Save labels for the chat
put
Get chats by label
get
🖼️ Media
Convert voice to WhatsApp format (opus)
post
Convert video to WhatsApp format (mp4)
post
WEBHOOK
call.accepted
The event is triggered when the call is accepted by the user.
post
call.received
The event is triggered when the call is received by the user.
post
call.rejected
The event is triggered when the call is rejected by the user.
post
chat.archive
The event is triggered when the chat is archived or unarchived
post
engine.event
Internal engine event.
post
event.response
The event is triggered when the event response is received.
post
event.response.failed
The event is triggered when the event response is failed to decrypt.
post
group.join
Some one join a group.
post
group.leave
Some one left a group.
post
group.v2.join
When you joined or were added to a group
post
group.v2.leave
When you left or were removed from a group
post
group.v2.participants
When participants changed - join, leave, promote to admin
post
group.v2.update
When group info is updated
post
label.chat.added
The event is triggered when a label is added to a chat
post
label.chat.deleted
The event is triggered when a label is deleted from a chat
post
label.deleted
The event is triggered when a label is deleted
post
label.upsert
The event is triggered when a label is created or updated
post
message
Incoming message.
post
message.ack
Receive events when server or recipient gets the message, read or played it (contacts only).
post
message.ack.group
Receive events when participants in a group read or play messages.
post
message.any
Fired on all message creations, including your own.
post
message.edited
The event is triggered when a user edits a previously sent message.
post
message.reaction
The event is triggered when a user reacts or removes a reaction.
post
message.revoked
The event is triggered when a user, whether it be you or any other participant, revokes a previously sent message.
post
poll.vote
With this event, you receive new votes for the poll sent.
post
poll.vote.failed
There may be cases when it fails to decrypt a vote from the user. Read more about how to handle such events in the documentations.
post
presence.update
The most recent presence information for a chat.
post
session.status
The event is triggered when the session status changes.
post
state.change
It’s an internal engine’s state, not session status.
post
Powered by
WEBHOOK
group.v2.join
When you joined or were added to a group
Ask AI
wbhk
group.v2.join
