/v1/capabilitiesConsultar 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
| Campo | Tipo | Presença | Descrição |
|---|---|---|---|
X-Request-Id | string | opcional | ASCII 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
| Campo | Tipo | Presença | Descrição |
|---|---|---|---|
service | string | obrigatório | Valores: "AtendroZAP" |
status | string | obrigatório | Valores: "laboratory" |
worker | string | opcional | — |
engine | object | opcional | — |
capabilities | object | obrigatório | — |
capabilities.calls | boolean | opcional | Habilitado neste worker por ATENDROZAP_CALLS_ENABLED; exige instância calls. |
capabilities.ptt_transcoding | boolean | opcional | Valores: false |
interactive | object | opcional | — |
webhookEvents | object | opcional | — |
webhookEvents.delivered | array<string> | opcional | — |
webhookEvents.ignored | array<string> | opcional | — |
instance_kinds | array<string> | opcional | — |
calls_max_concurrent | integer | opcional | Teto por instância; padrão 1 quando configurado. Mínimo: 0 |
unauthorized: header ausente, inválido ou duplicado. Bearer/query/instancekey não substituem admintoken/token.
| Campo | Tipo | Presença | Descrição |
|---|---|---|---|
error | string | obrigatório | — |
message | string | opcional | — |
messageid | string | opcional | ID para reconciliação quando o resultado é ambíguo. |
messageId | string | opcional | — |
id | string | opcional | — |
provider_code | integer | opcional | — |
error_key | string | opcional | — |
error_source | string | opcional | — |
details | object | opcional | — |
instance | object | opcional | Modelo: Instance. |
storage_unavailable (Retry-After=5). Algumas rotas também retornam 502 por falha da conexão/mídia; consultar error.
| Campo | Tipo | Presença | Descrição |
|---|---|---|---|
error | string | obrigatório | — |
message | string | opcional | — |
messageid | string | opcional | ID para reconciliação quando o resultado é ambíguo. |
messageId | string | opcional | — |
id | string | opcional | — |
provider_code | integer | opcional | — |
error_key | string | opcional | — |
error_source | string | opcional | — |
details | object | opcional | — |
instance | object | opcional | Modelo: Instance. |
Falha; usar HTTP status e error. 404 rota inexistente; 405 método inválido com Allow. Ver catálogo no guia de integração.
| Campo | Tipo | Presença | Descrição |
|---|---|---|---|
error | string | obrigatório | — |
message | string | opcional | — |
messageid | string | opcional | ID para reconciliação quando o resultado é ambíguo. |
messageId | string | opcional | — |
id | string | opcional | — |
provider_code | integer | opcional | — |
error_key | string | opcional | — |
error_source | string | opcional | — |
details | object | opcional | — |
instance | object | opcional | Modelo: Instance. |