Capabilities

Estrutura de dados do contrato OpenAPI.

Estrutura de dados do contrato OpenAPI.

Campos

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
interactiveobjectopcional
webhookEventsobjectopcional
webhookEvents.deliveredarray<string>opcional
webhookEvents.ignoredarray<string>opcional
instance_kindsarray<string>opcional
calls_max_concurrentintegeropcionalTeto por instância; padrão 1 quando configurado. Mínimo: 0

Definição OpenAPI

json
{
  "type": "object",
  "properties": {
    "service": {
      "type": "string",
      "enum": [
        "AtendroZAP"
      ]
    },
    "status": {
      "type": "string",
      "enum": [
        "laboratory"
      ]
    },
    "worker": {
      "type": "string"
    },
    "engine": {
      "type": "object"
    },
    "capabilities": {
      "type": "object",
      "properties": {
        "calls": {
          "type": "boolean",
          "description": "Habilitado neste worker por ATENDROZAP_CALLS_ENABLED; exige instância calls."
        },
        "ptt_transcoding": {
          "type": "boolean",
          "enum": [
            false
          ]
        }
      },
      "additionalProperties": {
        "type": "boolean"
      }
    },
    "interactive": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    },
    "webhookEvents": {
      "type": "object",
      "properties": {
        "delivered": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "ignored": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "instance_kinds": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "whatsapp",
          "calls"
        ]
      }
    },
    "calls_max_concurrent": {
      "type": "integer",
      "minimum": 0,
      "description": "Teto por instância; padrão 1 quando configurado."
    }
  },
  "required": [
    "service",
    "status",
    "capabilities"
  ]
}