Actions3
- Provisioning Actions
Overview
This node interacts with the Ribbon API to manage fraud group blocking and unblocking within a telephony provisioning context. Specifically, the "Unblock Fraud Groups" operation allows users to unblock certain categories of calls that were previously blocked due to fraud prevention policies.
Common scenarios include:
- Re-enabling call types for specific fraud groups after investigation or resolution of fraud issues.
- Dynamically adjusting call permissions based on changing security or business requirements.
- Managing call restrictions in bulk for different fraud group categories.
Practical example:
- A telecom operator uses this node to unblock international and premium calls for fraud groups 2-5 after confirming no fraudulent activity is present, restoring normal call flow for affected customers.
Properties
| Name | Meaning |
|---|---|
| Service Type | The Ribbon service type to connect to. Options: "OPI (Provisioning Manager)" |
| Fraud Group Type | Choose the fraud group category to unblock. Options: - Group 1 - All Outgoing Calls (uses a different endpoint) - Groups 2-5 - Premium & International (multiple selections allowed) |
| International | (Only for Groups 2-5) Whether international calls are enabled/unblocked (boolean). Can use expressions from previous nodes. |
| International Excluding HC | (Only for Groups 2-5) Whether international excluding HC calls are enabled/unblocked (boolean). Can use expressions from previous nodes. |
| Local | (Only for Groups 2-5) Whether local calls are enabled/unblocked (boolean). Can use expressions from previous nodes. |
| Long Distance | (Only for Groups 2-5) Whether long distance calls are enabled/unblocked (boolean). Can use expressions from previous nodes. |
| Long Distance Inter Rate Area | (Only for Groups 2-5) Whether long distance inter rate area calls are enabled/unblocked (boolean). Can use expressions from previous nodes. |
| Long Distance Intra Rate Area | (Only for Groups 2-5) Whether long distance intra rate area calls are enabled/unblocked (boolean). Can use expressions from previous nodes. |
| Premium | (Only for Groups 2-5) Whether premium calls are enabled/unblocked (boolean). Can use expressions from previous nodes. |
| Domain Name | (Only for Group 1) The domain name related to fraud group 1 operations. Required string input; can use expressions. Example format: xxxxx.xxxxx.xxxx.xx |
| SIP PBX Name | (Only for Groups 2-5) The SIP PBX identifier used for fraud groups 2-5 operations. Required string input; can use expressions. Example format: 50500_50000_x |
Output
The node outputs JSON data representing the result of the unblock operation. This typically includes status information about the success or failure of the request to the Ribbon API, such as confirmation messages or error details.
If the node supports binary data output (not indicated here), it would represent any returned files or media related to the operation, but this is not applicable for this operation.
Dependencies
- Requires an API key credential for authenticating with the Ribbon API.
- Needs the Ribbon API host URL configured in credentials.
- The node sends XML-formatted requests with SOAPAction headers to the Ribbon service endpoints.
- SSL certificate validation can be optionally skipped based on credential settings.
Troubleshooting
Common Issues:
- Incorrect or missing domain name or SIP PBX identifier will cause the API request to fail.
- Misconfiguration of boolean flags for call types may lead to unintended blocking/unblocking behavior.
- Network connectivity or authentication failures with the Ribbon API will prevent successful execution.
Error Messages:
- Authentication errors indicate invalid or missing API credentials; verify and update credentials.
- Validation errors for required fields (e.g., domain name or SIP PBX name) require ensuring these inputs are provided and correctly formatted.
- SOAP or XML parsing errors suggest malformed requests; check property values and ensure they conform to expected formats.
Links and References
- Ribbon Communications official API documentation (consult your organization's internal resources or Ribbon's developer portal).
- n8n documentation on creating and using custom nodes with SOAP APIs.
- General best practices for managing fraud groups in telephony provisioning systems.