Skip to content

GREEN API

Initializing search

green-api/issues

Home
Documents
SDK
Chatbots
Integrations
Releases
Blog
News
FAQ

GREEN API

green-api/issues

Home
Home
- Home
Documents
Documents
- Index
- Quick start
  Quick start
- API documents
  API documents
  - Overview
  - Account
    Account
    
    Account - overview
    
    Get instance settings
    
    Set instance settings
    
    Get instance state
    
    Reboot instance
    
    Logout instance
    
    Get QR code
    
    Get QR code via websocket
    
    Link with phone number
    
    Set profile picture
    
    Get WhatsApp account information
    
    Archive
    Archive
    
    Get instance connection status
  - Sending
    Sending
    
    Sending - overview
    
    Send text
    
    Send Poll
    
    Send video, audio, image, document
    
    Send video, audio, image, document via URL
    
    Upload file
    
    Send location
    
    Send contact
    
    Forward messages
    
    Archive
    Archive
    
    Send Buttons
    
    Send Template Buttons
    
    Send List Message
  - Receiving
    Receiving
    
    Conception
    
    HTTP API
    HTTP API
    
    HTTP API technology
    
    Receive notification
    
    Delete notification
    
    Webhook Endpoint
    Webhook Endpoint
    
    Webhook Endpoint technology
    
    Incoming notifications format
    Incoming notifications format
    
    Overview
    
    Incoming message
    Incoming message
    
    Incoming messages
    
    Text
    
    Text with URL
    
    Video, audio, image, document
    
    Location
    
    Contact
    
    Array of contacts
    
    Incoming buttons message
    
    Selection list incoming message
    
    Template buttons incoming message
    
    Incoming message with sticker
    
    Incoming message-reaction
    
    Incoming message with an invitation to the group
    
    Incoming poll message
    
    Incoming poll update message
    
    (deprecated) Quoted message
    
    Selecting buttons
    Selecting buttons
    
    Simple button selection
    
    Template button selection
    
    List element selection
    
    Outgoing message
    Outgoing message
    
    Message sent from phone
    
    Message sent via API
    
    Outgoing message status
    
    Others
    Others
    
    Instance status
    
    Contact avatar
    
    Instance socket status
    
    Incoming call
    
    Incoming block
    
    Exceeding limitation on plan
    
    Archive
    Archive
    
    Device status
    
    Objects
    Objects
    
    Incoming webhooks types
    
    Get files
    Get files
    
    Download file from incoming message
  - Journals
    Journals
    
    Journals - review
    
    Get chat history
    
    Get chat message
    
    Get incoming messages journal
    
    Get outgoing messages journal
  - Queues
    Queues
    
    Queues - overview
    
    Show messages queue
    
    Clear messages queue
  - Groups
    Groups
    
    Groups - overview
    
    Create group
    
    Change group name
    
    Get group data
    
    Add group participant
    
    Delete group participant
    
    Set group admin rights
    
    Remove group admin rights
    
    Set group picture
    
    Leave group
  - Statuses (β-version)
    Statuses (β-version)
    
    Statuses - overview
    
    Statuses
    Statuses
    
    Send text status
    
    Send voice status
    
    Send media status
    
    Delete status
    
    Statistics
    Statistics
    
    Get status statistic
    
    History
    History
    
    Get incoming statuses
    
    Get outgoing statuses
  - Read mark
    Read mark
    
    Read mark - overview
    
    Mark chat as read
  - Service methods
    Service methods
    
    Service methods - overview
    
    Check WhatsApp availability
    
    Get avatar
    
    Get contacts
    
    Get Contact Info
    
    Delete message
    
    Archive Chat
    
    UnarchiveChat
    
    Change the settings of disappearing chat messages
  - Others
    Others
    
    Chat Id
    
    Messages sending delay
    
    Common errors
    
    Reaching the limits on the Developer plan
  - Integration Recommendations
    Integration Recommendations
    
    Integration Recommendations - overview
    
    Creating and configuring an instance
    
    Сreating and configuring an instance using the partner key
    
    Connecting a phone number to the GREEN API service
    
    Tracking the state of an instance
    
    Working with incoming calls
    
    Using GREEN API Hosts
    
    Working with incoming webhooks
  - Rate limiter
  - Archive
    Archive
    
    Device (phone)
    Device (phone)
    
    Device - overview
    
    Get device info
