PortaOneCallControl icon

PortaOneCallControl

Consume PortaOneCallControl API (v.0.1.0)

Overview

The PortaOneCallControl node for n8n allows you to interact with the PortaOne Call Control API, specifically enabling the "Join To Active Call" operation. This operation is useful in scenarios where you need to programmatically join a participant (callee) to an ongoing call, such as in automated call center workflows, conferencing solutions, or telephony integrations.

Practical examples:

  • Automatically joining a support agent to a customer call when certain conditions are met.
  • Adding a supervisor to an active conference for monitoring or coaching purposes.
  • Integrating with CRM systems to trigger call joins based on business logic.

Properties

Name Meaning
Authentication The authentication method to use. Options: Token Authentication, Basic Authentication.
Call Info A collection of call-related details:
- Callee Id
- Caller Id
- Id
- Sip Auth Username
- Tag
Callee Id The unique identifier of the callee to be joined to the active call. Required.
AdditionalFields Optional additional parameters:
- Callee Auto Pickup
- Caller Id
- Participant Info (see below)
Participant Info (Within AdditionalFields) A collection of participant-specific options:
- Announced Conference Name Url
- Coach
- Moderator
- Music On Hold Url
- Mute
- Quiet Mode
- Wait For Moderator

Output

  • The output will be a JSON object containing the result of the "Join To Active Call" operation from the PortaOne Call Control API.
  • The structure of the output JSON depends on the API response and may include information about the call status, participant details, and any relevant identifiers.
  • If the "simplify" option is enabled (internally handled), the output may be a simplified version of the API response.
  • Binary data: This node does not output binary data; all outputs are in JSON format.

Dependencies

  • External Services: Requires access to the PortaOne Call Control API.
  • API Credentials: You must provide either a Token or Basic Authentication credential:
    • portaOneCallControlTokenApi for Token Authentication
    • portaOneCallControlBasicApi for Basic Authentication
  • n8n Configuration: Ensure that the appropriate credentials are set up in n8n under the node's credential options.

Troubleshooting

Common Issues:

  • Authentication Errors: If incorrect credentials are provided, the node will fail to authenticate with the PortaOne API. Double-check your API token or username/password.
  • Missing Required Fields: The "Callee Id" property is required. Omitting it will result in an error.
  • Invalid Parameter Values: Providing invalid values for fields like "Caller Id" or "Tag" may cause the API to reject the request.

Error Messages & Resolutions:

  • "Missing required parameter: Callee Id": Ensure you have filled in the "Callee Id" field.
  • "Authentication failed": Verify your credentials and authentication method.
  • "API request failed": Check network connectivity and ensure the PortaOne API endpoint is reachable.

Links and References

Discussion