VocalDocscontracts 1.65.0

Recording

The recording of one Call. It names no key and no storage path; the audio is read through the audio route.

An object with 11 fields.

Fields

FieldTypeRequiredDescription
call_idCallIdyes
created_atTimestampyes
duration_msinteger or nullyesThe length of the audio; null until the audio is uploaded.
formatRecordingFormat or nullyesNull until the audio is uploaded.
idRecordingIdyes
key_versionintegeryesThe version of the key that wraps the per-Call key; safe to log.
object"recording"yes
ring_msinteger or nullnoThe length in milliseconds of the ring tone the audio begins with (1.42.0, board #136): the ring-to-answer period of an inbound phone Call, the Call's ring_ms, so the Agent answered at this offset into the audio and a player marks the answer instant there. 0 to 60,000. Null when the audio begins at the answer, as for a web Call or a recording whose worker wrote no tone; absent from an api older than 1.42.0, which a reader treats as null.
size_bytesinteger or nullyesThe size of the stored object, ciphertext included; null until uploaded.
statusRecordingStatusyes
updated_atTimestampyes

Used by

The operations whose parameters, request body or responses name this shape directly.