Skip to content

GREEN API

Initializing search

green-api/issues

Home
Blog
Documents
Releases
SDK
Chatbots
Integrations
News
FAQ

GREEN API

green-api/issues

Home
Home
- Home
Blog
Blog
- Blog
Documents
Documents
- Index
- Quick start
  Quick start
- API documents
  API documents
  - Overview
  - Account
    Account
    
    Account - overview
    
    Get account settings
    
    Set account settings
    
    Get account state
    
    Get account connection status
    
    Reboot account
    
    Logout account
    
    Get QR code
    
    Get QR code via websocket
    
    Link with phone number
    
    Set profile picture
    
    Get WhatsApp account information
  - Sending
    Sending
    
    Sending - overview
    
    Send text
    
    Send Buttons
    
    Send Template Buttons
    
    Send List Message
    
    Send Poll
    
    Send video, audio, image, document
    
    Send video, audio, image, document via URL
    
    Upload file
    
    Send location
    
    Send contact
    
    Forward messages
  - 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
    
    Account status
    
    Device status
    
    Contact avatar
    
    Account socket status
    
    Incoming call
    
    Incoming block
    
    Exceeding limitation
    
    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 outgoing statuses
    
    Get incoming statuses
  - Read mark
    Read mark
    
    Read mark - overview
    
    Mark chat as read
  - Device (phone)
    Device (phone)
    
    Device - overview
    
    Get device info
  - Service methods
    Service methods
    
    Service methods - overview
    
    Check WhatsApp availability
    
    Get avatar
    
    (deprecated) Get avatar asynchronously
    
    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 tariff
  - Integration Recommendations
    Integration Recommendations
    
    Integration Recommendations - overview
    
    Creating and configuring an instance
    
    Connecting a phone number to the Green API service
    
    Tracking the state of an instance
    
    Working with incomming calls
    
    Work with blocking notification
  - Rate limiter
- Partners
  Partners
- Personal cabinet
  Personal cabinet
  - Overview Overview
    Table of contents
    
    Registration
  - Registration
- FAQ
  FAQ
Releases
Releases
- Overview
- GREEN-API releases
  GREEN-API releases
SDK
SDK
- Overview
- GREEN-API SDK
  GREEN-API SDK
  - Python WhatsApp Library
    Python WhatsApp Library
    
    Overview
    
    Python WhatsApp Library
    Python WhatsApp 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 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 Library
    Golang WhatsApp 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
  - Java WhatsApp Library
    Java WhatsApp Library
    
    Overview
    
    Java WhatsApp Library
    Java WhatsApp 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 Library
    PHP WhatsApp 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
  - NodeJs WhatsApp Library
    NodeJs WhatsApp 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
    
    How to send a text message from a browser
  - 1С WhatsApp Library
    1С WhatsApp Library
    
    Overview
    
    How to send a text message
    
    How to send a text message to a group
    
    How to receive a message
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
    
    GREEN-API 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
    
    GREEN-API 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
    
    GREEN-API demo chatbot
- Examples of chatbots
  Examples of chatbots
Integrations
Integrations
- Overview
- List of integrations
  List of integrations
  - Zapier
    Zapier
    
    Overview
    
    Integration setup
    
    How to make messaging between WhatsApp and Slack
    
    How to make messaging between WhatsApp and Discord
  - Make
    Make
    
    Overview
    
    Integration setup
    
    How to make messaging between WhatsApp and Slack
    
    How to make messaging between WhatsApp and Discord
  - Slack
    Slack
    
    Overview
    
    Integration setup
    
    Integration command descriptions
News
News
FAQ
FAQ
- FAQ

Table of contents

Registration

Personal cabinet#

Registration #

Register in your personal account to access instances and API functions

Previous Get all instances of an account created by a partner

Next Registration

Documentation

API

support@green-api.com

Subscribe to us

© GREEN API