For AI agents: the docs index is at https://gowapi.readme.io/llms.txt. Append .md to any documentation page URL to get its markdown version.

Jump to Content

v1.0

API Reference

v1.0API Reference

GOWAPI - WhatsApp HTTP API

🖥️ Sessions (Devices)
📱 Pairing Connection
- Get QR code for pairing WhatsApp API.get
- Request authentication code.post
🆔 Profile
📤 Chatting
✅ Presence
📢 Channels
🟢 Status
💬 Chats
🔑 Api Keys
👤 Contacts
👥 Groups
📞 Calls
- Reject incoming callpost
📅 Events
- Send an event messagepost
🏷️ Labels
🖼️ 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.webhook
call.received
- The event is triggered when the call is received by the user.webhook
call.rejected
- The event is triggered when the call is rejected by the user.webhook
chat.archive
- The event is triggered when the chat is archived or unarchivedwebhook
engine.event
- Internal engine event.webhook
event.response
- The event is triggered when the event response is received.webhook
event.response.failed
- The event is triggered when the event response is failed to decrypt.webhook
group.join
- Some one join a group.webhook
group.leave
- Some one left a group.webhook
group.v2.join
- When you joined or were added to a groupwebhook
group.v2.leave
- When you left or were removed from a groupwebhook
group.v2.participants
- When participants changed - join, leave, promote to adminwebhook
group.v2.update
- When group info is updatedwebhook
label.chat.added
- The event is triggered when a label is added to a chatwebhook
label.chat.deleted
- The event is triggered when a label is deleted from a chatwebhook
label.deleted
- The event is triggered when a label is deletedwebhook
label.upsert
- The event is triggered when a label is created or updatedwebhook
message
- Incoming message.webhook
message.ack
- Receive events when server or recipient gets the message, read or played it (contacts only).webhook
message.ack.group
- Receive events when participants in a group read or play messages.webhook
message.any
- Fired on all message creations, including your own.webhook
message.edited
- The event is triggered when a user edits a previously sent message.webhook
message.reaction
- The event is triggered when a user reacts or removes a reaction.webhook
message.revoked
- The event is triggered when a user, whether it be you or any other participant, revokes a previously sent message.webhook
poll.vote
- With this event, you receive new votes for the poll sent.webhook
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.webhook
presence.update
- The most recent presence information for a chat.webhook
session.status
- The event is triggered when the session status changes.webhook
state.change
- It’s an internal engine’s state, not session status.webhook

Powered by

WEBHOOK
chat.archive

The event is triggered when the chat is archived or unarchived

webhook

chat.archive

Payload

id

string

required

Unique identifier for the event - lower case ULID format. https://github.com/ulid/spec

timestamp

number

required

Unix timestamp (ms) for when the event was created.

session

string

required

metadata

object

Metadata for the session.

engine

string

enum

required

Allowed:

event

object

enum

required

The event is triggered when the chat is archived or unarchived

payload

object

required

me

object

environment

object

required

Response

200

Return a 200 status to indicate that the data was received successfully

Updated 9 months ago

The event is triggered when the call is rejected by the user.

Did this page help you?

Loading…

Updated 9 months ago

The event is triggered when the call is rejected by the user.

Did this page help you?