SIP PBX icon

SIP PBX

Global recording → Control recording

AI-generated

Summary

Control the global recording state (pause or resume) for a specified SIP leg.

Inputs

  • recordingControlAction (required) — The action to perform on the global recording; either 'pause' or 'resume'.
  • options — Optional collection of per-leg configuration; includes a 'legId' string to target a specific leg.

Output shape

no body — success/failure only

Returns a success response with no payload; may error if the leg ID is invalid or the action is not supported.

Examples

Example 1: Pause recording on leg 456

recordingControlAction: pause, options: { "legId": "456" }

Example 2: Resume recording on leg 789

recordingControlAction: resume, options: { "legId": "789" }

Example 3: Control recording without specifying a leg

recordingControlAction: pause

Links

Discussion