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 manage conference calls. The "Delete On Spot Conference Participant" operation enables you to remove a participant from an ongoing conference call in real time. This is useful in scenarios such as moderating live conferences, handling disruptive participants, or automating conference management workflows.

Practical examples:

  • Automatically removing a participant who has exceeded their allowed speaking time.
  • Integrating with support systems to disconnect users after a session ends.
  • Enabling moderators to enforce conference rules programmatically.

Properties

Name Meaning
Authentication The authentication method to use. Options: Token Authentication, Basic Authentication.
Conference Info Collection of conference details:
- I Customer: Numeric identifier for the customer.
- Name: Name of the conference.
- Owner Id: Identifier for the owner of the conference.
Participant Info Collection of participant details:
- 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 number of participants.
- Moderator: Moderator status.
- Music On Hold Url: URL for music on hold.
- Mute: Mute status.
- Participant Id: Numeric identifier for the participant.
- Play Announce: Play announce 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 delete operation. While the exact structure depends on the API response, it typically includes:

  • Status of the deletion (success/failure)
  • Details about the affected participant and conference
  • Any error messages if the operation failed

Example output:

{
  "success": true,
  "message": "Participant removed successfully",
  "conferenceId": 12345,
  "participantId": 67890
}

If binary data is returned (unlikely for this operation), it would represent raw API responses or logs.

Dependencies

  • External Service: Requires access to the PortaOne Call Control API.
  • API Credentials: You must provide either a token or basic authentication credentials, configured in n8n's credentials system.
  • n8n Configuration: Ensure the appropriate credentials are set up under "portaOneCallControlTokenApi" or "portaOneCallControlBasicApi".

Troubleshooting

Common issues:

  • Invalid Credentials: If authentication fails, ensure your API credentials are correct and have sufficient permissions.
  • Missing Required Fields: If required fields in "Conference Info" or "Participant Info" are missing, the API may return errors indicating which parameter is absent.
  • Participant Not Found: Attempting to delete a non-existent participant will likely result in an error message from the API.

Error messages and resolutions:

  • "Authentication failed": Check that the selected authentication method matches the provided credentials.
  • "Conference or participant not found": Verify the IDs and names provided in the input properties.
  • "Insufficient permissions": Ensure the API user has rights to modify conferences and participants.

Links and References

Discussion