Overview

This node interacts with the Asterisk PBX system via the Asterisk REST Interface (ARI). Specifically, the 'Playbacks - Get' operation retrieves information about a specific media playback instance within Asterisk using its unique Playback ID. This is useful for monitoring or managing ongoing or past media playbacks in telephony applications.

Use Case Examples

1. Retrieve details of a specific playback to check its status or properties.
2. Use the playback information to debug or log media playback events in a call flow.

Properties

Output

JSON

• id - The unique identifier of the playback.
• name - The name of the playback.
• state - The current state of the playback (e.g., playing, paused).
• mediaUri - The URI of the media being played back.
• targetUri - The URI of the target where the playback is directed.
• creationTime - Timestamp when the playback was created.

Dependencies

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

Troubleshooting

• Ensure the Playback ID provided is correct and exists in the Asterisk system; otherwise, the node will return an error indicating the playback was not found.
• Verify that the API credentials are valid and have sufficient permissions to access playback information.
• Check network connectivity to the Asterisk server to avoid connection timeouts or failures.

Links

• Asterisk ARI Playbacks Documentation - Official documentation for managing playbacks via Asterisk REST Interface.