Start, stop, pause or resume recording of a call
/org/{tenant_code}/v2/calls/{uid}/recording
Platform support: MT and CC
Sets the recording state of the live call identified by uid. This is the write side of the
record_status field returned by the list and fetch endpoints, and it uses the same
vocabulary, so the four recording operations are expressed as a target state rather than as
separate actions:
status | Effect |
|---|---|
RecordingActive | Starts recording, or resumes it if paused |
RecordingPaused | Pauses an active recording |
NotRecording | Stops recording |
The request is idempotent: setting the state the call is already in succeeds and does
nothing. Pausing a call that is not being recorded (NotRecording → RecordingPaused)
yields 422 Unprocessable Entity.
202 Accepted means the change was requested on the PBX, not that it has taken effect —
the recording state flips when Asterisk confirms it. Re-read the call, or watch the
event_call_* event stream, to observe the resulting record_status.
Scope rules match the other single-call endpoints: a user token may only control recording
on its own extension's call; an API key / service may control any call in the tenant. A user
token is additionally subject to the Instant Recording enhanced service check (see 403);
an API key / service is not.
Request
Responses
- 202
- 400
- 401
- 403
- 404
- 422
- 500
- 504
Recording state change accepted
Missing or invalid target recording status
Missing or malformed user identity
The authenticated user is not allowed to control recording. Returned when the Instant Recording enhanced service is disabled for the extension, or when hide_rec_pause is set
on a Call Center deployment.
The requested resource or scope is not available. Returned, for example, when the system scope is used on a non-multi-tenant deployment, or with a non-API-key identity.
The requested transition is not possible from the call's current recording state — specifically, pausing a call that is not being recorded.
Internal server error
The proxy timed out waiting for the processing thread to service the request. For call initiation the call may still proceed on the PBX; for a list request no state is changed. The timeout only bounds how long the request is held open.