- Partners
  Partners
- Console
  Console
  - Overview
  - Registration
- FAQ
  FAQ
SDK
SDK
- Overview
- GREEN-API SDK
  GREEN-API SDK
  - Python WhatsApp Library
    Python WhatsApp Library
    
    Overview
    
    Python WhatsApp Client Library
    Python WhatsApp Client Library
    
    Overview
    
    How to send a text message
    
    How to send a file by URL
    
    How to send a file by uploading from the disk
    
    How to create a group and send a message to it
    
    How to process incoming notifications
    
    The full list of the library methods
    
    Python Webhook Server Library
    Python Webhook Server Library
    
    Overview
    
    Example of preparing a server environment on Ubuntu operating system
    
    Example of preparing a server environment on the Windows operating system
    
    Python Webhook server library
    
    Example of set up server environment using Docker
    
    Archive
    Archive
    
    Python Webhook Server Library v1.0
    Python Webhook Server Library v1.0
    
    Overview
    
    Example of preparing a server environment on the Ubuntu operating system
    
    Example of preparing a server environment on the Windows operating system
    
    Python Webhook server library
    
    Example of unrolling a server environment in a Docker container
    
    Example of unrolling a server via Docker Compose
    
    Example of unrolling a server in a Docker container on Yandex Cloud
  - Golang WhatsApp Library
    Golang WhatsApp Library
    
    Overview
    
    Golang WhatsApp Client Library
    Golang WhatsApp Client Library
    
    Overview
    
    How to create a group
    
    How to send a file by uploading from the disk
    
    How to send a file by URL
    
    How to send a message
    
    How to receive incoming notifications
    
    The full list of the library methods
    
    Golang Webhook Server Library
    Golang Webhook Server Library
    
    Overview
    
    How to run the web server
    
    Example of preparing the environment for Ubuntu Server
    
    Archive
    Archive
    
    Golang WhatsApp Client Library
    Golang WhatsApp Client Library
    
    Overview
    
    How to create a group
    
    How to send a file by uploading from the disk
    
    How to send a file by URL
    
    How to send a message
    
    How to receive incoming notifications
    
    The full list of the library methods
  - Java WhatsApp Library
    Java WhatsApp Library
    
    Overview
    
    Java WhatsApp Client Library
    Java WhatsApp Client Library
    
    Overview
    
    How to send message
    
    How to create new group and send message
    
    How to send a file by uploading from the disk
    
    How to send a file by URL
    
    How to send a file by UploadFile + SendByUrl
    
    How to send poll
    
    How to process incoming notifications
    
    The full list of the library methods
    
    Java Webhook Server Library
    Java Webhook Server Library
    
    Overview
    
    How to run the web server
    
    Example of preparing the environment for Ubuntu Server
  - PHP WhatsApp Library
    PHP WhatsApp Library
    
    Overview
    
    PHP WhatsApp Client Library
    PHP WhatsApp Client Library
    
    Overview
    
    How to send a text message
    
    How to send a file by URL
    
    How to send a file by uploading from the disk
    
    How to create a group and send a message to it
    
    How to handle incoming notifications
    
    The full list of the library methods
  - Node.js WhatsApp Library
    Node.js WhatsApp Library
    
    Overview
    
    Node.js WhatsApp client Library
    Node.js WhatsApp client Library
    
    Overview
    
    How to send a text message
    
    How to send a file by URL
    
    How to send a file by uploading from the disk
    
    How to receive and process a notification
    
    How to receive and process a notification using a server
    
    How to receive webhook endpoint notifications on the local machine
    
    How to get a QR code
  - HTML5 WhatsApp Library
    HTML5 WhatsApp Library
    
    Overview
    
    HTML5 WhatsApp Client Library
    HTML5 WhatsApp Client Library
    
    Overview
    
    How to send a text message from a browser
  - 1С WhatsApp Library
    1С WhatsApp Library
    
    Overview
    
    1C WhatsApp Client Library
    1C WhatsApp Client Library
    
    Processing setup and authorization
    
    1C WhatsApp processing model
    
    How to send a text message
    
    How to send a text message to a group
    
    How to receive a message
  - C++ WhatsApp Library
    C++ WhatsApp Library
    
    Overview
    
    C++ WhatsApp Client Library
    C++ WhatsApp Client Library
    
    Overview
    
    Building and installation
    
    How to send a message
    
    How to send file by URL
    
    How to send file by upload
    
    How to receive notifications
    
    How to create group
    
    Full list of all methods
    
    C++ Webhook Server Library
    C++ Webhook Server Library
    
    Overview
    
    Building and installation on Windows
    
    Building and installation on Linux
    
    Deploying a server in a Docker container
    
    Configuration
    
    User Adapter
    
    JSON Validation
