The Messages API is part of Voiso's Conversations APIs. Use it to retrieve the message content of specific conversations from digital channels such as WhatsApp, Viber, WebChat, Telegram, and so on.
Please refer to the detailed API endpoint specification here.
The Messages API requires the base URL and the user API key.
The Messages API uses the following parameters.
The Authorization: Bearer token parameter is the user API key. It is used in the request header.
The uuid parameter is the UUID of the conversation from the CDR.
The offset parameter is the number of items to skip before starting to collect the result set.
The limit parameter is the number of items in the result set.
With these parameters, you can make a simple request:
GET https://cluster1.voiso.com/api/conversation/v1/conversations/45afb076-ae74-4fbf-baa7-2d81bef2d969/messages
The following tables list the possible content type and status values for each digital channel.
| Channel | content_type |
|---|---|
| text, image, document | |
| text, image | |
| Telegram | text, image, document, audio, video |
| Viber | text, image, document |
| WebChat | text, document, notification |
| text, image, document, audio, video, template |
| Channel | status |
|---|---|
| initial, accepted, waiting, ready, sent, delivered, seen, failed | |
| initial, accepted, waiting, ready, sent, delivered, seen, failed | |
| Telegram | initial, accepted, waiting, ready, sent, failed |
| Viber | initial, accepted, waiting, ready, sent, delivered, seen, failed |
| WebChat | initial, accepted, waiting, ready, sent, delivered, seen, failed |
| initial, accepted, waiting, ready, sent, delivered, seen, deleted, failed |
The following issues are sometimes encountered:
If you see this error, "error": "Conversation not found", a conversation with the specified UUID could not be found. Use the CDR API to verify that the UUID is correct.
The Messages API uses the contact center API key to validate the request. If you see this error, "error": "Invalid API key", check that you use the correct contact center API key. For more information about API keys, refer to Authentication.
If you see this error, "error": "Specified parameters are not valid", check syntax of the parameters in the request.
If you see this error, "error": "No access to API", the user does not have the correct permissions set in their access group.