WhatsApp API icon

WhatsApp API

Integração com WhatsApp API para envio de mensagens e gerenciamento
Join our community

Actions20

Overview

This node integrates with a WhatsApp API to manage tickets and their messages, among other WhatsApp-related resources. Specifically, the "Show All Messages" operation under the "Ticket" resource retrieves all messages associated with a given ticket ID. This is useful for scenarios where you want to fetch the entire conversation history or message log of a support or service ticket managed via WhatsApp.

Practical examples include:

  • Customer support teams retrieving all messages exchanged in a ticket to review conversation context.
  • Automated workflows that analyze or archive all messages related to a specific ticket.
  • Reporting tools that gather message histories for tickets to generate summaries or insights.

Properties

Name Meaning
Ticket ID The unique numeric identifier of the ticket whose messages you want to retrieve.

Output

The output is a JSON object containing the response from the WhatsApp API endpoint that lists all messages for the specified ticket. The structure depends on the external API's response but generally includes an array or collection of message objects related to the ticket.

No binary data output is produced by this operation.

Example output snippet (conceptual):

{
  "messages": [
    {
      "id": "msg1",
      "from": "5511999999999",
      "body": "Hello, how can I help?",
      "timestamp": "2024-01-01T12:00:00Z"
    },
    {
      "id": "msg2",
      "from": "support_agent",
      "body": "Please provide your order number.",
      "timestamp": "2024-01-01T12:05:00Z"
    }
  ],
  "ticketId": "12345"
}

Dependencies

  • Requires configuration of an API key credential for the WhatsApp API integration.
  • The node uses the base URL and instance ID from the configured credentials to build API requests.
  • The external WhatsApp API must support the /showAllMessages endpoint for tickets.

Troubleshooting

  • Common issues:

    • Invalid or missing Ticket ID: Ensure the Ticket ID is provided and valid.
    • Authentication errors: Verify that the API key credential is correctly set up and has necessary permissions.
    • Network or API endpoint errors: Check connectivity and that the WhatsApp API instance is active.

  • Error messages:

    • "Unknown error occurred": Generic catch-all; check logs and API status.
    • Authentication failures typically indicate invalid or expired credentials.
    • If the API returns an error about the ticket not found, verify the Ticket ID exists in the system.

Links and References

Discussion