Konverte Digital icon

Konverte Digital

Interact with Konverte Digital API

Actions115

Overview

This node operation retrieves metadata about conversations from the Konverte Digital API, specifically listing conversation metadata based on various filters. It is useful for scenarios where users want to fetch summarized information about conversations in an account, such as filtering by status, searching by message content, or filtering by inbox, team, or labels. For example, a user can list all open conversations in a specific inbox or search conversations containing a particular keyword.

Use Case Examples

  1. List all open conversations for account ID 12345.
  2. Retrieve conversations filtered by status 'resolved' and team ID 678.
  3. Search conversations containing the term 'urgent' in messages.

Properties

Name Meaning
Account Id The numeric ID of the account to retrieve conversations from.
Status Filter conversations by their status (open, resolved, pending, snoozed).
Q Search term to filter conversations containing messages with this text.
Inbox Id Filter conversations by a specific inbox ID.
Team Id Filter conversations by a specific team ID.
Labels Filter conversations by labels provided as a JSON array.
Request Options Additional request options such as batching, SSL certificate validation, proxy settings, and timeout configuration.

Output

JSON

  • conversations - Array of conversation metadata objects returned from the API.
  • meta - Metadata about the list response, such as pagination details.

Dependencies

  • Requires an API key credential for authentication with the Konverte Digital API.

Troubleshooting

  • Ensure the Account Id is correctly set and corresponds to an existing account; otherwise, the API may return an error or empty results.
  • If filtering by status, ensure the value is one of the supported options (open, resolved, pending, snoozed) to avoid invalid query errors.
  • When using labels as a JSON array, ensure the JSON is correctly formatted to prevent request failures.
  • If SSL certificate validation errors occur, consider enabling the 'Ignore SSL Issues' option, but be aware of security implications.
  • Timeout errors may occur if the server is slow to respond; increase the timeout setting if needed.

Discussion