OrbitX icon

OrbitX

Consume OrbitX API
Join our community

Actions17

Overview

The OrbitX node for n8n allows you to interact with the OrbitX API, specifically to send various types of messages and perform actions related to WhatsApp messaging, contacts, tickets, and templates.
For the selected Resource: Mensagem Grupo and Operation: Enviar Voz (Grupo), this node enables you to send a voice message (audio) to a WhatsApp group by providing the group ID and a URL pointing to the audio file.

Common scenarios:

  • Automating the sending of pre-recorded voice announcements to WhatsApp groups.
  • Integrating customer support workflows where updates or alerts are sent as voice messages to teams or communities.
  • Broadcasting reminders or notifications in audio format to group members.

Example use case:
A company wants to automatically send a daily motivational audio message to its employee WhatsApp group at 9 AM every morning.

Properties

Name Type Meaning
Group ID String The unique identifier of the WhatsApp group to which the voice message will be sent.
URL do Áudio String The direct URL to the audio file that will be sent as a voice message to the group.

Output

The node returns the JSON response from the OrbitX API after attempting to send the voice message. The structure of the output depends on the API's response, but typically includes information such as:

{
  "success": true,
  "messageId": "abc123",
  "status": "sent",
  // ...other fields as provided by the API
}
  • If the operation is successful, expect fields indicating success, message ID, and status.
  • If there is an error, the output may contain error details.

Dependencies

  • OrbitX API credentials: You must configure the orbitxApi credential in n8n, which requires:
    • endpointUrl: Base URL for the OrbitX API.
    • bearerToken: Authentication token.
    • secretKey: Used internally for requests.
  • External service: The node communicates with the OrbitX API endpoint.
  • Environment: Ensure your n8n instance can reach the OrbitX API and the provided audio URL is accessible from the API server.

Troubleshooting

Common issues:

  • Invalid Group ID: If the group ID is incorrect or does not exist, the API may return an error indicating the group was not found.
  • Audio URL inaccessible: If the provided audio URL is invalid or unreachable by the OrbitX API, the message will not be sent.
  • Authentication errors: Missing or incorrect API credentials will result in authorization failures.
  • API errors: Any issues on the OrbitX side (e.g., rate limits, downtime) will be reflected in the output.

Error messages and resolutions:

  • "EndpointURL inválida para extrair subdomínio": Check that your endpointUrl in credentials starts with https:// and is correctly formatted.
  • "401 Unauthorized" or similar: Verify your bearer token and secret key.
  • "Group not found" or similar: Double-check the Group ID.
  • "Invalid audio URL": Ensure the URL is correct and publicly accessible.

Links and References

Discussion