Message history

Page describing the API for consulting the message history.

Chat History

GET https://api.jelou.ai/v1/external/messages/history/BOT_ID

Path Parameters

Name	Type	Description
botId	string	Bot ID

Query Parameters

Name	Type	Description
limit	int	Number of messages to request
page	int	Number of page
startAt*	date	Start date of the range to be queried
endAt*	date	End date of the range to be queried
clientId	string	Client ID
messageId	string	Message ID

200

{
  "pagination": {
    "limit": 10,
    "page": 1,
    "total": 1,
    "offset": 0,
    "totalPages": 1
  },
  "_metadata": {},
  "results": [
    {
      "recipient": {
        "id": "5939XXXXXXXX",
        "names": "John Doe"
      },
      "sender": {
        "id": "XXXXX-debf-XXXXX-XXXXX-XXXXX",
        "name": "Jelou Apps",
        "type": "Whatsapp"
      },
      "by": "bot",
      "messageId": "XXXXX-XXXXX-4a38-XXXXX-XXXXX",
      "status": "DELIVERED_USER",
      "bubble": {
        "type": "TEXT",
        "text": "Hello, welcome to Jelou"
      },
      "createdAt": "2025-04-02T13:59:06.598Z"
    }
  ]
}

404

{
  "message": [
    "The Bot could not be found at the moment."
  ],
  "statusMessage": "failed",
  "status": 0,
  "error": {
    "code": "E1019",
    "key": "BOT_NOT_FOUND",
    "description": "Error to be thrown when trying to get a Bot.",
    "developerMessages": {
      "es": "El botId no se encuentra en la base de datos o ha sido eliminado.",
      "en": "The botId is not found in the database or has been deleted.",
      "pt": "A botId não é encontrada no banco de dados ou foi apagada."
    },
    "clientMessages": {
      "es": "El Bot no se pudo encontrar por el momento.",
      "en": "The Bot could not be found at the moment.",
      "pt": "A Bot não pôde ser encontrada no momento."
    }
  }
}

422

{
  "message": [
    "Los valores ingresados no son correctos."
  ],
  "statusMessage": "failed",
  "status": 0,
  "error": {
    "code": "E0422",
    "key": "VALIDATOR_ERROR",
    "description": "Error to be thrown when cannot process request because of incoming values",
    "developerMessages": {
      "es": "Los valores del request no son correctos para ser procesados.",
      "en": "The request values are not correct for processing."
    },
    "clientMessages": {
      "es": "Los valores ingresados no son correctos.",
      "en": "The values entered are not correct."
    }
  },
  "validationError": {
    "startAt": [
      {
        "es": "el campo startAt debe ser una fecha",
        "en": "the startAt field must be a Date",
        "pt": "o campo startAt deve ser uma data"
      }
    ]
  }
}

500

{
  "message": [
    "We are having trouble processing your request. Please try again later."
  ],
  "statusMessage": "failed",
  "status": 0,
  "error": {
    "code": "E0000",
    "key": "UNKNOWN_ERROR",
    "description": "Error to be thrown when it couldn't be determined the reason of failure",
    "developerMessages": {
      "es": "Error inesperado occurido, revisar logs.",
      "en": "Unexpected error occurred, check logs."
    },
    "clientMessages": {
      "es": "Estamos teniendo problemas procesando la solicitud. Por favor intenta mas tarde.",
      "en": "We are having trouble processing your request. Please try again later."
    }
  }
}

Request example

cURL

curl --request GET \
  --url 'https://api.jelou.ai/v1/external/messages/history/BOT_ID?startAt=START_DATE&endAt=END_DATE' \
  --header 'authorization: Basic Base64Encoded{{Username:Password}}''