Como usar os endpoints do Weni Chats para retorno de salas

Você sabia que é possível acessar informações específicas sobre as salas de atendimento utilizando o endpoint do Weni Chats? Isso pode ser feito de forma simples e rápida, facilitando a gestão e o acompanhamento do atendimento.

Por onde começar?

Para listar as salas de chat, você pode utilizar o endpoint:

URL:
https://chats-engine.weni.ai/v1/external/list_rooms

Headers:
Inclua o seguinte header para autenticação:

Authorization: Bearer < token >

Solicite o seu token de acesso abrindo ticket diretamente com nossa equipe!
(Envie o link do seu projeto ao abrir o ticket)

Parâmetros Disponíveis

  • search: (string)

Esse parâmetro permite buscar salas específicas com base em diferentes campos:

  • uuid do contato (recomendado)
  • Nome do contato
  • E-mail do agente
  • URN (Uniform Resource Name)

Dica: Para garantir resultados mais precisos, busque pelo uuid do contato. Utilizar o nome pode retornar múltiplos contatos com o mesmo nome, o que pode causar confusão.

  • is_active: (boolean)

Esse parâmetro filtra as salas pelo estado:

  • true para salas abertas
  • false para salas fechadas

Exemplo de Requisição

Na imagem, é mostrado um exemplo de como fazer uma requisição para o endpoint do Weni Chats para buscar salas de atendimento.

O que foi requisitado:

  • Foi feita uma busca específica por uma sala de atendimento usando o uuid de um contato.
  • A requisição também pediu para retornar apenas as salas que estão ativas (ou seja, abertas).

O que foi retornado:

  • A resposta trouxe as informações sobre uma sala de atendimento aberta associada ao uuid buscado.
  • Detalhes como o nome do contato, o identificador único da sala, e a data de criação foram retornados, confirmando que a sala está ativa.

Essa requisição vai retornar todas as salas abertas associadas ao contato identificado pelo uuid informado. Ajuste os parâmetros conforme necessário para filtrar as salas de acordo com suas necessidades.

E qualquer dúvida você já sabe, estamos aqui para te ajudar!

4 curtidas