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

Hang up a call through the API

Hang up a call through the API

Pro
POSThttp://localhost:8084/call/{instanceName}/{callId}/hangup

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
reasonstringmaxLength: 160
Exemplo JSONgerado do schema
{
  "reason": "string"
}

Respostas

application/json
200

Termination sent; lifecycle remains ENDING until remote confirmation or timeout

response 200object
callobjectobrigatório
idstringobrigatórioformat: uuid
instanceIdintegerobrigatório
instancestring
providerstringobrigatório
providerCallIdstring
directionenum<incoming | outgoing>obrigatório
statusenum<INCOMING | OUTGOING | RINGING | PREACCEPTED | CONNECTING | ACTIVE | ENDING | ENDED | ENDED_UNCONFIRMED | REJECTED | MISSED | BUSY | FAILED | INTERRUPTED | ANSWERED_ELSEWHERE | REJECTED_ELSEWHERE>obrigatório
peerstring | null
peerJidstring
audiobooleanobrigatório
videobooleanobrigatório
localVideoActiveboolean
remoteVideoActiveboolean
recordingEnabledboolean
recordingRequestedboolean
recordingStartedboolean
recordingCompletedboolean
recordingAvailableboolean
recordingStatusenum<NOT_REQUESTED | PENDING | RECORDING | FINALIZING | PROCESSING | COMPLETED | PARTIAL | FAILED | UNAVAILABLE>
recordingUnavailableReasonenum<media_owned_by_another_device>
recordingStartedAtstringformat: date-time
recordingCompletedAtstringformat: date-time
answeredByenum<api | another_device | unknown>
endedByenum<api | peer | another_device | provider | timeout | application | unknown>
answerRequestedByenum<api | another_device | unknown>
endReasonstring
providerReasonstring
stateVersioninteger
lastProviderEventAtstringformat: date-time
startedAtstringobrigatórioformat: date-time
ringingAtstringformat: date-time
answeredAtstringformat: date-time
connectedAtstringformat: date-time
endedAtstringformat: date-time
durationSecondsinteger
terminationobjectobrigatório
requestedAtstringobrigatórioformat: date-time
sentAtstringformat: date-time
confirmedAtstringformat: date-time
acknowledgedAtstringformat: date-time
sentbooleanobrigatório
confirmedbooleanobrigatório
signalAcknowledgedbooleanobrigatório
remoteTerminationObservedbooleanobrigatório
confirmationTimedOutbooleanobrigatório
attemptsintegerobrigatóriomín: 0
providerReasonstring
stanzaIdstring
tostring
callCreatorstring
Exemplo 200gerado do schema
{
  "call": {
    "id": "01900000-0000-7000-8000-000000000001",
    "instanceId": 1,
    "instance": "minha-instancia",
    "provider": "string",
    "providerCallId": "string",
    "direction": "incoming",
    "status": "INCOMING",
    "peer": "string",
    "peerJid": "[email protected]",
    "audio": true,
    "video": true,
    "localVideoActive": true,
    "remoteVideoActive": true,
    "recordingEnabled": true,
    "recordingRequested": true,
    "recordingStarted": true,
    "recordingCompleted": true,
    "recordingAvailable": true,
    "recordingStatus": "NOT_REQUESTED",
    "recordingUnavailableReason": "media_owned_by_another_device",
    "recordingStartedAt": "2026-07-13T15:10:00Z",
    "recordingCompletedAt": "2026-07-13T15:10:00Z",
    "answeredBy": "api",
    "endedBy": "api",
    "answerRequestedBy": "api",
    "endReason": "string",
    "providerReason": "string",
    "stateVersion": 1,
    "lastProviderEventAt": "2026-07-13T15:10:00Z",
    "startedAt": "2026-07-13T15:10:00Z",
    "ringingAt": "2026-07-13T15:10:00Z",
    "answeredAt": "2026-07-13T15:10:00Z",
    "connectedAt": "2026-07-13T15:10:00Z",
    "endedAt": "2026-07-13T15:10:00Z",
    "durationSeconds": 1
  },
  "termination": {
    "requestedAt": "2026-07-13T15:10:00Z",
    "sentAt": "2026-07-13T15:10:00Z",
    "confirmedAt": "2026-07-13T15:10:00Z",
    "acknowledgedAt": "2026-07-13T15:10:00Z",
    "sent": true,
    "confirmed": true,
    "signalAcknowledged": true,
    "remoteTerminationObserved": true,
    "confirmationTimedOut": true,
    "attempts": 1,
    "providerReason": "string",
    "stanzaId": "string",
    "to": "string",
    "callCreator": "string"
  }
}