Obtener Conversaciones

API para obtener una lista de conversaciones, incluyendo parámetros y respuestas.

Este endpoint permite obtener una lista de todas las conversaciones, con sus detalles.

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

Parámetros de Consulta

Propiedad	Tipo de dato	Descripción
limit	int	Número total de conversaciones a consultar (por defecto: 10)

Cuerpo de la Solicitud

Propiedad	Tipo de dato	Descripción
startAt*	string	Fecha de inicio del rango de consulta
endAt*	string	Fecha de fin del rango de consulta
getJson*	boolean	Tipo de dato de respuesta (debe ser true)

Respuesta Exitosa (200)

{
  "message": ["Retrieving conversations succeeded"],
  "status": "success",
  "results": [
    {
      "_id": "111111aaaaaa",
      "operator": {
        "names": "Jelou app"
      },
      "user": {
        "id": "111111111111"
      },
      "bot": {
        "name": "Jelou Dev WhatsApp"
      },
      "company": {
        "id": 123
      },
      "assignationMethod": {
        "teamName": "Frontend"
      },
      "state": "expired",
      "endedReason": "expired",
      "startAt": "2023-06-08 15:52:41",
      "endAt": "2023-06-08 23:07:56",
      "origin": "ticket",
      "timeRepliedOperator": 795880,
      "conversationDuration": 26115953
    }
  ],
  "pagination": {
    "limit": 1,
    "total": 61,
    "offset": 0,
    "totalPages": 61
  },
  "links": [
    {
      "number": 1,
      "url": "/v1/metrics/conversations/attended/external?limit=1&page=1"
    },
    {
      "number": 2,
      "url": "/v1/metrics/conversations/attended/external?limit=1&page=2"
    }
  ]
}

Ejemplo de Solicitud

cURL

curl --request POST \
  --url 'https://api.jelou.ai/v1/metrics/conversations/attended/external?limit=10' \
  --header 'Authorization: <clientId>:<clientSecret>' \
  --header 'content-type: application/json;charset=UTF-8' \
  --data '{
    "startAt": "2020-01-01T00:00:00-05:00",
    "endAt": "2020-01-01T23:59:59-05:00",
    "getJson": true
  }'

Javascript

axios({
  method: "POST",
  url: "https://api.jelou.ai/v1/metrics/conversations/attended/external",
  params: { limit: "10" },
  headers: {
    "content-type": "application/json;charset=UTF-8",
    Authorization: "<clientId>:<clientSecret>",
  },
  data: {
    startAt: "2020-01-01T00:00:00-05:00",
    endAt: "2020-01-01T23:59:59-05:00",
    getJson: true,
  },
});