CodeChat APIv1.0.0
ChangelogPostman
Referência/Calls/startCallRecording
Calls

Start local disk recording for a managed call

Records only media that is available in the API runtime. Calls answered on another linked device return 409 and do not create media files.

Pro
POSThttp://localhost:8084/call/{instanceName}/{callId}/recording/start

Autenticação

InstanceBearerobrigatório

JWT HS256 da própria instância.

Header
Authorization
Exemplo
Bearer <INSTANCE_TOKEN>

Parâmetros

instanceNamepathobrigatório
string

Nome publico da instancia

minLength 1
callIdpathobrigatório
string<uuid>

ID interno da chamada

Request body

bodyobject
audiobooleanpadrão: true
videobooleanpadrão: false
incomingAudiobooleanpadrão: true
outgoingAudiobooleanpadrão: true
incomingVideobooleanpadrão: true
outgoingVideobooleanpadrão: true
consentGrantedbooleanpadrão: false
consentAtstringformat: date-time
reasonstring
Exemplo JSONgerado do schema
{
  "audio": true,
  "video": false,
  "incomingAudio": true,
  "outgoingAudio": true,
  "incomingVideo": true,
  "outgoingVideo": true,
  "consentGranted": false,
  "consentAt": "2026-07-13T15:10:00Z",
  "reason": "string"
}

Respostas

application/json
202

Recording started

response 202object
dataarrayobrigatório
items[]object
idstringobrigatórioformat: uuid
instanceIdinteger
callIdstringobrigatórioformat: uuid
typeenum<AUDIO_RAW | AUDIO_MIXED | AUDIO_STEREO | AUDIO_FINAL | VIDEO_RAW | VIDEO_FINAL | CALL_FINAL | METADATA>obrigatório
mediaTypeenum<audio | video | metadata>
directionenum<INCOMING | OUTGOING | MIXED | COMBINED>obrigatório
formatenum<wav | h264 | json>obrigatório
relativePathstring
sizeBytesintegerformat: int64
durationMsintegerformat: int64
durationSecondsinteger
sampleRateinteger
channelsinteger
audioCodecstring
videoCodecstring
checksumSha256string
statusenum<NOT_REQUESTED | PENDING | RECORDING | FINALIZING | PROCESSING | COMPLETED | PARTIAL | FAILED | UNAVAILABLE>obrigatório
errorCodestring
errorMessagestring
downloadAvailablebooleanobrigatório
startedAtstringformat: date-time
completedAtstringformat: date-time
expiresAtstringformat: date-time
createdAtstringformat: date-time
updatedAtstringformat: date-time
Exemplo 202gerado do schema
{
  "data": [
    {
      "id": "01900000-0000-7000-8000-000000000001",
      "instanceId": 1,
      "callId": "01900000-0000-7000-8000-000000000001",
      "type": "AUDIO_RAW",
      "mediaType": "audio",
      "direction": "INCOMING",
      "format": "wav",
      "relativePath": "string",
      "sizeBytes": 1,
      "durationMs": 1,
      "durationSeconds": 1,
      "sampleRate": 1,
      "channels": 1,
      "audioCodec": "string",
      "videoCodec": "string",
      "checksumSha256": "string",
      "status": "NOT_REQUESTED",
      "errorCode": "string",
      "errorMessage": "Olá! Esta é uma mensagem de exemplo da CodeChat.",
      "downloadAvailable": true,
      "startedAt": "2026-07-13T15:10:00Z",
      "completedAt": "2026-07-13T15:10:00Z",
      "expiresAt": "2026-07-13T15:10:00Z",
      "createdAt": "2026-07-13T15:10:00Z",
      "updatedAt": "2026-07-13T15:10:00Z"
    }
  ]
}