FindMessagesResult

Estrutura de dados do contrato OpenAPI.

Estrutura de dados do contrato OpenAPI.

Campos

CampoTipoPresençaDescrição
messagesarray<object>obrigatório—
messages[].idstringobrigatórioowner:messageid.
messages[].messageidstringobrigatório—
messages[].chatidstringobrigatório—
messages[].senderstringopcional—
messages[].sender_pnstringopcional—
messages[].senderNamestringopcional—
messages[].pushNamestringopcional—
messages[].isGroupbooleanopcional—
messages[].fromMebooleanobrigatório—
messages[].wasSentByApibooleanopcional—
messages[].messageTypestringopcionalTipo legado PascalCase.
messages[].typestringopcional—
messages[].messageTimestampintegeropcionalUnix em milissegundos. Formato: int64
messages[].timestampintegeropcionalUnix em segundos. Formato: int64
messages[].statusstringopcionalPending, Sent, Delivered, Read, Played, Failed, Received ou Deleted.
messages[].textstringopcional—
messages[].contentobjectopcional—
messages[].buttonOrListidstringopcional—
messages[].reactionsarray<object>opcional—
messages[].choicesanyopcionalOpções armazenadas de menus/enquetes; estrutura depende do tipo e pode ser null.
messages[].fileURLstringopcional—
messages[].mediaUrlstringopcional—
returnedMessagesintegerobrigatório—
limitintegerobrigatório—
offsetintegerobrigatório—
hasMorebooleanobrigatório—
nextOffsetintegeropcional—

Definição OpenAPI

json
{
  "type": "object",
  "properties": {
    "messages": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/LegacyMessage"
      }
    },
    "returnedMessages": {
      "type": "integer"
    },
    "limit": {
      "type": "integer"
    },
    "offset": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "nextOffset": {
      "type": "integer"
    }
  },
  "required": [
    "messages",
    "returnedMessages",
    "limit",
    "offset",
    "hasMore"
  ]
}