-
Notifications
You must be signed in to change notification settings - Fork 0
SIP PBX Recording Actions
Andrey Egorov edited this page May 18, 2026
·
2 revisions
The Global recording resource contains all public actions related to daemon-owned global call recording.
| Operation | Purpose | Output branches |
|---|---|---|
Respond to recording |
Complete a trigger-driven recording request. | Result |
Start recording |
Start or restart recording directly by legId. |
Result |
Control recording |
Pause or resume an active recording. | Result |
| Parameter | Required | Description |
|---|---|---|
File Path |
Yes when starting recording | Output file path on the n8n host. |
File Format |
Yes when starting recording |
WAV, MP3, Opus, or OGG. |
Split Channels |
No | When enabled, inbound audio goes to channel 1 and outbound PBX audio goes to channel 2. |
Wait For Recording Completion |
No | If enabled, the action waits for the recording to finish before returning. |
| Format | Option | Description |
|---|---|---|
WAV |
WAV Sample Rate |
WAV output sample rate. |
WAV |
WAV Bit Depth |
WAV output bit depth. |
MP3, Opus, OGG
|
Compressed Sample Rate |
Output sample rate for compressed formats. |
MP3, Opus, OGG
|
Compressed Bitrate |
Output bitrate for compressed formats. |
This action is used after the Recording branch emitted by:
| Parameter | Required | Description |
|---|---|---|
Record the call |
No | If disabled, the request is completed without starting recording. |
File Path |
Yes when Record the call = on
|
Output file path. |
File Format |
Yes when Record the call = on
|
Output file format. |
Split Channels |
No | Channel split behavior. |
Wait For Recording Completion |
No | Wait for recording completion before returning. |
Options -> Request ID |
No | Explicit request ID override. Usually resolved automatically from the trigger item. |
| Format-specific options | No | See shared format options above. |
| Branch | Typical fields |
|---|---|
Result |
recordRequestId, optional active, optional legId, optional filePath, optional durationMs, optional bytesProduced
|
If a global recording is already active for the same leg, the runtime finalizes the old one and starts a new one immediately.
| Parameter | Required | Description |
|---|---|---|
File Path |
Yes | Output file path. |
File Format |
Yes | Output file format. |
Split Channels |
No | Channel split behavior. |
Wait For Recording Completion |
No | Wait for recording completion before returning. |
Options -> Leg ID |
No | Explicit target leg. If omitted, resolves from current item leg metadata. |
| Format-specific options | No | See shared format options above. |
| Branch | Typical fields |
|---|---|
Result |
legId, optional filePath, optional durationMs, optional bytesProduced
|
| Parameter | Required | Description |
|---|---|---|
Action |
Yes |
Pause or Resume. |
Options -> Leg ID |
No | Explicit target leg. If omitted, resolves from current item leg metadata. |
| Branch | Fields |
|---|---|
Result |
legId |
| Stream | Included |
|---|---|
| Inbound remote audio | Yes |
| Outbound PBX playback from media operations | Yes |
| Bridge audio sent toward the leg | Yes |
| Final mixed outbound signal after playback and bridge mixing | Yes |
| Mode | Behavior |
|---|---|
Split Channels = on |
Channel 1 contains inbound remote audio. Channel 2 contains outbound PBX audio, including media playback and bridged outbound audio. |
Split Channels = off |
The runtime emits a mono mix of inbound and outbound streams. If only one side is present, it is forwarded without artificial remix. |