Instance · AtendroZAP Docs

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"`

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"
      ]
    }
  },
  "required": [
    "id",
    "name",
    "status",
    "qrcode",
    "owner",
    "profileName",
    "kind"
  ]
}