Telegram messenger API documentation#
Beta version
The functionality is in beta. Features may change and may also work unstably.
GREEN-API provides a Telegram messenger HTTP API for sending and receiving messages.
Before executing requests, make sure that all the steps of the Before you start section have been completed. Read the Executing requests section.
Account#
- Get a QR code
- Send authorization password
- Start instance authorization
- Send authorization code
- Get instance state
- Reboot instance
- Log out instance
- Get instance settings
- Set instance settings
- Get account information
- Set account avatar
Sending#
- Send text
- Send video, audio, image, document
- Send video, audio, image, document by URL
- Send location
- Send contact
- Send poll
- Forward messages
Receiving#
Receiving notifications via HTTP API#
Receiving notifications via Webhook Endpoint#
Incoming notifications format#
Incoming message#
- Incoming text message
- Incoming text message with a URL
- Incoming message with an image
- Incoming message with a video
- Incoming message with a document
- Incoming message with audio
- Incoming message with a location
- Incoming message with a contact
- Incoming message with a poll
- Incoming message with a sticker
- Incoming reaction message
- Incoming edited message
- Incoming message deletion
Sent message#
- Message sent from the phone
- Message sent from the API
- Sent text message
- Sent message with an image
- Sent message with a video
- Sent message with a document
- Sent message with audio
- Sent message with a location
- Sent message with a contact
- Sent message with a poll
- Sent message with a sticker
- Sent reaction message
- Sent edited message
- Sent message deletion
Journals#
- Get chat message history
- Get a chat message
- Get the incoming messages journal
- Get the sent messages journal
Queues#
Outgoing queue methods#
- Get the number of messages to be sent
- Get the queue of messages to be sent
- Clear the queue of messages to be sent
Incoming queue methods#
Groups#
- Create a group
- Set a group avatar
- Change the group name
- Get group information
- Change group settings
- Add a participant to a group
- Remove a participant from a group
- Grant group administrator rights
- Revoke group administrator rights
- Leave a group
Service methods#
- Check for a Telegram account
- Get an avatar
- Get the chat list
- Get contacts
- Get contact information
- Edit a message
- Delete a message
- Send a typing notification
- Archive a chat
- Unarchive a chat
Others#
- Chat identifier
- Message identifier
- Message sending interval
- Common errors
- Reaching the Developer plan limits