Overview
While Chats API lets you handle your own chat channel, the Chats API add-on extends the capabilities of your integration by allowing it to interact with external chat channels created by other integrations (e.g. WhatsApp Business). With this add-on, your integration can:
- Send messages to the external chat channels.
- Retrieve chat history from the external chat channels.
- Build custom messaging workflows while keeping conversations synchronized with your Kommo account.
Scopes and limitations
The Chats API add-on methods is available for Trial, Pro, Enterprise and Technical plans. In order to use this API, you must obtain the appropriate scopes for your integration:
Sending to external chats- required to send messages to connected external chat channels.External chat history- required to retrieve chat history and conversation messages.
Your integration can only access the functionality for which the corresponding scopes have been granted.
API reference
The available API methods are the following:
- Send message - allows to send outgoing messages to the external chat channels connected on the account. The method consumes your Chats API message limits. Each account includes a predefined number of outgoing messages. If you need to send more messages, you can purchase additional message limits in your account Billing section.
Please proceed to the article to know more about the add-on sending messages limits and paid packages.
- Get conversation messages - allows to access conversation history from the external chat channels connected on the account. The method doesn't consume your add-on limits.