Asterisk icon

Asterisk

Interact with Asterisk PBX via ARI (Asterisk REST Interface)

Endpoints → Send Message

AI-generated

Overview

This node interacts with the Asterisk PBX system via the Asterisk REST Interface (ARI) to send messages to specified endpoints. It is useful in telephony automation scenarios where you need to programmatically send text messages between endpoints within the Asterisk system. For example, sending a notification message from one SIP endpoint to another.

Use Case Examples

  1. Sending a text message from endpoint PJSIP/2000 to PJSIP/1000 with a custom message body.
  2. Setting variables on the message to pass additional context or metadata.

Properties

Name Meaning
To The endpoint URI or technology URI to send the message to.
From The endpoint URI or technology URI to send the message from.
Body The text content of the message to be sent.
Additional Fields Optional additional fields for the message, including variables to set on the message.

Output

JSON

  • messageId - Identifier of the sent message
  • status - Status of the message sending operation
  • to - The endpoint URI the message was sent to
  • from - The endpoint URI the message was sent from
  • body - The content of the sent message
  • variables - Any variables set on the message

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 credentials.

Troubleshooting

  • Ensure the 'To' and 'From' endpoint URIs are correctly formatted and exist in the Asterisk system.
  • Verify that the API credentials are valid and have sufficient permissions to send messages.
  • Check network connectivity to the Asterisk ARI endpoint URL.
  • If message sending fails, check the error response for details such as invalid endpoint or message body issues.

Links

Discussion