Kakiyo

Interact with the Kakiyo API

Actions19

Overview

The node interacts with the Kakiyo API to manage prospects within campaigns. Specifically, the "Get Details" operation for the "Prospect" resource retrieves detailed information about a single prospect based on their chat/conversation ID. This is useful in scenarios where you want to fetch up-to-date data about a specific prospect's status or details during or after a campaign.

Practical examples include:

  • Fetching the current state of a conversation with a prospect.
  • Retrieving detailed profile or interaction data for a prospect to inform follow-up actions.
  • Integrating prospect details into workflows for reporting or decision-making.

Properties

Name Meaning
Chat ID ID of the chat/conversation to retrieve details for

Output

The output is a JSON object containing the detailed information of the specified prospect as returned by the Kakiyo API. The exact structure depends on the API response but typically includes fields related to the prospect’s profile, conversation status, and any associated metadata.

No binary data output is indicated for this operation.

Dependencies

  • Requires an API key credential for authenticating requests to the Kakiyo API.
  • The node expects the base URL of the Kakiyo API to be configured in the credentials.
  • Network access to the Kakiyo API endpoint is necessary.

Troubleshooting

  • Common issues:

    • Invalid or missing Chat ID: The operation requires a valid chat/conversation ID; providing an incorrect or empty value will cause errors.
    • Authentication failures: Ensure the API key credential is correctly set up and has sufficient permissions.
    • Network or API downtime: Connectivity issues or Kakiyo API outages can cause request failures.

  • Error messages:

    • Errors returned from the API (e.g., 404 Not Found) likely indicate that the provided Chat ID does not exist.
    • Authentication errors suggest invalid or expired credentials.

  • Resolutions:

    • Verify the Chat ID is correct and corresponds to an existing prospect.
    • Check and update the API key credential if needed.
    • Confirm network connectivity and Kakiyo service status.

Links and References

Discussion