Consultar mensagens

Recuperar mensagens

Este endpoint permite que o vendedor (seller) recupere uma coleção de mensagens por conversa utilizando filtros como referência.

Escopo requerido

Valor	Descrição
`conversations-seller:read`	Permite a leitura de conversas e mensagens.

Parâmetros da URL

Campo	Tipo	Descrição	Obrigatório
`conversation_id`	String	Identificador da conversa	Sim
`_limit`	Inteiro	Quantidade de registros a serem retornados. Valor padrão 10.	Não
`_offset`	Inteiro	Posição de registro de referência, a partir dele serão retornados os próximos N registros. Valor padrão 0.	Não

Chamada:

curl -X 'GET' \
  'https://apps.eupreciso.com.br/v.1.0/chat/conversations/{conversation_id}/messages?_offset=150&_limit=20' \
  -H 'accept: application/json' \
  -H 'Authorization': 'Bearer <access_token> \
  -H 'Content-Type: application/json' \

Resposta:

{
  "meta": {
    "page": {
      "limit": 20,
      "offset": 0,
      "count": 270,
      "max_limit": 100
    },
    "links": {
      "previous": null,
      "next": "?_offset=170&_limit=20",
      "self": "?_offset=130&_limit=20"
    }
  },
  "results": [
    {
      "id": "64c90174672831b5ec30ede3",
      "from_user": {
        "id": "6371b185f44410af024bed22",
        "name": "Daniel",
        "type": "CUSTOMER"
      },
      "to_user": {
        "id": "63bdc4671563bb5c30335059",
        "name": "Thiago R. C.",
        "type": "SELLER"
      },
      "content": "Essa é uma mensagem",
      "read": true,
      "is_answer": true,
      "when_at": "2023-08-01T12:58:28.543Z"
    },
    {
      "id": "64c90174672831b5ec30ede",
      "from_user": {
        "id": "63bdc4671563bb5c30335059",
        "name": "Thiago R. C.",
        "type": "SELLER"
      },
      "to_user": {
        "id": "6371b185f44410af024bed22",
        "name": "Daniel",
        "type": "CUSTOMER"
      },
      "content": "Essa é uma resposta",
      "read": true,
      "is_answer": true,
      "answered_message": "64c90174672831b5ec30ede3",
      "when_at": "2023-08-01T12:58:28.543Z"
    }
  ]
}

Recuperar mensagem por ID

Este endpoint permite que o vendedor (seller) recupere uma mensagem por ID.

Escopo requerido

Valor	Descrição
`conversations-seller:read`	Permite a leitura de conversas e mensagens.

Parâmetros da URL

Campo	Tipo	Descrição	Obrigatório
`conversation_id`	String	Identificador da conversa	Sim
`message_id`	String	Identificador da mensagem	Sim

Chamada:

curl -X 'GET' \
  'https://apps.eupreciso.com.br/v.1.0/chat/conversations/{conversation_id}/messages/{message_id}' \
  -H 'accept: application/json' \
  -H 'Authorization': 'Bearer <access_token> \
  -H 'Content-Type: application/json' \

Resposta:

{
  "id": "64c90174672831b5ec30ede3",
  "from_user": {
    "id": "6371b185f44410af024bed22",
    "name": "Daniel",
    "type": "CUSTOMER"
  },
  "to_user": {
    "id": "63bdc4671563bb5c30335059",
    "name": "Thiago R. C.",
    "type": "SELLER"
  },
  "content": "Essa é uma mensagem",
  "read": true,
  "is_answer": false,
  "when_at": "2023-08-01T12:58:28.543Z"
}

Consultar conversas Registrar leitura de uma conversa