# Instance

Estrutura de dados do contrato OpenAPI.

## Campos

| Campo | Tipo | Presença | Descrição |
|---|---|---|---|
| `id` | `string` | obrigatório | Formato: `uuid` |
| `name` | `string` | obrigatório | — |
| `systemName` | `string` | opcional | — |
| `companyId` | `string` | opcional | — |
| `status` | `string` | obrigatório | Valores: `"disconnected"`, `"connecting"`, `"connected"` |
| `owner` | `string` | obrigatório | — |
| `profileName` | `string` | obrigatório | — |
| `qrcode` | `string` | obrigatório | PNG em data URI quando há QR vigente; vazio no restante e nas listagens. |
| `paircode` | `string` | opcional | — |
| `lastDisconnect` | `string` | opcional | RFC 3339. Formato: `date-time` |
| `lastDisconnectReason` | `string` | opcional | — |
| `disconnectCode` | `string` | opcional | — |
| `worker` | `string` | opcional | — |
| `limitEnforcement` | `string` | opcional | — |
| `limitUntil` | `string` | opcional | RFC 3339. Formato: `date-time` |
| `created` | `string` | opcional | RFC 3339. Formato: `date-time` |
| `updated` | `string` | opcional | RFC 3339. Formato: `date-time` |
| `kind` | `string` | obrigatório | Valores: `"whatsapp"`, `"calls"` |
| `callsMaxConcurrent` | `integer` | opcional | Limite 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` |
| `callsConfigVersion` | `integer` | opcional | Versão crescente da configuração de chamadas; presente inclusive 0 em objetos instance de kind=calls. Comparar esta versão entre respostas HTTP e snapshots de webhook para evitar regressões. O campo não pertence às instâncias whatsapp. Mínimo: `0`. Formato: `int64` |
| `incomingCallMode` | `string` | opcional | Comportamento 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](https://wpp.atendro.cloud/docs/modelos/incoming-call-mode.md). Valores: `"allow"`, `"reject"`, `"reject_reply"` |

## Definição OpenAPI

```json
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid"
    },
    "name": {
      "type": "string"
    },
    "systemName": {
      "type": "string"
    },
    "companyId": {
      "type": "string"
    },
    "status": {
      "type": "string",
      "enum": [
        "disconnected",
        "connecting",
        "connected"
      ]
    },
    "owner": {
      "type": "string"
    },
    "profileName": {
      "type": "string"
    },
    "qrcode": {
      "type": "string",
      "description": "PNG em data URI quando há QR vigente; vazio no restante e nas listagens."
    },
    "paircode": {
      "type": "string"
    },
    "lastDisconnect": {
      "type": "string",
      "description": "RFC 3339.",
      "format": "date-time"
    },
    "lastDisconnectReason": {
      "type": "string"
    },
    "disconnectCode": {
      "type": "string"
    },
    "worker": {
      "type": "string"
    },
    "limitEnforcement": {
      "type": "string"
    },
    "limitUntil": {
      "type": "string",
      "description": "RFC 3339.",
      "format": "date-time"
    },
    "created": {
      "type": "string",
      "description": "RFC 3339.",
      "format": "date-time"
    },
    "updated": {
      "type": "string",
      "description": "RFC 3339.",
      "format": "date-time"
    },
    "kind": {
      "type": "string",
      "enum": [
        "whatsapp",
        "calls"
      ]
    },
    "callsMaxConcurrent": {
      "type": "integer",
      "minimum": 1,
      "maximum": 8,
      "description": "Limite 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."
    },
    "callsConfigVersion": {
      "type": "integer",
      "format": "int64",
      "minimum": 0,
      "description": "Versão crescente da configuração de chamadas; presente inclusive 0 em objetos instance de kind=calls. Comparar esta versão entre respostas HTTP e snapshots de webhook para evitar regressões. O campo não pertence às instâncias whatsapp."
    },
    "incomingCallMode": {
      "$ref": "#/components/schemas/IncomingCallMode"
    }
  },
  "required": [
    "id",
    "name",
    "status",
    "qrcode",
    "owner",
    "profileName",
    "kind"
  ]
}
```