OrbitX icon

OrbitX

Consume OrbitX API
Join our community

Actions17

Overview

The OrbitX custom n8n node allows you to interact with the OrbitX API for various messaging and contact management operations.
For the resource Mensagem Privado and operation Enviar Voz, this node enables sending a voice message (audio) to a specific WhatsApp number in E.164 format.

Common scenarios:

  • Automating customer support by sending pre-recorded audio responses.
  • Broadcasting voice notifications or alerts to individual users.
  • Integrating voice-based communication into workflows, such as appointment reminders or personalized messages.

Practical example:
You can use this node in an n8n workflow to send a voice message to a user when a new ticket is created in your system, or to deliver automated voice instructions after a form submission.

Properties

Name Type Meaning
Número (E.164) String The recipient's phone number in E.164 international format (e.g., +5511999998888).
URL do Áudio String The direct URL to the audio file that will be sent as a voice message via WhatsApp.

Output

The node returns the JSON response from the OrbitX API after attempting to send the voice message.
The structure of the output typically includes information about the message status, IDs, and any error messages if applicable.

Example output:

{
  "status": "success",
  "messageId": "abc123",
  "to": "+5511999998888",
  "type": "voice",
  "details": { /* ...additional info... */ }
}

Note: The exact fields depend on the OrbitX API response.

Dependencies

  • OrbitX API credentials are required:
    • endpointUrl: Base URL for the OrbitX API.
    • bearerToken: Bearer token for authentication.
    • secretKey: Used internally for requests.
  • The node requires the orbitxApi credential to be configured in n8n.
  • The provided audio file must be accessible via a public URL.

Troubleshooting

Common issues:

  • Invalid phone number format: Ensure the number is in E.164 format (e.g., +5511999998888).
  • Audio URL not reachable: The URL provided in "URL do Áudio" must be publicly accessible and point directly to an audio file.
  • Authentication errors: If the bearer token is missing or expired, the API will reject the request.
  • API endpoint misconfiguration: Double-check the endpointUrl in your credentials.

Typical error messages:

  • "EndpointURL inválida para extrair subdomínio": The endpoint URL in credentials is malformed. Check your configuration.
  • HTTP 401/403 errors: Authentication failed. Verify your bearer token.
  • HTTP 400 errors: Likely due to invalid input data (e.g., wrong number format or missing audio URL).

Links and References

Discussion