Asterisk icon

Asterisk

Interact with Asterisk PBX via ARI (Asterisk REST Interface)

Channels → Create

AI-generated

Overview

This node interacts with the Asterisk PBX system via the Asterisk REST Interface (ARI) to create a new channel (call) to a specified endpoint. It is useful for automating call initiation in telephony workflows, such as dialing a SIP or PJSIP endpoint, setting caller ID, or passing variables to the call context. For example, it can be used to programmatically start calls to users or devices within a telephony system and control call parameters like timeout, context, and dialplan execution.

Use Case Examples

  1. Initiate a call to a SIP user with a custom caller ID and timeout.
  2. Create a channel to a PJSIP endpoint and pass variables for call routing.
  3. Dial an extension with specific dialplan context and priority settings.

Properties

Name Meaning
Endpoint The endpoint to call, such as PJSIP/1000 or SIP/user. This is the target of the call and is required.
Additional Fields Optional parameters to customize the call, including application to send the channel to, application arguments, caller ID, custom channel ID, dialplan context, extension, other channel ID, priority, timeout, and channel variables.

Output

JSON

  • id - The unique identifier of the created channel.
  • name - The name of the created channel.
  • state - The current state of the channel.
  • caller
    • number - Caller number information if available.
  • connected
    • number - Connected party number information if available.
  • dialplan
    • context - Dialplan context used for the channel.
    • extension - Dialplan extension used for the channel.
    • priority - Dialplan priority used for the channel.

Dependencies

  • Requires an API key credential for authenticating with the Asterisk REST Interface (ARI).

Troubleshooting

  • Ensure the endpoint string is correctly formatted (e.g., PJSIP/1000 or SIP/user) to avoid call initiation failures.
  • Verify that the API credentials are valid and have sufficient permissions to create channels.
  • Check that the timeout value is reasonable to prevent premature call termination.
  • If the call does not connect, verify the dialplan context, extension, and priority settings are correct and exist in the Asterisk configuration.
  • Errors related to channel ID conflicts may occur if a custom channel ID is reused; ensure uniqueness.

Links

Discussion