API Overview

Every Zawa endpoint on one page. If this is your first time, stop by the Quick Start first.

The Basics

• Base URL: https://api-zawa.azickri.com
• Authentication: the id and session-id headers from Create Session, required on every endpoint except POST /session
• Format: JSON for both requests and responses
• Errors: always { "statusCode": number, "message": string }. See Errors & Fixes

Session API

Create, monitor, and manage your WhatsApp number's connection.

Method	Endpoint	Purpose
POST	/session	Create a session and get its id + sessionId
GET	/session	Get session info, the QR code, and connection status
PUT	/session	Unlink the device and generate a new QR code
DELETE	/session	Delete the session and all of its data

Send API

Send things from your number.

Method	Endpoint	Purpose
POST	/message	Send text, images, video, audio, documents, locations, or contacts
POST	/status	Post a text, image, or video status
POST	/typing	Show a typing or recording-audio indicator

Channel API

Read data from the WhatsApp channels (newsletters) you follow.

Method	Endpoint	Purpose
GET	/channel	List the channels you follow
GET	/channel/{channelId}	Get one channel's details
GET	/channel/message	Channel message history, 100 per page

Group API

Read data from the WhatsApp groups you're in.

Method	Endpoint	Purpose
GET	/group	List the groups you're in
GET	/group/{groupId}	Get one group's details
GET	/group/member	List a group's members

What about webhooks?

The current Zawa engine has no webhook, so Zawa can't notify you about incoming messages yet. The old webhook docs are kept on the Webhook (Deprecated) page for reference.