---
title: "Recording status updated"
method: POST
path: "v2.recording.updated"
---

# Recording status updated

`POST v2.recording.updated` (webhook)

## Payload

- object
  - `id` string, required — Unique identifier for the event. Use this for idempotency checks.
  - `at` string, date-time, required — RFC 3339, section 5.6
  - `sid` string, required — Short ID
  - `type` 'v2.recording.updated', required — - `v2.billing.credit.topup` = Your account has been credited with a new amount. - `v2.billing.credit.warning` = Your prepaid balance has reached its warning level. - `v2.billing.credit.shutdown` = Your prepaid balance has reached its shutdown level. Your account is suspended. - `v2.call.inbound.started` = An inbound call just started. - `v2.call.inbound.ended` = An inbound call just hung up. - `v2.call.outbound.started` = An outbound call just started. - `v2.call.outbound.ended` = An outbound call just hung up. - `v2.number.assigned` = A phone number was assigned to your account. - `v2.number.unassigned` = A phone number was unassigned from your account. - `v2.task.updated` = A task has been updated. - `v2.audio-file.updated` = An audio file has been updated. - `v2.recording.updated` = A recording has been updated. - `v2.sms.inbound.received` = An inbound SMS has been received. - `v2.sms.outbound.updated` = An outbound SMS has an updated status.
  - `try` integer, required — Number of attempts made to deliver the webhook
  - `payload` Recording, required — Recording
    - `sid` string, required — Short ID
    - `type` 'call' | 'recording' | 'voicemail', required — Recording type
    - `callee` string, required — A phone number in ITU-T E.164 format https://en.wikipedia.org/wiki/E.164, prefixed by "+"
    - `scenario` object, required
      - `sid` string — Short ID
      - `name` string — Scenario name
    - `callid` integer, required — Call ID
    - `created` string, date-time, required — RFC 3339, section 5.6
    - `readAt` string, date-time — RFC 3339, section 5.6
    - `duration` integer, required — Call duration in seconds
    - `caller` CallerID, required — Caller ID
      - `name` string — Caller ID Name
      - `number` string — A phone number in ITU-T E.164 format https://en.wikipedia.org/wiki/E.164, prefixed by "+"
      - `restricted` boolean, required — Whether the Caller ID is restricted
    - `read` boolean, required — Read status
    - `status` 'ready' | 'processing' | 'pending' | 'error' | 'recording', required — Recording status
    - `url` string, uri — A URL to media hosted by Callr. Unlike user-submitted endpoints, this value is generated by the API and its host varies by environment (it may not resolve to a public domain, e.g. in local development).
    - `size` integer, required — Storage used in bytes
    - `options` RecordingOptions — Recording options
      - `ner` boolean, required — Whether to enable named entity recognition
      - `pii` boolean, required — Whether to enable personally identifiable information detection
      - `feeds` 'leg_a' | 'leg_b' | 'all', required — Feed to enable
      - `language` string, required — BCP 47 language tag
      - `sentiment` boolean, required — Whether to enable sentiment analysis
      - `transcription` boolean, required — Whether to enable transcription
    - `transcription` RecordingTranscription — The transcription of the recording.
      - `feeds` RecordingTranscriptionFeed[], required
        - `ner` RecordingTextAnalysisEntity[] — Named Entity Recognized (NER)
          - `text` string, required
          - `offset` integer, required
          - `category` string, required
          - `confidence` number, double, required
        - `pii` RecordingTextAnalysisEntity[] — Personally Identified Informations (PII)
          - `text` string, required
          - `offset` integer, required
          - `category` string, required
          - `confidence` number, double, required
        - `data` RecordingTranscriptionFeedData, required
          - `display` string, required — The display form of the recognized text. Added punctuation and capitalization are included.
          - `language` string, required — BCP 47 language tag
          - `lexical` string, required — Lexical representation of the transcribed text
          - `phrases` RecordingTranscriptionPhrase[], required
            - `offset` number, double, required — Start time of the phrase in seconds
            - `display` string, required — Display representation of the transcribed text
            - `confidence` number, double, required — Confidence score for the transcript
            - `words` RecordingTranscriptionWord[], required
              - …
        - `feed` string, required — Feed name
        - `sentiment` RecordingTranscriptionSentiment, required
          - `sentiment` string, required — Sentiment analysis
          - `confidenceScores` object, required — Confidence scores for each sentiment
            - `neutral` number, double, required — Confidence score for neutral sentiment
            - `negative` number, double, required — Confidence score for negative sentiment
            - `positive` number, double, required — Confidence score for positive sentiment
      - `version` string — The version of the transcription. This is used to determine the format of the transcription. It is not used for versioning the transcription itself.

## Acknowledgement `2XX`

OK

---

[API](https://skmtc.net/callr/apis/callr-rest-api-v2-0.md) · [All operations](https://skmtc.net/callr/apis/callr-rest-api-v2-0/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/callr/callr-rest-api-v2-0/versions/76d36d004a8f/schema)