Maytapi icon

Maytapi

Integrate with Maytapi WhatsApp Unofficial API

Queue → List All Queues

AI-generated

Overview

This node integrates with the Maytapi WhatsApp Unofficial API, enabling automation and management of WhatsApp messaging and related features. Specifically, for the Queue resource with the List All Queues operation, it retrieves a list of all phone queues associated with the user's Maytapi product.

This functionality is useful in scenarios where you want to monitor or manage message queues for multiple WhatsApp instances or phones linked to your Maytapi account. For example, a customer support system might use this to check which queues are active and their statuses before distributing incoming messages to agents.

Properties

Name Meaning
Phone ID Source Select how to provide the Phone ID: either "From Credentials" (uses Phone ID from credentials) or "Custom" (enter a custom Phone ID). This is required except when the resource is "account".
Phone ID When "Phone ID Source" is set to "Custom", enter the WhatsApp instance Phone ID here. This identifies the specific WhatsApp phone instance to operate on. Required if using custom source.

Output

The output is a JSON object representing the response from the Maytapi API endpoint /queues. It contains the list of all phone queues for the product associated with the provided Phone ID.

The exact structure depends on the Maytapi API but typically includes details about each queue such as queue identifiers, statuses, and possibly metadata about queued messages.

No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential for Maytapi WhatsApp API authentication.
  • The node expects the base URL https://api.maytapi.com/api.
  • The Phone ID must be provided either via credentials or as a custom input property.
  • No additional environment variables are needed beyond the API key credential.

Troubleshooting

  • Missing Phone ID Error: If neither credentials nor custom Phone ID is provided, the node throws an error: "Phone ID is required. Please provide it in credentials or select custom Phone ID." Ensure that the Phone ID is correctly configured.
  • API Request Failures: Network issues or invalid API keys can cause request failures. Verify your API key credential and network connectivity.
  • Unsupported Operation: Using an operation not supported for the Queue resource will throw an error. Confirm that "List All Queues" is selected.
  • Empty Response: If no queues exist, the returned JSON may be empty or contain an empty list. This indicates no active queues for the product.

Links and References

Discussion