PortaOneCallControl icon

PortaOneCallControl

Consume PortaOneCallControl API (v.0.1.0)

Overview

The PortaOne Call Control node's "Convert To On Spot Conference" operation allows you to convert an ongoing call into a real-time conference using the PortaOneCallControl API. This is particularly useful in scenarios where two or more participants on a call need to be joined into a conference dynamically, such as escalating a support call to include a supervisor or adding additional parties for collaborative discussions.

Practical examples:

  • A customer service agent escalates a call to a group conference with a technical expert.
  • An automated workflow detects a specific keyword and instantly converts a two-party call into a conference with relevant stakeholders.

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-specific details:
- I Customer
- Name
- Owner Id
AdditionalFields Optional advanced settings for the conference, including:
Callee (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
Caller (collection):
- Same options as Callee

Output

The node outputs a json object containing the result of the "Convert To On Spot Conference" operation. The exact structure depends on the API response from PortaOneCallControl, but typically includes information about the created conference, participants, and status.

  • If binary data is returned by the API, it will be included as a binary property in the output; however, this operation is expected to return structured JSON data.

Dependencies

  • External Service: Requires access to the PortaOneCallControl API.
  • API Credentials:
    • For Token Authentication: portaOneCallControlTokenApi
    • For Basic Authentication: portaOneCallControlBasicApi
  • 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: If required fields in "Call Info" or "Conference Info" are missing, the API may reject the request.
  • API Connectivity: Network issues or incorrect API endpoint configuration can cause failures.

Common Error Messages:

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

Links and References

Discussion