IssuedInstance

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. Valores: `"allow"`, `"reject"`, `"reject_reply"`
`token`	`string`	obrigatório	Segredo de instância: guardar no backend. Só criação/reemissão; replay idempotente de init pode repetir por 15 min. Comprimento mínimo: `64`. Comprimento máximo: `64`

Definição OpenAPI

json

{
  "allOf": [
    {
      "$ref": "#/components/schemas/Instance"
    },
    {
      "type": "object",
      "properties": {
        "token": {
          "type": "string",
          "description": "Segredo de instância: guardar no backend. Só criação/reemissão; replay idempotente de init pode repetir por 15 min.",
          "minLength": 64,
          "maxLength": 64
        }
      },
      "required": [
        "token"
      ]
    }
  ]
}