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 to update a participant in an on-spot conference. This operation is useful in scenarios where you need to programmatically manage conference calls—such as updating participant details, muting/unmuting, or changing roles—within automated workflows.

Common use cases:

  • Updating participant information (e.g., name, language, join/leave time) during a live conference.
  • Changing participant status (mute, hold, moderator, etc.) based on workflow logic.
  • Integrating call control with CRM or support systems to automate conference management.

Practical example:
Automatically mute all participants except moderators when a certain event occurs in your workflow, or update the "hold" status of a participant if their payment status changes.


Properties

Name Meaning
Authentication The authentication method to use. Options: Token Authentication, Basic Authentication.
Conference Info Collection of conference-level properties:
- I Customer: Numeric customer identifier.
- Name: Name of the conference.
- Owner Id: Identifier for the owner of the conference.
Participant Info Collection of participant-level properties:
- Announced Conference Name Url: URL for the announced conference name.
- Caller Id: Caller identification.
- Coach: Coach status.
- Hold: Hold status.
- Join Time: When the participant joined.
- Lang: Language.
- Leave Time: When the participant left.
- Max Participants: Maximum allowed participants.
- Moderator: Moderator status.
- Music On Hold Url: URL for music played while on hold.
- Mute: Mute status.
- Participant Id: Numeric participant identifier.
- Play Announce: Play announcement setting.
- Quiet Mode: Quiet mode status.
- Wait For Moderator: Wait for moderator setting.

Output

The output will be a json object reflecting the result of the update operation. The structure typically includes:

  • Status of the update (success/failure)
  • Updated participant and/or conference details
  • Any error messages or codes if the operation failed

Note: If the API returns binary data, it would represent media or audio files related to the conference, but this operation is expected to return structured JSON.


Dependencies

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

Troubleshooting

Common issues:

  • Invalid Credentials: If authentication fails, ensure your token or username/password are correct and have sufficient permissions.
  • Missing Required Fields: If required fields in "Conference Info" or "Participant Info" are missing, the API may reject the request.
  • Incorrect Data Types: Supplying strings instead of numbers (or vice versa) for fields like "I Customer" or "Participant Id" can cause errors.

Common error messages:

  • "Authentication failed": Check your credentials and authentication method.
  • "Missing required parameter": Ensure all necessary fields are filled out.
  • "Invalid value for field": Double-check the data types and allowed values for each property.

Links and References

Discussion