For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Log inSign up
Support
cXMLREST API
cXMLREST API
  • Core
    • Overview
    • Authorization
    • Error codes
    • Paging
    • REST client SDKs
  • Compatibility REST API
        • POSTRecording status callback
      • POSTCreate a Recording
      • POSTUpdate a Recording
      • GETList all Recordings
      • GETRetrieve a Recording
      • DELDelete a Recording.
LogoLogoSignalWire Docs
Log inSign up
Support
Compatibility REST APIRecordingsWebhooks

Recording status callback

|View as Markdown|Open in Claude|
Payload
1{
2  "AccountSid": "b3877c40-da60-4998-90ad-b792e98472af",
3  "CallSid": "b3877c40-da60-4998-90ad-b792e98472ca",
4  "RecordingSid": "b3877c40-da60-4998-90ad-b792e984re01",
5  "RecordingUrl": "https://example.signalwire.com/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Recordings/b3877c40-da60-4998-90ad-b792e984re01",
6  "RecordingStatus": "completed",
7  "RecordingDuration": 94,
8  "RecordingChannels": 1,
9  "RecordingSource": "RecordVerb"
10}
Payload sent by SignalWire to your `RecordingStatusCallback` URL when a recording status event occurs. Recordings are not always available immediately — especially at high call volumes. This callback lets your app react as soon as a recording is ready, whether that means uploading it to external storage, sending it via email, or forwarding the URL via SMS. Configure `RecordingStatusCallback` when [creating a call via the API](/docs/compatibility-api/rest/calls/create-a-call) or when using [Dial](/docs/compatibility-api/cxml/reference/voice/dial), [Conference](/docs/compatibility-api/cxml/reference/voice/conference), or [Record](/docs/compatibility-api/cxml/reference/voice/record). Use `RecordingStatusCallbackEvent` to request callbacks for specific events. If omitted, only the `completed` event is sent. Possible values: `in-progress`, `completed`, `absent`. | Status | Description | |--------|-------------| | `in-progress` | The recording has begun. | | `completed` | The file is available for access. | | `absent` | The recording was too short or the call was silent — no audio was detected. |
Was this page helpful?
Previous

Create a Recording

Next
Built with

Payload sent by SignalWire to your RecordingStatusCallback URL when a recording status event occurs.

Recordings are not always available immediately — especially at high call volumes. This callback lets your app react as soon as a recording is ready, whether that means uploading it to external storage, sending it via email, or forwarding the URL via SMS.

Configure RecordingStatusCallback when creating a call via the API or when using Dial, Conference, or Record.

Use RecordingStatusCallbackEvent to request callbacks for specific events. If omitted, only the completed event is sent. Possible values: in-progress, completed, absent.

StatusDescription
in-progressThe recording has begun.
completedThe file is available for access.
absentThe recording was too short or the call was silent — no audio was detected.

Payload

The payload of this webhook request is an object.
AccountSidstringRequired
The unique ID of the project this call is associated with.
CallSidstringRequired
A unique identifier for the call. May be used to later retrieve this call from the REST API.
RecordingSidstringRequired
The unique identifier for the recording.
RecordingUrlstringRequired
The URL for the audio recording.
RecordingStatusenumRequired

The status of the recording.

  • in-progress: Recording has begun.
  • completed: File is available.
  • absent: Recording was too short or no audio was detected.
Allowed values:
RecordingDurationintegerRequired
The duration, in seconds, of the recording.
RecordingChannelsintegerRequired
The number of channels in the recording.
RecordingSourcestringRequired
The type of call that initiated the recording.

Response

200
Webhook received