IssuedInstance
Estrutura de dados do contrato OpenAPI.
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" |
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"
]
}
]
}