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

Iniciar ligação por instância calls

Exige kind=calls conectado e módulo ligado. Retorna 201 ao iniciar; acompanhar o estado. video: true inicia uma chamada de vídeo (exige capabilities.calls_video). Em instância whatsapp mantém 501 calls_not_supported. Não equivale à chamada sem áudio do provedor legado.

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.

Idempotência: suporta Idempotency-Key, com retenção de 24 horas. Preserve a mesma chave, método, caminho e bytes do corpo ao repetir. Entenda a idempotência.

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
Idempotency-KeystringopcionalASCII visível sem espaços, 1–128. Repetir método, caminho e os mesmos bytes do JSON. 409 em andamento; 422 se mudar a requisição. 504 é guardado e não deve causar reenvio automático. Comprimento mínimo: 1. Comprimento máximo: 128

Corpo da requisição

Formato: application/json. Corpo obrigatório.

CampoTipoPresençaDescrição
numberstringobrigatórioTelefone com DDI (formatação removida pela API) ou JID de conversa direta. Resolve as duas formas do nono dígito brasileiro. Comprimento mínimo: 1
videobooleanopcionalInicia uma chamada de vídeo: a oferta anuncia vídeo e o envio da câmera abre quando a mídia começa. Exige capabilities.calls_video=true; caso contrário 501 calls_video_not_supported. Padrão: false

Respostas

Chamada iniciada; acompanhar pelo callId.

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.