Talknbox VE

Integracja z Talknbox VE API
Join our community

Actions20

Overview

This node integrates with the Talknbox VE API to manage campaigns programmatically. Specifically, the Update Campaign operation allows users to modify existing campaign settings such as pacing (calls per minute) and status (active, paused, or stopped). This is useful in scenarios where you want to dynamically control call campaign behavior based on external triggers or workflow logic.

Practical examples include:

  • Automatically pausing a campaign during off-hours.
  • Adjusting the call pacing rate based on call center load.
  • Stopping a campaign after reaching a certain threshold or event.

Properties

Name Meaning
Campaign ID The unique identifier of the campaign to update.
Pacing Number representing the campaign's call pacing in calls per minute.
Status The current state of the campaign. Options: Active, Paused, Stopped.

Output

The node outputs an array of JSON objects corresponding to each input item processed. For the Update Campaign operation, the output JSON contains the response from the Talknbox VE API reflecting the updated campaign details or status confirmation.

Example output structure (simplified):

{
  "id": "string",
  "name": "string",
  "pacing": 1,
  "status": "active"
}

If an error occurs and "Continue On Fail" is enabled, the output will contain an error message for the failed item.

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 is configurable via credentials.
  • The node uses HTTP requests with automatic retry handling for rate limiting (HTTP 429).

Troubleshooting

  • Rate Limiting Errors (HTTP 429): The node automatically retries up to 3 times with delay based on the x-ratelimit-reset header. If errors persist, consider reducing request frequency.
  • Invalid Campaign ID: Ensure the Campaign ID provided exists and is correctly formatted; otherwise, the API will return an error.
  • Missing Required Parameters: The Campaign ID is mandatory. Omitting it will cause the node to fail.
  • API Authentication Errors: Verify that the API key credential is valid and has sufficient permissions.
  • Partial Updates: When updating, if some fields are omitted (e.g., name), they may be left unchanged. To clear a field, explicitly provide an empty value if supported.

Links and References

Discussion