This API deals with a chatting platform based on WhatsApp. The user can send and receive text and media messages through WhatsApp in private chats with the endpoints that are created for the user. Moreover, the current status and the screen of the session can be retrieved using these endpoints. With the account specific endpoints, user can get the product or registered phones information, edit and remove these.
You need to send 'x-maytapi-key':'YOUR_TOKEN' header with every request.
You can find your product_id and token at https://console.maytapi.com/settings/token
You can find message examples in /sendMessage documentation section Screenshot
| Feature | Status | Description |
|---|---|---|
| Receive message | ✅ | You need to set your webhook with /setWebhook endpoint. |
| Receive media | ✅ | Image, Video, Docs/File, Audio, Location, vCard supported. |
| Send Text Message | ✅ | Send message works with queue. Message id and success response states that message added to sending queue. If your messages isn't sent, check your instance status for connection/login problems. You can also check /logs endpoint or Developer Logs Page for error messages if you are using the wrong format you can find the error here. You can also check your queue status in Developer Webhook Page or with /{phone_id}/queue endpoint. |
| Send Media | ✅ | Image, Audio(ogg-file in opus codec), Video, Docs(pdf,docx,etc.) supported. |
| Send vCard | ✅ | You can find the example in /sendMessage → Examples → vCard Message. |
| Send Contact | ✅ | You can find the example in /sendMessage → Examples → Contact Message. |
| Send Location | ✅ | You can find the example in /sendMessage → Examples → Location Message. |
| Send Product | ✅ | You can find the example in /sendMessage → Examples → Product Message (Beta). You need to create products from WhatsApp Business Phone App. You can find Product Ids from the new /catalog endpoint. |
| Forward Messages | ✅ | You can find the example in /sendMessage → Examples → Forward Message. |
| Reply to Messages | ✅ | You can find the example in /sendMessage → Examples → Reply Message. |
| Delete Messages | ✅ | You can find the example in /sendMessage → Examples → Delete Message. |
| Reaction Message | ✅ | You can find the example in /sendMessage → Examples → Reaction Message. |
| Edit Message | ✅ | You can find the example in /sendMessage → Examples → Edit Message. |
| Create Groups | ✅ | You can find the example in /{phone_id}/createGroup. |
| Get groups | ✅ | You can find the example in /{phone_id}/getGroups. |
| Mention Message for Groups | ✅ | You can find the example in /sendMessage → Examples → Group Mention Message. |
| Leave Group | ✅ | You can find the example in /leaveGroup. |
| New Spam Filter | ✅ | We added a new spam/dupe filter for recurring messages in the same conversation. In a conversation, the last 3 unique messages can't be sent more than 3 times. This feature is to ignore spam messages sent to the same user. Sending the same message to different users is not filtered. You can also ignore the filter by adding "skip_filter":true to messages. You can find an example of this in the /sendMessage examples section. |
| Listen to Read Receipts | ✅ | You need to enable this with /setAckPreference endpoint. |
| Webhook examples | ✅ | You can find webhook examples in Callbacks tab of /setWebhook endpoint definition. |
| WhatsApp Channel Example | ✅ | You can find Channel Chat Operations. |
| WhatsApp Story Example | ✅ | You can find Story Operations (Beta). |
Contact: Maytapi Support
Version: 1.9.1