English
API Overview
Every Zate endpoint on one page. If this is your first time, stop by the Quick Start first.
The Basics
- Base URL:
https://api-zate.azickri.com - Authentication: the
idandsession-idheaders from Create Session, required on every endpoint exceptPOST /sessionandGET /media/... - Format: JSON, for both requests and responses
- Errors: always
{ "statusCode": number, "message": string }. See Errors & Fixes
Session API
Create, monitor, and manage your Telegram account's login.
| Method | Endpoint | Purpose |
|---|---|---|
| POST | /session | Create a new session and get an id + sessionId |
| GET | /session | Get session info, the QR code, and connection status |
| POST | /session/password | Submit the two-step verification password |
| PUT | /session/webhook | Set the webhook URL and token |
| PUT | /session | Log the Zate device out and get a new QR |
| DELETE | /session | Delete the session and all its data |
Send API
Send things as your account.
| Method | Endpoint | Purpose |
|---|---|---|
| POST | /message | Send text, images, videos, audio, documents, locations, or contacts |
| POST | /status | Post a text, image, or video story |
| POST | /typing | Show a typing or recording indicator |
Channel API
Read the Telegram channels you follow.
| Method | Endpoint | Purpose |
|---|---|---|
| GET | /channel | Channels you follow |
| GET | /channel/{channelId} | One channel in detail |
| GET | /channel/message | Channel message history, 100 per page |
Group API
Read the Telegram groups you're in.
| Method | Endpoint | Purpose |
|---|---|---|
| GET | /group | Groups you're in |
| GET | /group/{groupId} | One group in detail |
| GET | /group/member | Group member list |
Media API
Public links for Telegram media. No headers needed.
| Method | Endpoint | Purpose |
|---|---|---|
| GET | /media/{...} | Stream images, videos, stickers, documents, or profile photos |
Coming from Zawa?
Zate is deliberately as close to Zawa as possible: same headers, same endpoint names, same error shape. Your code mostly needs a new base URL, plus these:
| In Zawa | In Zate |
|---|---|
Receivers: phone, group, newsletter | Receivers: phone, username, user, group, channel. See Receivers. |
| Phone numbers always work | Phone numbers only work if the person's privacy allows it. Prefer username or user. |
| Scan from Linked devices in WhatsApp | Scan from Settings → Devices → Link Desktop Device in Telegram. |
| Connected right after the scan | Accounts with two-step verification need Submit Password. Get Session has new isPasswordRequired, passwordHint, username, phone, and webhook fields. |
Session picture is a URL | Session, group, and channel picture is a data URI (data:image/jpeg;base64,...). |
| Status follows the status privacy on your phone | A Telegram story with a privacy option: contacts, everyone, or close_friends. |
WhatsApp-style formatting (*bold*, _italic_) just works | Text is sent as is. For formatting, set parseMode (markdown or html). |
| No webhook | A webhook for incoming private chat messages. |
| Media URLs straight from WhatsApp | Media URLs are Zate public links streamed from Telegram. |
Group and channel created = creation date | created = the date your account joined. |
IDs: [email protected], ...@newsletter | IDs: numbers, like -1001234567890. |