v1

latestOpenAPI 3.1.1Proprietary2026-07-245895107.9 KB

Recordings

Update recording

Update a recording. You may send a partial object.

patch/recordings/{sid}

Path parameters

sidstring required

Short ID

Example:callrsid

Resource SID (8 lowercase alphanumeric characters)

Request body

readboolean

Read status

Example request

{
  "read": true
}

Response

Recording updated

sidstring required

Short ID

type'call' | 'recording' | 'voicemail' required

Recording type

calleestring required

A phone number in ITU-T E.164 format https://en.wikipedia.org/wiki/E.164, prefixed by "+"

callidinteger required

Call ID

createdstring date-time required

RFC 3339, section 5.6

readAtstring date-time

RFC 3339, section 5.6

durationinteger required

Call duration in seconds

readboolean required

Read status

status'ready' | 'processing' | 'pending' | 'error' | 'recording' required

Recording status

urlstring 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).

sizeinteger required

Storage used in bytes

Example response

{
  "sid": "callrsid",
  "type": "call",
  "callee": "+33199001234",
  "scenario": {
    "sid": "callrsid",
    "name": "My Call Flow"
  },
  "callid": 240711945874,
  "created": "2024-04-24T17:42:28Z",
  "readAt": "2024-04-24T17:42:28Z",
  "duration": 5,
  "caller": {
    "number": "+33199001234"
  },
  "read": true,
  "status": "ready",
  "url": "https://media.callr.com/library/1214981-F54777F6.mp3",
  "size": 123456,
  "options": {
    "ner": true,
    "pii": true,
    "feeds": "all",
    "language": "en-US",
    "sentiment": true,
    "transcription": true
  },
  "transcription": {
    "feeds": [
      {
        "data": {
          "display": "Hello, world!",
          "language": "en-US",
          "lexical": "hello world",
          "phrases": [
            {
              "display": "Hello, world!",
              "confidence": 0.98,
              "words": [
                {
                  "word": "hello"
                }
              ]
            }
          ]
        },
        "feed": "leg_a",
        "sentiment": {
          "sentiment": "neutral",
          "confidenceScores": {
            "neutral": 0.98,
            "negative": 0.98,
            "positive": 0.98
          }
        }
      }
    ],
    "version": "2.0"
  }
}