Skip to content

Initializing search

green-api/issues

Home
Documents
SDK

Products

GREEN-API
GREEN-API: WABA
GREEN-API: GPT
GREEN-API: Marketing
GREEN-API: Telegram

Chatbots
GPT
Integrations
Releases
Articles
Blog
News
FAQ

Home
WhatsApp API documentation hub
WhatsApp API methods reference
Contacts

green-api/issues

Home
Documents
Documents
- Index
- Quick start
  Quick start
  - Before you start
  - Plans
  - Execute requests
  - API collections
    API collections
    
    Apidog collection
    
    Postman collection
    
    Postman Collection on the Website
- 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
    
    Update Api Token
    
    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
    
    Send interactive buttons
    
    Send interactive buttons reply
    
    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
    
    Incoming text message
    
    Incoming text message or URL message
    
    Incoming quoted message
    
    Incoming image, video, audio, document message
    
    Incoming location message
    
    Incoming contact message
    
    Incoming contacts array message
    
    Incoming buttons message
    
    Incoming selection list message
    
    Incoming template buttons message
    
    Incoming sticker message
    
    Incoming reaction message
    
    Group invitation incoming message
    
    Incoming poll message
    
    Incoming poll update message
    
    Incoming edited message
    
    Incoming deleted message
    
    Incoming message with interactive buttons
    
    Incoming message with interactive buttons reply
    
    Selecting buttons
    Selecting buttons
    
    Simple button selection
    
    Template button selection
    
    List element selection
    
    Outgoing message
    Outgoing message
    
    Outgoing messages
    
    Outgoing message status
    
    Message sent from phone
    
    Outgoing message via API
    
    Outgoing text message
    
    Outgoing quoted message
    
    Outgoing image, video, audio, document message
    
    Outgoing location message
    
    Outgoing contact message
    
    Outgoing sticker message
    
    Outgoing reaction message
    
    Group invitation outgoing message
    
    Outgoing poll message
    
    Outgoing poll update message
    
    Outgoing edited message
    
    Outgoing deleted message
    
    Outgoing message with interactive buttons
    
    Outgoing message with interactive buttons reply
    
    Calls
    Calls
    
    Incoming call
    
    Outgoing call
    
    Others
    Others
    
    Instance status
    
    Exceeding limitation on plan
    
    Objects
    Objects
    
    Incoming webhooks types
    
    Archive
    Archive
    
    Device status
    
    Instance socket status
    
    Contact avatar
    
    Incoming block
    
    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
    
    Get incoming calls journal
    
    Get outgoing calls journal
  - Queues
    Queues
    
    Queues - overview
    
    Get messages count to send
    
    Show messages queue to send
    
    Clear messages queue to send
    
    Get webhooks count in the incoming queue
    
    Clear incoming Webhooks queue
  - Groups
    Groups
    
    Groups - overview
    
    Create group
    
    Change group name
    
    Get group data
    
    Update group settings
    
    Add group participant
    
    Delete group participant
    
    Set group admin rights
    
    Remove group admin rights
    
    Set group picture
    
    Leave group
  - Statuses
    Statuses
    
    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
    
    Edit message
    
    Delete message
    
    Archive Chat
    
    UnarchiveChat
    
    Change the settings of disappearing chat messages
    
    Send typing notification
  - Contacts
    Contacts
    
    Contacts methods - overview
    
    Add Contact
    
    Edit Contact
    
    Delete Contact
  - Others
    Others
    
    Chat Id
    
    Message 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
    
    Data synchronization between WhatsApp and Green-API
    
    Using GREEN-API Hosts
    
    Working with incoming webhooks
    
    Tracking the state of an instance
    
    Working with methods to edit and delete messages
    
    Recommendations for handling polls via incoming notifications
    
    Working with incoming calls
    
    How to send a message with a preview
    
    Working with typing notification
    
    Integrating new fields into the API
    
    How to get the name of the interlocutor in integrations?
  - Rate limiter
  - Archive
    Archive
    
    Device (phone)
    Device (phone)
    
    Device - overview
    
    Get device info
- Partners
  Partners
- Console
  Console
  - Overview
  - Registration
  - Settings
  - Chats
    Chats
    
    Chats
    
    How to use Green-API chats via a link?
  - Payment
    Payment
    
    Paying for an instance from your balance
- WABA
  WABA
  - Overview
