InitRequest

Estrutura de dados do contrato OpenAPI.

Estrutura de dados do contrato OpenAPI.

Campos

CampoTipoPresençaDescrição
namestringobrigatórioObrigatório, até 128 bytes UTF-8, sem controle ou espaços nas extremidades. Comprimento mínimo: 1. Comprimento máximo: 128
systemNamestringopcionalAté 128 bytes; recomendado Atendro. Comprimento máximo: 128
companyIdstringopcionalAté 128 bytes; vínculo com tenant no consumidor. Filtro de lista, não autorização. Comprimento máximo: 128
kindstringopcionalImutável após criar. calls exige o módulo habilitado e pareamento próprio. Valores: "whatsapp", "calls". Padrão: "whatsapp"
callsMaxConcurrentintegeropcionalLimite de ligações simultâneas desta instância calls, incluindo as que estão tocando. Acima de 1 ainda depende de homologação em chamadas reais. Opcional na criação; omitido, persiste o padrão ATENDROZAP_CALLS_MAX_CONCURRENT do servidor. Recusado em kind=whatsapp. Mínimo: 1. Máximo: 8
incomingCallModestringopcionalOpcional apenas em kind=calls. Omitido, preserva o comportamento allow. Padrão: "allow"

Definição OpenAPI

json
{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "Obrigatório, até 128 bytes UTF-8, sem controle ou espaços nas extremidades.",
      "minLength": 1,
      "maxLength": 128
    },
    "systemName": {
      "type": "string",
      "description": "Até 128 bytes; recomendado Atendro.",
      "maxLength": 128
    },
    "companyId": {
      "type": "string",
      "description": "Até 128 bytes; vínculo com tenant no consumidor. Filtro de lista, não autorização.",
      "maxLength": 128
    },
    "kind": {
      "type": "string",
      "enum": [
        "whatsapp",
        "calls"
      ],
      "default": "whatsapp",
      "description": "Imutável após criar. calls exige o módulo habilitado e pareamento próprio."
    },
    "callsMaxConcurrent": {
      "type": "integer",
      "minimum": 1,
      "maximum": 8,
      "description": "Limite de ligações simultâneas desta instância calls, incluindo as que estão tocando. Acima de 1 ainda depende de homologação em chamadas reais. Opcional na criação; omitido, persiste o padrão ATENDROZAP_CALLS_MAX_CONCURRENT do servidor. Recusado em kind=whatsapp."
    },
    "incomingCallMode": {
      "allOf": [
        {
          "$ref": "#/components/schemas/IncomingCallMode"
        }
      ],
      "default": "allow",
      "description": "Opcional apenas em kind=calls. Omitido, preserva o comportamento allow."
    }
  },
  "required": [
    "name"
  ]
}