Maytapi icon

Maytapi

Integrate with Maytapi WhatsApp Unofficial API

Actions55

Session Control → Get Config

AI-generated

Overview

This node integrates with the Maytapi WhatsApp Unofficial API, enabling automation and management of WhatsApp messaging and session control. Specifically for the Session Control - Get Config operation, it retrieves the phone-specific configuration related to webhook URLs and acknowledgment delivery settings.

Use cases include:

  • Fetching the current webhook URL configured for a specific WhatsApp phone instance.
  • Checking if acknowledgment delivery (read receipts, delivery reports) is enabled for that phone.
  • Useful in workflows where you need to verify or audit the current session configuration before making changes or troubleshooting.

Example scenario:

  • Before updating webhook URLs or acknowledgment preferences, you can use this operation to get the existing config to decide if an update is necessary.

Properties

Name Meaning
Phone ID Source Select how to provide the Phone ID: either "From Credentials" (default) or "Custom".
Phone ID The custom Phone ID of your WhatsApp instance (required if "Phone ID Source" is Custom).

  • Phone ID Source options:

    • From Credentials: Use the Phone ID stored in the API credentials.
    • Custom: Manually enter a Phone ID string.

  • Phone ID: This identifies the specific WhatsApp phone instance whose session config you want to retrieve.

Output

The output JSON contains the phone-specific configuration data returned by the Maytapi API for the selected phone instance. Typical fields include:

  • webhook: The webhook URL currently set for the phone instance (string).
  • ack_delivery: Boolean indicating whether acknowledgment delivery is enabled for this phone.

The output structure is a JSON object representing these configuration details. No binary data is produced by this operation.

Example output JSON snippet:

{
  "webhook": "https://myserver.com/webhook",
  "ack_delivery": true
}

Dependencies

  • Requires an API key credential for the Maytapi WhatsApp API.
  • The Phone ID must be provided either via credentials or as a custom input.
  • The node makes HTTP GET requests to the Maytapi API endpoint /sessionControl/config for the specified phone.

Troubleshooting

  • Error: "Phone ID is required."
    Occurs if no Phone ID is provided either in credentials or as a custom value. Ensure you supply a valid Phone ID.

  • API request failures
    Could be due to invalid API key, network issues, or incorrect Phone ID. Verify credentials and connectivity.

  • Unsupported operation error
    If the resource or operation parameters are incorrect, the node will throw an unsupported operation error. Confirm you have selected "Session Control" as resource and "Get Config" as operation.

Links and References

Discussion