atendroZAP Documentação
DocsChamadas de voz e vídeo
Markdown
POST/call/hangup

Encerrar ligação

Token da instância calls que possui a chamada. Corpo com callId; a operação renova o lease antes do efeito externo.

Autenticação

Header obrigatório: token. Use o token da instância.

Base URL: a API do servidor selecionado, como https://1.atendro.cloud. O domínio wpp.atendro.cloud hospeda a documentação e o console.

Headers adicionais

CampoTipoPresençaDescrição
X-Request-IdstringopcionalASCII visível sem espaços, 1–128 caracteres. Inválido/ausente é substituído por UUID. Ecoado na resposta. Comprimento máximo: 128

Corpo da requisição

Formato: application/json. Corpo obrigatório.

CampoTipoPresençaDescrição
callIdstringobrigatórioComprimento mínimo: 1

Respostas

Estado da chamada após a ação.

CampoTipoPresençaDescrição
callIdstringobrigatório—
directionstringobrigatórioValores: "inbound", "outbound"
numberstringobrigatórioIdentidade telefônica canônica, quando conhecida.
jidstringopcional—
statusstringobrigatórioValores: "ringing", "connecting", "active", "ended"
startedAtstringobrigatórioFormato: date-time
answeredAtstringopcionalMomento do aceite remoto ou do atendimento local; não depende do primeiro áudio. Formato: date-time
endedAtstringopcionalFormato: date-time
endReasonstringopcionalhangup, rejected, ring_timeout, closed, unknown ou motivo do motor. Um terminate remoto sem motivo explícito (ausente, vazio ou só espaços) é hangup/remote: solicitação remota de encerramento, sem comprovar ação humana. Motivos explícitos são preservados; callbacks genéricos sem motivo continuam unknown. O primeiro motivo fica no histórico; registros antigos não são reclassificados.
endedBystringopcionalValores: "local", "remote"
answeredbooleanopcionalVerdadeiro a partir do aceite, mesmo antes de o áudio iniciar.
mediaStartedAtstringopcionalMomento em que o motor confirmou mídia recebida. Formato: date-time
durationSecondsnumberopcionalTempo entre atendimento e encerramento; zero para chamadas sem atendimento ou ainda em curso. Mínimo: 0
recordingobjectopcionalModelo: CallRecording.
videobooleanobrigatórioVerdadeiro quando a chamada é ou foi de vídeo (negociado em qualquer direção em algum momento). Permanece no histórico.
videoStateobjectopcionalEstado vivo do vídeo; presente apenas enquanto a chamada não terminou. Os campos sending/receiving refletem o fluxo negociado, não quadros efetivamente trafegando. Modelo: CallVideoState.
videoRecordingobjectopcionalGravação de vídeo independente do WAV. Campo opcional, presente somente após começar a captura de vídeo. processing indica composição do MP4 em fila após a chamada; não muda o estado ou a ocupação de ligações. O primeiro resultado terminal é preservado. Modelo: CallVideoRecording.
incomingCallModestringopcionalComportamento para novas chamadas recebidas: allow permite atendimento humano; reject recusa no servidor; reject_reply recusa e solicita ao consumidor resposta por uma conexão de mensagens vinculada. Não atende automaticamente. O envio do texto é independente da recusa. Modelo: IncomingCallMode. Valores: "allow", "reject", "reject_reply"
callsConfigVersionintegeropcionalVersão da política congelada na chegada da chamada recebida. Não é seq do evento; mudanças de configuração posteriores não alteram esta decisão. Mínimo: 0. Formato: int64
rejectionSourcestringopcionalOrigem de uma recusa confirmada: política automática, ocupação ou operador. Não confundir com timeout, desligamento remoto ou atendimento em outro dispositivo. Valores: "policy", "busy", "manual"
autoReplyRequestedbooleanopcionalVerdadeiro somente após recusa confirmada por política reject_reply. O consumidor enfileira o texto uma única vez por instância/chamada; este campo não comprova envio da resposta.