Audio Files

Update audio file properties

Update the properties of an audio file. You can only update the name.

patch/audio-files/{sid}

Request

Base URL
https://api.callr.com/v2.0
URL
https://api.callr.com/v2.0/audio-files/{sid}
Auth
- API key in header x-api-key
- or HTTP basic

Path parameters

sidstring required

Short ID

Example:callrsid

Resource SID (8 lowercase alphanumeric characters)

Request body

namestring

Audio file name

Example request

{
  "name": "My Audio File"
}

Response

Audio file updated

sidstring required

Short ID

namestring required

Audio file name

durationinteger required

Duration in seconds

source'phone-record' | 'system' | 'file-upload' required

Audio file source

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

readonlyboolean required

System provided files cannot be modified

status'ready' | 'processing' | 'pending-content' | 'pending-conversion' | 'error' required

Audio file status

createdstring date-time required

RFC 3339, section 5.6

updatedstring date-time required

RFC 3339, section 5.6

Example response

{
  "sid": "callrsid",
  "name": "My Audio File",
  "duration": 42,
  "source": "system",
  "url": "https://media.callr.com/library/1214981-F54777F6.mp3",
  "readonly": true,
  "status": "ready",
  "created": "2024-04-24T17:42:28Z",
  "updated": "2024-04-24T17:42:28Z"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.