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 account settings
- Set account settings
- Get account state
- Reboot account
- Logout account
- Get QR code
- Get QR code via websocket
- Link with phone number
- Get WhatsApp account information
Sending#
- Send text message
- Send ordinary buttons
- Send template buttons
- Send list message
- Send poll
- Send video, audio, image, document
- Send video, audio, image, document by URL
- Send location
- Send contact
Receiving#
Receiving notifications via HTTP API#
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#
Others#
Objects#
Receiving files#
Journals#
- Get chat messages history
- Get chat message
- Get incoming messages journal
- Get outgoing messages journal
Queues#
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#
Statistics#
History#
Read mark#
Device (phone)#
Service methods#
- Check WhatsApp availability
- Get avatar
- Get avatar asynchronously
- Get contacts
- Get contact info
- Delete message
- Archive chat
- Unarchive chat
- Change chat disappearing messages settings