FindMessagesRequest

Estrutura de dados do contrato OpenAPI.

Estrutura de dados do contrato OpenAPI.

Campos

CampoTipoPresençaDescrição
idstringopcionalID da mensagem guardada nesta instância. Nos corpos aceita também owner:id. Comprimento mínimo: 1
chatidstringopcionalDígitos com DDI (8–15) ou identificador @s.whatsapp.net, @g.us ou @lid. Nunca inferir telefone de um LID. Comprimento mínimo: 1
limitinteger / stringopcional0/ausente usa 100; máximo 200. Padrão: 100
offsetinteger / stringopcionalDeslocamento da página.
includeHistoryboolean / string / integer / nullopcionalPadrão: true

Definição OpenAPI

json
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "ID da mensagem guardada nesta instância. Nos corpos aceita também owner:id.",
      "minLength": 1
    },
    "chatid": {
      "type": "string",
      "description": "Dígitos com DDI (8–15) ou identificador @s.whatsapp.net, @g.us ou @lid. Nunca inferir telefone de um LID.",
      "minLength": 1
    },
    "limit": {
      "oneOf": [
        {
          "type": "integer",
          "minimum": 0,
          "maximum": 200
        },
        {
          "type": "string",
          "description": "Inteiro em formato decimal.",
          "pattern": "^\\d+$"
        }
      ],
      "description": "0/ausente usa 100; máximo 200.",
      "default": 100
    },
    "offset": {
      "oneOf": [
        {
          "type": "integer",
          "minimum": 0
        },
        {
          "type": "string",
          "description": "Inteiro em formato decimal.",
          "pattern": "^\\d+$"
        }
      ],
      "description": "Deslocamento da página."
    },
    "includeHistory": {
      "oneOf": [
        {
          "type": "boolean"
        },
        {
          "type": "string",
          "enum": [
            "true",
            "false",
            "1",
            "0",
            ""
          ]
        },
        {
          "type": "integer",
          "enum": [
            0,
            1
          ]
        },
        {
          "type": "null"
        }
      ],
      "default": true
    }
  }
}