IssuedInstance

Estrutura de dados do contrato OpenAPI.

Estrutura de dados do contrato OpenAPI.

Campos

CampoTipoPresençaDescrição
idstringobrigatórioFormato: uuid
namestringobrigatório
systemNamestringopcional
companyIdstringopcional
statusstringobrigatórioValores: "disconnected", "connecting", "connected"
ownerstringobrigatório
profileNamestringobrigatório
qrcodestringobrigatórioPNG em data URI quando há QR vigente; vazio no restante e nas listagens.
paircodestringopcional
lastDisconnectstringopcionalRFC 3339. Formato: date-time
lastDisconnectReasonstringopcional
disconnectCodestringopcional
workerstringopcional
limitEnforcementstringopcional
limitUntilstringopcionalRFC 3339. Formato: date-time
createdstringopcionalRFC 3339. Formato: date-time
updatedstringopcionalRFC 3339. Formato: date-time
kindstringobrigatórioValores: "whatsapp", "calls"
tokenstringobrigatórioSegredo 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"
      ]
    }
  ]
}