PortaOneCallControl icon

PortaOneCallControl

Consume PortaOneCallControl API (v.0.1.0)

Overview

The PortaOneCallControl node for n8n enables users to interact with the PortaOne Call Control API, specifically to perform the "Join On Spot Conference" operation. This operation allows a call (or participant) to be joined into an ongoing conference call on demand. Common scenarios include automating telephony workflows such as adding callers to ad-hoc conferences, managing virtual meeting rooms, or integrating real-time communication features into business processes.

Practical examples:

  • Automatically joining a support agent and a customer into a conference when a ticket is escalated.
  • Adding a supervisor to a live call for quality assurance.
  • Creating instant conference bridges for team collaboration triggered by workflow events.

Properties

Name Meaning
Authentication The authentication method to use. Options: Token Authentication, Basic Authentication.
Call Info Collection of call-related details:
- Callee Id
- Caller Id
- Id
- Sip Auth Username
- Tag
Conference Info Collection of conference-related details:
- I Customer
- Name
- Owner Id
AdditionalFields Optional additional settings:
Participant Info (collection):
- Announced Conference Name Url
- Caller Id
- Coach
- Hold
- Join Time
- Lang
- Leave Time
- Max Participants
- Moderator
- Music On Hold Url
- Mute
- Participant Id
- Play Announce
- Quiet Mode
- Wait For Moderator

Output

The node outputs a json object containing the result of the "Join On Spot Conference" operation. The exact structure depends on the response from the PortaOne Call Control API, but typically includes information about the conference join status, participant details, and any relevant identifiers or metadata returned by the API.

Note: If the API returns binary data (unlikely for this operation), it will be included in the output as a binary field.

Dependencies

  • External Services: Requires access to the PortaOne Call Control API.
  • API Credentials:
    • For Token Authentication: portaOneCallControlTokenApi credentials.
    • For Basic Authentication: portaOneCallControlBasicApi credentials.
  • n8n Configuration: Ensure the appropriate credentials are set up in n8n under the node's credential options.

Troubleshooting

Common Issues:

  • Invalid Credentials: If authentication fails, ensure that the correct credentials are selected and valid for the chosen authentication method.
  • Missing Required Fields: Omitting required fields in Call Info or Conference Info may result in errors from the API.
  • API Connectivity: Network issues or incorrect API endpoint configuration can cause connection failures.

Common Error Messages:

  • "Authentication failed" – Check your credentials and authentication method.
  • "Required parameter missing" – Ensure all necessary fields are filled out, especially within Call Info and Conference Info.
  • "API request failed" – Verify network connectivity and API availability.

Links and References

Discussion