3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node interacts with the 3CX telephony system to retrieve reports on outbound calls. Specifically, the "Get Outbound Calls" operation under the "Report Outbound Calls" resource allows users to fetch detailed call data within a specified time period for a particular trunk DNS and call type. This is useful for monitoring call activity, analyzing call patterns, or generating usage reports.

Practical examples include:

  • Generating daily or weekly summaries of outbound calls for billing or auditing.
  • Filtering calls by type (e.g., answered, missed) to assess call quality or agent performance.
  • Paginating large datasets using options like top and skip to manage API response sizes.

Properties

Name Meaning
Period From Start date/time for the report period. Usage: periodFrom={periodFrom}
Period To End date/time for the report period. Usage: periodTo={periodTo}
Trunk Dns The DNS name of the trunk to filter outbound calls. Usage: trunkDns={trunkDns}
Calls Type Numeric code representing the type of calls to retrieve. Usage: callsType={callsType}
Options Additional query options to refine the request:
- Top Show only the first n items (pagination)
- Skip Skip the first n items (pagination offset)
- Search Search items by phrases; supports quoted search
- Filter Filter items by property values, e.g., State eq 'Connected'
- Count Include count of items in the response (boolean)
- Select Select specific properties to be returned, e.g., Id,Name
- Orderby Order items by property values, e.g., Name desc, CreatedAt asc
- Expand Expand related entities, e.g., RelatedEntity1,RelatedEntity2

Output

The node outputs JSON data containing the requested outbound call records matching the input criteria. The structure typically includes details such as call identifiers, timestamps, call states, durations, and other relevant metadata depending on the selected fields.

If binary data were involved (e.g., call recordings), it would be included separately, but this node focuses on JSON call report data.

Dependencies

  • Requires an API key credential for authenticating with the 3CX telephony system.
  • Needs the base URL of the 3CX server configured in credentials.
  • The node sends HTTP requests to the 3CX API endpoint /xapi/v1.
  • No additional external dependencies beyond the 3CX API and its authentication.

Troubleshooting

  • Common issues:

    • Invalid or missing API credentials will cause authentication failures.
    • Incorrect date formats for Period From or Period To may result in errors or empty responses.
    • Using unsupported or incorrect Calls Type numeric codes can lead to no data being returned.
    • Overly broad queries without filters or pagination might cause timeouts or large payloads.

  • Error messages:

    • Authentication errors: Verify that the API key and server URL are correctly set.
    • Validation errors on parameters: Check date formats and required fields.
    • API rate limits: If too many requests are made, wait or reduce frequency.

Links and References

Discussion