SparkBot icon

SparkBot

Interact with SparkBot WhatsApp API

Actions148

Overview

This node interacts with the SparkBot WhatsApp API to retrieve meeting links associated with a specified WhatsApp number. It allows users to filter and paginate through meeting links, which can be either voice or video types. This is useful in scenarios where you want to programmatically access or manage meeting invitations or calls linked to your WhatsApp business account.

Practical examples include:

  • Fetching all active or expired meeting links for a particular WhatsApp number.
  • Searching meeting links by URL, token, or message content.
  • Filtering meeting links created or expiring within specific date ranges.
  • Paginating results to handle large sets of meeting links efficiently.

Properties

Name Meaning
WhatsApp Number The ID of the WhatsApp number from which to retrieve meeting links.
Filters A collection of optional filters to narrow down the search results:
- Search Search meeting links by URL, token, or message content.
- Created Before Filter meeting links created before a specific date/time.
- Created After Filter meeting links created after a specific date/time.
- Expires Before Filter meeting links that expire before a specific date/time.
- Expires After Filter meeting links that expire after a specific date/time.
- Link Type Filter meeting links by type; options are "Voice" or "Video".
- Results Page Size Number of results to return per page (default is 20).
- Page Number Page number to retrieve, starting from 0 (default is 0).

Output

The node outputs an array of JSON objects representing meeting links matching the specified criteria. Each object typically contains details such as the link URL, token, message, creation and expiration timestamps, and the type of the link (voice or video).

If binary data were involved (e.g., files), it would be summarized here, but this node focuses on JSON data related to meeting links.

Dependencies

  • Requires an API key credential for authenticating with the SparkBot WhatsApp API.
  • The node depends on the SparkBot service being accessible and properly configured.
  • No additional environment variables are explicitly required beyond the API key credential.

Troubleshooting

  • Common Issues:

    • Invalid or missing WhatsApp number ID will result in no data or errors.
    • Incorrect API key or authentication failure will cause authorization errors.
    • Using invalid date formats in filters may lead to request failures.
    • Requesting pages beyond available data may return empty results.
  • Error Messages:

    • Errors related to authentication usually indicate issues with the provided API key; verify and update credentials.
    • Validation errors on filters suggest incorrect input formats; ensure dates and other fields conform to expected types.
    • Network or service unavailability errors require checking connectivity and SparkBot API status.

Links and References

Discussion