Talknbox VE

Integracja z Talknbox VE API
Join our community

Actions20

Overview

This node integrates with the Talknbox VE API to retrieve a summary report of campaigns within a specified date range. It is useful for users who want to analyze campaign performance data over time, such as tracking call outcomes, campaign reach, or engagement metrics.

A practical example use case is generating a summary report of all campaigns run between two dates to evaluate their effectiveness and make data-driven decisions for future campaigns.

Properties

Name Meaning
From Date Start date for the report in YYYY-MM-DD format. Defines the beginning of the date range for the campaign summary.
To Date End date for the report in YYYY-MM-DD format. Defines the end of the date range for the campaign summary.

Output

The output is a JSON object containing the campaign summary data returned by the Talknbox VE API endpoint /v1/reports/campaigns/summary. This typically includes aggregated statistics about campaigns within the specified date range.

The exact structure depends on the API response but generally includes metrics such as total calls, successful calls, failed calls, durations, and other campaign-related statistics.

No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential for authenticating with the Talknbox VE API.
  • The base URL for the API must be configured in the credentials.
  • The node uses HTTP requests with automatic retry logic for rate limiting (HTTP 429) with up to 3 attempts.

Troubleshooting

  • Rate Limiting Errors (HTTP 429): The node automatically retries after waiting for the reset time indicated by the API. If errors persist, check API usage limits or increase the wait time.
  • Invalid Date Format: Ensure that the "From Date" and "To Date" properties are provided in the correct YYYY-MM-DD format to avoid request failures.
  • Authentication Failures: Verify that the API key credential is correctly set up and has sufficient permissions to access reports.
  • Empty or Unexpected Response: Confirm that there are campaigns within the specified date range and that the API endpoint is functioning properly.

Links and References

Discussion