Asterisk icon

Asterisk

Interact with Asterisk PBX via ARI (Asterisk REST Interface)

Actions76

Endpoints → Get

AI-generated

Overview

This node interacts with the Asterisk PBX system via the Asterisk REST Interface (ARI) to manage endpoints. Specifically, the 'Get' operation under the 'Endpoints' resource retrieves detailed information about a specific endpoint identified by its resource/ID and technology type. This is useful for telephony administrators who need to query endpoint configurations or statuses within an Asterisk PBX environment.

Use Case Examples

  1. Retrieve details of a PJSIP endpoint by specifying its resource ID to monitor or troubleshoot call routing issues.
  2. Fetch information about a SIP endpoint to verify its configuration or status in the PBX system.

Properties

Name Meaning
Technology Specifies the endpoint technology type, such as PJSIP, SIP, or IAX2, to identify the protocol used by the endpoint.
Resource The unique identifier or resource name of the endpoint to retrieve information about.

Output

JSON

  • id - The unique identifier of the endpoint.
  • technology - The technology type of the endpoint (e.g., PJSIP, SIP, IAX2).
  • state - Current state or status of the endpoint.
  • name - The name assigned to the endpoint.
  • contact - Contact information or address of the endpoint.
  • otherProperties - Additional properties related to the endpoint as returned by the Asterisk ARI.

Dependencies

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

Troubleshooting

  • Ensure the API credentials are correctly configured and have sufficient permissions to access endpoint information.
  • Verify that the specified endpoint resource/ID exists and matches the technology type provided.
  • Common errors include authentication failures, resource not found errors, and network connectivity issues to the ARI server.

Links

Discussion