Talknbox VE

Integracja z Talknbox VE API
Join our community

Actions20

Overview

This node integrates with the Talknbox VE API to manage campaigns and other related resources such as calls, contacts, agents, queues, reports, webhooks, and system information. Specifically, for the Campaigns - Stop operation, it sends a request to stop an active campaign identified by its Campaign ID. This is useful in scenarios where you want to programmatically halt ongoing marketing or outreach campaigns managed through Talknbox VE.

Practical examples include:

  • Automatically stopping a campaign after certain conditions are met (e.g., budget limits reached).
  • Pausing campaigns during off-hours or maintenance windows.
  • Integrating with other workflows that require dynamic control over campaign status.

Properties

Name Meaning
Campaign ID The unique identifier of the campaign to stop. This is required to specify which campaign should be halted.

Output

The node outputs JSON data representing the response from the Talknbox VE API after attempting to stop the campaign. The structure typically includes confirmation of the action or details about the stopped campaign. If the API call fails, the output may contain an error message describing the issue.

No binary data output is involved in this operation.

Example output JSON might look like:

{
  "ok": true
}

or in case of error:

{
  "error": "Error message describing what went wrong"
}

Dependencies

  • Requires an API key credential for authenticating with the Talknbox VE API.
  • The base URL of the Talknbox VE API must be configured in the credential settings.
  • The node uses HTTP requests with authentication to communicate with the Talknbox VE service.

Troubleshooting

  • Common issues:

    • Invalid or missing Campaign ID: Ensure the Campaign ID provided exists and is correct.
    • Authentication errors: Verify that the API key credential is valid and has necessary permissions.
    • Rate limiting: The node retries up to 3 times if the API returns a 429 status code (too many requests), waiting for the specified reset time before retrying.
    • Network or connectivity issues: Check network access to the Talknbox VE API endpoint.

  • Common error messages:

    • "error": "Unauthorized": Indicates invalid API credentials; recheck the API key.
    • "error": "Not Found": The specified Campaign ID does not exist; verify the ID.
    • "error": "Too Many Requests": The node handles this by retrying, but persistent rate limiting may require adjusting usage patterns.

Links and References

Discussion