atendroZAP Documentação
DocsChamadas de voz e vídeo
Markdown
POST/v1/instances/{id}/call-settings

Configurar limite e comportamento das chamadas recebidas da instância

Persiste parcialmente callsMaxConcurrent e/ou incomingCallMode, mesmo desconectada, sem iniciar chamadas ou reiniciar a sessão. Campos omitidos permanecem. expectedCallsConfigVersion opcional exige a versão atual e retorna 409 settings_version_conflict em divergência. Cada POST aceito incrementa callsConfigVersion e grava atomicamente call_settings com limite e modo, mesmo repetindo valores. Alterações de modo valem para novas chamadas. O worker local aplica imediatamente; outro worker aplica na renovação do lease. Rejeições automáticas geram histórico e evento, inclusive quando ocupado, sem consumir uma vaga de atendimento. reject_reply somente solicita resposta ao consumidor: a instância calls não envia texto. A integração deve configurar uma conexão de mensagens, deduplicação e fila persistente. Reduzir o limite preserva chamadas vivas. Mais de uma simultânea e atendimento recebido ainda dependem de homologação real.

Autenticação

Header obrigatório: admintoken. Use o token administrativo do servidor.

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.

Parâmetros de caminho

CampoTipoPresençaDescrição
idstringobrigatórioIdentificador devolvido pela API. Comprimento mínimo: 1. Formato: uuid

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
callsMaxConcurrentintegercondicionalLimite próprio de ligações simultâneas da instância calls: voz e vídeo, recebidas e realizadas, incluindo ringing/connecting/active e reservas de discagem. Acima de 1 ainda depende de homologação em chamadas reais. Mínimo: 1. Máximo: 8
incomingCallModestringcondicionalComportamento 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"
expectedCallsConfigVersionintegeropcionalComparação condicional opcional. Se diferente da versão salva, retorna 409 settings_version_conflict sem alterar a instância. Enviar junto a pelo menos um campo de configuração. Mínimo: 0. Formato: int64

Pelo menos uma destas combinações deve ser válida:

  • callsMaxConcurrent
  • incomingCallMode

Respostas

Limite e snapshot persistidos na mesma transação; instance.callsMaxConcurrent e instance.callsConfigVersion são os valores canônicos. Compare a versão com respostas e eventos em trânsito.

CampoTipoPresençaDescrição
instanceobjectobrigatórioModelo: Instance.