- FAQ
  FAQ
  - FAQ
  - WhatsApp Business API (WABA)
  - Mobile App
    Mobile App
    
    How to install the GREEN-API app on Android?
    
    How to install the GREEN-API app on iOS?
    
    List of supported mobile operating systems for WhatsApp
  - How to properly use materials from the GREEN-API on another website?
    How to properly use materials from the GREEN-API on another website?
    
    How to properly use materials from the GREEN-API on another website?
    
    How to add a GREEN-API affiliate link to your website
  - WhatsApp features
    WhatsApp features
    
    What are the features of sending and receiving messages to numbers of different countries?
    
    How to confirm the security code in WhatsApp?
    
    How to make links in messages active?
  - WhatsApp capabilities
    WhatsApp capabilities
    
    Account
    Account
    
    How to register phone number on WhatsApp?
    
    How to set up device pairing?
    
    How to transfer your WhatsApp account to another phone?
    
    How to use a proxy server in WhatsApp?
    
    Communication
    Communication
    
    How to text on WhatsApp first?
    
    How to use the click to chat feature?
    
    How to use polls as buttons?
    
    Business-account
    Business-account
    
    How to display company name and logo in chats?
    
    How to get a green check mark in WhatsApp?
    
    How to tell if a number is connected to WhatsApp Business API (WABA)?
    
    Analytics
    Analytics
    
    What are the statuses of messages in WhatsApp?
    
    How to identify your WhatsApp subscribers?
    
    How to log incoming calls in WhatsApp?
    
    How to protect personal data?
    
    How to find out the number of messages sent from an instance?
  - API features
    API features
    
    Important differences in using a lid instead of a telephone number
    
    Features of the CheckWhatsApp method with numbers of some countries
    
    How to format text and use control characters?
    
    How to send emoji or other symbol via the API?
    
    How to run a VBA query?
    
    Why does a welcome message get sent if I text first?
  - Working with files via API
    Working with files via API
    
    How to send a file?
    
    How to send file by sendFileByUrl method using external storage?
    
    What file types does the API support?
    
    Troubleshooting File Sending Issues
    
    How to find out the expiration date of a link?
  - WhatsApp Errors
    WhatsApp Errors
    
    Authorization
    Authorization
    
    Why can`t I download or update WhatsApp?
    
    What to do with the error "WhatsApp is temporarily unavailable. Try again in 1 hour."?
    
    Why is QR code not generated?
    
    Why can not I connect the device to the API?
    
    What to do when receiving the error "Maximum number of devices connected"?
    
    Why is logout happening?
    
    How can I prevent a QR session from being permanently disconnected?
    
    Messages and notifications
    Messages and notifications
    
    Why messages are sent slowly?
    
    Why is the message status "sent"?
    
    Why are incoming notifications slow (webhooks)?
    
    What to do when you receive a "Message Waiting" notification?
    
    Why does the SWE001 error often occur?
    
    Groups
    Groups
    
    Why are members not being added to the group?
    
    Why am I not getting the group name?
  - Account blocking
    Account blocking
    
    About blocking
    About blocking
    
    What types of blocks can WhatsApp impose?
    
    How my WhatsApp number is protected from blocking?
    
    How to protect number from ban?
    
    Number Warming: A Guide to Protecting Yourself from Blocks
    
    How to make mailings without the risk of blocking?
    
    How to implement mailings via CRM?
    
    How does the use of the WA Business application affect the risk of blocking?
    
    What to do when receiving yellowCard status?
    
    Is there liability for messaging on WhatsApp if Meta Platforms Inc is prohibited in Russia?
    
    After getting blocked
    After getting blocked
    
    What to do if your number is blocked?
    
    How to determine if WhatsApp has unblocked my number?
    
    What to do if your instance is locked?
    
    Why is re-blocking happening?
SDK
Products
Products
Chatbots
GPT
Integrations
Releases
Articles
Blog
News
FAQ

Contacts#

This section presents methods for working with WhatsApp contacts

Add Contact
Edit Contact
Delete Contact

Previous Send typing notification

Next Add Contact

Menu

Documentation
SDK
Chatbots
Integrations
Releases
Articles
Blog
News
News archive
FAQ
Become a partner ⭐
Tariffs
Link Builder
About Us
Contacts
Free proxy server
GREEN-API status

Integrations

Make
MS Excel
GoHighLevel
Rocket.chat
Zapier
Zabbix
Slack
n8n
All integrations...

SDK

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

Chatbots

Python
Java
Go
1С:Enterprise
Node.js

Legal notes

Terms of service
License agreement
Payment security
Privacy policy
GREEN-API: Logo

Bitrix24

Terms of service for Bitrix24
Privacy policy for Bitrix24

Products

GREEN-API
GREEN-API: WABA
GREEN-API: GPT
GREEN-API: Marketing
GREEN-API: Telegram 🔥

Legal notes

Terms of service
License agreement
Payment security
Privacy policy
GREEN-API: Logo

Bitrix24

Terms of service for Bitrix24
Privacy policy for Bitrix24

Technical support

Green Community
Report an issue
support@greenapi.com
WhatsApp support channel
Telegram support channel

English

English
Русский

googlePlay

Powered by GREEN-API

Participant of the "Autonomous Cluster Fund "Astana Hub" dated November 20, 2023, No. 1767

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

Participant of the "Autonomous Cluster Fund "Astana Hub" dated November 20, 2023, No. 1767

GREEN-API © 2015 -