PortaOne icon

PortaOne

Consume PortaOne API (v.1.0.24)

Overview

The PortaOne node for n8n allows you to interact with the PortaOne API. Specifically, when using the Account resource and the Get Sip Status operation, this node retrieves the SIP (Session Initiation Protocol) status of a specified account. This is useful in scenarios where you need to monitor or automate actions based on the real-time registration or connectivity status of VoIP accounts within your PortaOne system.

Practical examples:

  • Automatically check if a user's SIP device is registered before sending calls.
  • Monitor account statuses and trigger alerts if an account goes offline.
  • Integrate with support workflows to provide up-to-date SIP status information.

Properties

Name Meaning
Authentication The authentication method to use. Options: Token Authentication, Basic Authentication.
Account ID The unique ID of the account record whose SIP status you want to retrieve.

Output

The output will contain the SIP status details of the specified account. While the exact structure depends on the PortaOne API response, typical fields may include:

{
  "i_account": 12345,
  "sip_status": "Registered",
  "last_seen": "2024-06-01T12:34:56Z",
  "ip_address": "203.0.113.42"
}
  • i_account: The account ID queried.
  • sip_status: The current SIP registration status (e.g., Registered, Unregistered).
  • last_seen: Timestamp of the last successful registration.
  • ip_address: IP address from which the account was last registered.

Note: Actual output fields may vary depending on the PortaOne API version and configuration.

Dependencies

  • External Services: Requires access to a PortaOne instance with API enabled.
  • API Credentials: You must configure either:
    • PortaOne Token API credentials (for Token Authentication), or
    • PortaOne Basic API credentials (for Basic Authentication).
  • 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 Account ID: The Account ID is required; omitting it will result in an error.
  • Network/Connection Errors: If the node cannot reach the PortaOne API endpoint, check network connectivity and firewall settings.

Common Error Messages:

  • "Authentication failed": Check your credentials and authentication method.
  • "Account not found": Verify that the provided Account ID exists in your PortaOne system.
  • "Unable to connect to PortaOne API": Ensure the API URL is correct and accessible from your n8n instance.

Links and References

Discussion