API documents#

Green API presents HTTP API WhatsApp for sending and receiving messages, files, working with group chats, getting contacts and other methods.

Make sure you have completed all the steps in Before you start section before executing requests. Check out Requests execution section. Use Postman collection to debug requests to Green API.

Account#

• 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
• Get WhatsApp account information

Archive#

• Get instance connection status

Sending#

• Send text message
• Send poll
• Send video, audio, image, document
• Send video, audio, image, document by URL
• Send location
• Send contact
• Forward messages

Archive#

• Send ordinary buttons
• Send template buttons
• Send list message

Receiving#

Receiving notifications via HTTP API#

• Receive notification
• Delete notification

Receiving notifications via Webhook Endpoint#

Incoming notifications format#

Incoming message#

• Incoming text message
• Ordinary button selection
• Template button selection
• List element selection
• Incoming text message with URL
• Incoming image, video, audio, document message
• Incoming location message
• Incoming contact message
• Incoming message with an array of contacts
• Incoming message with sticker
• Incoming message-reaction
• Incoming message with an invitation to the group
• Incoming poll message
• Incoming poll update message

Outgoing message#

• Message sent from phone
• Message sent via API
• Sent message status

Others#

• Instance status
• Incoming call

Archive#

• Device status

Objects#

• Incoming notifications types

Receiving files#

• Download file from an incoming message

Journals#

• Get chat messages history
• Get chat message
• Get incoming messages journal
• Get outgoing messages journal

Queues#

• Get messages queue
• Clear messages queue

Groups#

• Create a group
• Change group name
• Get group info
• Add group participant
• Remove group participant
• Set group admin rights
• Remove group admin rights
• Leave group

Statuses (β-version)#

Statuses#

• Send text status
• Send voice status
• Send media status
• Delete status

Statistics#

• Get status statistic

History#

• Get incoming statuses
• Get outgoing statuses

Read mark#

• Mark chat read

Service methods#

• Check WhatsApp availability
• Get avatar
• Get contacts
• Get contact info
• Delete message
• Archive chat
• Unarchive chat
• Change chat disappearing messages settings

Other#

• Chat Id
• Messages sending delay
• Common errors
• Reaching the limits on the Developer plan

Integration Recommendations#

• Creating and configuring an instance
• Tracking the state of an instance
• Connecting a phone number to the Green API service
• Working with incoming calls
• Using Green API Hosts
• Working with incoming webhooks

Archive#

Device (phone)#

• Get device info