Asterisk icon

Asterisk

Interact with Asterisk PBX via ARI (Asterisk REST Interface)

Channels → Get

AI-generated

Overview

This node interacts with the Asterisk PBX system via the Asterisk REST Interface (ARI) to manage telephony resources. Specifically, the 'Channels' resource with the 'Get' operation allows users to retrieve detailed information about a specific channel (call) by providing its unique Channel ID. This is useful in scenarios where you need to monitor or manage active calls, fetch call details for logging, or integrate call data into other workflows.

Use Case Examples

  1. Retrieve detailed information about a specific call channel by its ID to monitor call status or attributes.
  2. Use the channel information to trigger further actions in a call center workflow, such as logging call details or updating a CRM system.

Properties

Name Meaning
Channel ID The unique identifier of the channel to retrieve information for. This is a required input when performing the 'Get' operation on the 'Channels' resource.

Output

JSON

  • id - The unique identifier of the channel.
  • name - The name of the channel.
  • state - The current state of the channel (e.g., ringing, up, down).
  • caller
    • number - The caller's phone number.
  • connected
    • number - The connected party's phone number.
  • creationtime - Timestamp when the channel was created.
  • duration - Duration the channel has been active.
  • application - The application associated with the channel.

Dependencies

  • Requires an API key credential for authenticating with the Asterisk REST Interface (ARI).
  • Needs the base URL of the Asterisk ARI endpoint configured in the node credentials.

Troubleshooting

  • Ensure the Channel ID provided is correct and corresponds to an active or existing channel in the Asterisk system.
  • Verify that the API credentials and base URL are correctly configured to avoid authentication or connection errors.
  • Common errors include 'Channel not found' if the Channel ID does not exist, or network errors if the ARI endpoint is unreachable.

Links

Discussion