Get Conversations

Page describing the API for getting list of conversations

The resource allows retrieving conversations generated in PMA within a specific time period.

Get conversations

POST https://api.jelou.ai/v1/external/conversations/attended

Query Parameters

Name	Type	Description
limit	Int	Total of conversations. Default: 10
page	Int	Page number

Request Body

Name	Type	Description
startAt*	Date	Start date of the range to be queried
endAt*	Date	end date of the range to be queried
botId	String	Bot ID

200

{
  "pagination": {
    "limit": 10,
    "page": 1,
    "total": 1,
    "offset": 0,
    "totalPages": 1
  },
  "_metadata": {},
  "results": [
    {
      "_id": "67ef5723ad98bcc34fr2h789",
      "operator": {
        "id": 1,
        "names": "Operador Miguel",
        "email": "[e-mail]"
      },
      "user": {
        "id": "59345XXX76XXX",
        "names": "Usuario Luis"
      },
      "bot": {
        "id": "+18X6XXX21XXX",
        "name": "Jelou AI"
      },
      "company": {
        "name": "Jelou AI"
      },
      "assignationMethod": {
        "teamName": "Soporte"
      },
      "state": "closed",
      "endedReason": "transferred",
      "startAt": "2025-03-20 11:23:45",
      "endAt": "2025-03-20 11:52:18",
      "firstRepliedAtOperator": "2025-03-20 11:26:37",
      "origin": "referral",
      "timeRepliedOperator": 172000,
      "conversationDuration": 1713000,
      "avgOperatorResponseTime": 92350
    }
  ],
  "links": [
    {
      "number": 3,
      "url": "/v1/external/conversations/attended?limit=15&page=3"
    },
    {
      "number": 4,
      "url": "/v1/external/conversations/attended?limit=15&page=4"
    },
    {
      "number": 5,
      "url": "/v1/external/conversations/attended?limit=15&page=5"
    }
  ]
}

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."
    }
  }
}

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."
    }
  }
}

Example:

cURL

curl --request POST \
  --url 'https://api.jelou.ai/v1/external/conversations/attended?limit=1&page=1' \
  --header 'authorization: Basic {{Base64EncodedUsername:Password}}' \
  --header 'content-type: application/json;charset=UTF-8' \
  --data '{
  "startAt": "2025-02-01T00:00:00-05:00",
  "endAt": "2025-03-26T13:59:59-05:00"
}'