Chatbots
Chatbots
- Overview
- Chatbot libraries
  Chatbot libraries
  - Python chatbot WhatsApp Library
    Python chatbot WhatsApp Library
    
    Overview
    
    How to start receiving and answering messages
    
    How to receive other notifications and handle the notification body
    
    How to filter incoming messages
    
    How to handle buttons
    
    Example of a bot
    
    Python demo chatbot
  - Go chatbot WhatsApp Library
    Go chatbot WhatsApp Library
    
    Overview
    
    How to import the library and initiate your bot
    
    How to start receiving and responding to messages
    
    How to receive other notifications
    
    How to filter incoming messages
    
    How to manage state and scenes
    
    Bot example
    
    Golang demo chatbot
    
    How to run a demo chatbot locally from a docker container?
  - NodeJs chatbot WhatsApp Library
    NodeJs chatbot WhatsApp Library
    
    Overview
  - 1C chatbot WhatsApp Library
    1C chatbot WhatsApp Library
    
    Overview
  - Java chatbot WhatsApp Library
    Java chatbot WhatsApp Library
    
    Overview
    
    How to import the library and configure your bot
    
    How to start receiving and responding to messages
    
    How to receive other notifications
    
    How to filter incoming messages
    
    How to manage state and scenes
    
    Bot example
    
    Java demo chatbot
- Examples of chatbots
  Examples of chatbots
Integrations
Integrations
- Overview
- List of integrations
  List of integrations
  - Make
    Make
    
    Overview
    
    Integration setup
    
    How to make messaging between WhatsApp and Slack
    
    How to make messaging between WhatsApp and Discord
  - MS Excel
    MS Excel
    
    Overview
    
    Integration setup
    
    How to send text messages
    
    How to send files
  - Slack
    Slack
    
    Overview
    
    Integration setup
    
    Integration command descriptions
  - Zapier
    Zapier
    
    Overview
    
    Integration setup
    
    How to make messaging between WhatsApp and Slack
    
    How to make messaging between WhatsApp and Discord
Releases
Releases
- Overview
- GREEN-API releases
  GREEN-API releases
Blog
Blog
- Blog
News
News
FAQ
FAQ
- FAQ

Queues#

This section presents methods for working with a messages queue.

Show messages queue
Clear messages queue

Previous Get outgoing messages journal

Next Show messages queue

Menu

Documentation
SDK
Chatbots
Become a partner ⭐
Integrations
Releases
Blog
News
FAQ
Free proxy server

SDK

Python
Node.js
HTML
1C:Enterprise
PHP
Java
Go
C++

Integrations

Make
Slack
Zapier
MS Excel

Chatbots

Python
Java
Go
1C:Enterprise
Node.js

Legal notes

Terms of service
License agreement
Payment security
Privacy policy

YouTube channel

YouTube

Green Community

Github

Report an issue

Github

support@greenapi.com

Email

WhatsApp support channel

Telegram support channel

English

English
Русский

«Green-API» LLC

TIN 220940032673

Telephone: +44-745-803-80-17

Astana, Kabanbai Batyr Avenue, building 47/2,

Business Center "Alau Park", 010017, Kazakhstan

GREEN API © 2015 -