atendroZAP Documentação
DocsDiagnóstico
Markdown
GET/v1/capabilities

Consultar capacidades

Fonte para habilitar funcionalidades. Para voz, exigir capabilities.calls=true e instance_kinds contendo calls. status=laboratory.

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.

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

Não há corpo de requisição definido para esta operação.

Respostas

Consultar capacidades

CampoTipoPresençaDescrição
servicestringobrigatórioValores: "AtendroZAP"
statusstringobrigatórioValores: "laboratory"
workerstringopcional—
engineobjectopcional—
capabilitiesobjectobrigatório—
capabilities.callsbooleanopcionalHabilitado neste worker por ATENDROZAP_CALLS_ENABLED; exige instância calls.
capabilities.ptt_transcodingbooleanopcionalValores: false
capabilities.call_historybooleanopcional—
capabilities.call_recordingbooleanopcionalGravação automática das chamadas atendidas habilitada neste worker.
capabilities.calls_per_instance_limitbooleanopcionalPermite configurar callsMaxConcurrent por instância, sem reiniciar a sessão.
capabilities.calls_videobooleanopcionalChamadas de vídeo, upgrade no meio da ligação e ponte GET /call/{id}/video habilitados neste worker por ATENDROZAP_CALLS_VIDEO_ENABLED (exige calls). Recurso experimental até a homologação em laboratório.
capabilities.calls_settings_webhookbooleanopcionalAnuncia call_settings com limite/versionamento em outbox atômica e callsConfigVersion em objetos instance. Exige inscrição explícita em call_settings; connection pode trazer o snapshot opcional em instance.
capabilities.calls_video_recordingbooleanopcionalCaptura de vídeo e geração de MP4 lado a lado habilitadas neste worker por ATENDROZAP_CALLS_VIDEO_RECORDING_ENABLED. Opt-in: requer calls_video, call_recording, FFmpeg e ffprobe. Não implica homologação em celulares reais.
capabilities.calls_incoming_policybooleanopcionalPermite configurar incomingCallMode, comparar expectedCallsConfigVersion e receber decisões de recusa automática com metadados por chamada. Não garante envio de mensagem pelo consumidor nem homologação de áudio recebido.
interactiveobjectopcional—
webhookEventsobjectopcional—
webhookEvents.deliveredarray<string>opcional—
webhookEvents.ignoredarray<string>opcional—
instance_kindsarray<string>opcional—
calls_max_concurrentintegeropcionalPadrão do servidor usado na criação e em instâncias antigas sem limite próprio. Consulte instance.callsMaxConcurrent para o limite efetivo. Mínimo: 0
calls_recording_retention_daysintegeropcionalRetenção das gravações de áudio em dias; 0 desativa exclusão automática do áudio. Vídeo possui prazo independente. Histórico preservado. Mínimo: 0
calls_video_recording_retention_daysintegeropcionalRetenção das gravações MP4 em dias, contados do encerramento da chamada. Padrão 7, independente do áudio. Histórico preservado. Mínimo: 1. Máximo: 3650
calls_max_concurrent_rangeobjectopcional—
calls_max_concurrent_range.minintegerobrigatórioValor fixo: 1
calls_max_concurrent_range.maxintegerobrigatórioValor fixo: 8