Asterisk icon

Asterisk

Interact with Asterisk PBX via ARI (Asterisk REST Interface)

Channels → Record

AI-generated

Overview

This node interacts with the Asterisk PBX system via the Asterisk REST Interface (ARI) to manage telephony channels. Specifically, the 'Record' operation allows users to start recording a call on a specified channel. This is useful in scenarios such as call monitoring, quality assurance, or compliance recording. For example, a user can record a customer support call by specifying the channel ID and recording name, choosing the audio format, and setting optional parameters like maximum duration or silence detection.

Use Case Examples

  1. Recording a customer support call for quality assurance by specifying the channel ID and recording name.
  2. Automatically stopping a recording after a set period or when silence is detected to save storage.
  3. Appending to an existing recording instead of overwriting it to maintain continuous call logs.

Properties

Name Meaning
Channel ID The unique identifier of the channel to record.
Recording Name The name assigned to the recording file.
Format The audio format for the recording, such as wav, gsm, or mp3.
Max Duration Seconds Maximum length of the recording in seconds; 0 means unlimited.
Max Silent Seconds Maximum allowed silence duration before stopping the recording.
If Exists Action to take if a recording with the same name already exists.
Beep Whether to play a beep sound before starting the recording.
Terminate On DTMF digit that, when pressed, will terminate the recording.

Output

JSON

  • recordingName - The name of the recording created.
  • channelId - The ID of the channel being recorded.
  • format - The audio format of the recording.
  • duration - Duration of the recording in seconds.
  • status - Status of the recording operation (e.g., started, stopped).

Dependencies

  • Asterisk REST Interface (ARI)

Troubleshooting

  • Ensure the channel ID is correct and the channel is active before starting a recording.
  • If the recording fails due to an existing file, check the 'If Exists' property to decide whether to fail, overwrite, or append.
  • Verify that the Asterisk API credentials and base URL are correctly configured to avoid authentication or connection errors.
  • If the recording does not stop as expected, check the 'Max Duration Seconds' and 'Max Silent Seconds' settings and the 'Terminate On' DTMF digit configuration.

Links

Discussion