LogoLogo
Zenvia Docs
  • Zenvia NLU
  • Boas Práticas
    • Eventos
      • Dicas para criar eventos
      • Eventos Personalizados
        • menu_principal
          • Dashboard
          • Fluxograma
          • Builder
          • Lista de Eventos
        • Autosservico
          • Dashboard
          • Fluxograma
          • Builder
          • Lista de eventos
        • sucess_no_friccion
          • Dashboard
          • Fluxograma
          • Builder
          • Lista de Eventos
        • horario_atendimento
          • Dashboard
          • Fluxograma
          • Builder
          • Lista de eventos
        • transbordo
          • Dashboard
          • Fluxograma
          • Builder
          • Lista de eventos
        • pesquisa_satisfacao
          • Dashboard
          • Fluxograma
          • Builder
          • Lista de eventos
        • conseguiu_ajudar
          • Dashboard
          • Fluxograma
          • Builder
          • Lista de eventos
        • nivel_confianca
          • Dashboard
          • Fluxograma
          • Builder
          • Lista de eventos
        • chamada_api
          • Dashboard
          • Fluxograma
          • Builder
          • Lista de Eventos
        • falha_api
          • Dashboard
          • Fluxograma
          • Builder
          • Lista de Eventos
        • primeiro_acesso
          • Dashboard
          • Fluxograma
          • Builder
          • Lista de Eventos
        • encerramento
          • Dashboard
          • Fluxograma
          • Builder
          • Lista de Eventos
        • estouro_tentativas_else
          • Dashboard
          • Fluxograma
          • Builder
          • Lista de Eventos
        • intents
          • Dashboard
          • Fluxograma
          • Builder
          • Lista de Eventos
        • rechamada
          • Dashboard
          • Fluxograma
          • Builder
          • Lista de Eventos
    • Gestão de NLU
      • Dicas de gestão de NLU
    • Personalizar widget
  • Monitor
    • Dashboard
      • Métricas e indicadores
      • Gráficos
    • Atendimentos
    • Eventos
    • Volumetria
    • Issues
    • Monitoramento de APIs
    • Métricas de avaliação
  • Build
    • Assistentes
      • Edição do Assistente
      • Builder
        • Configurações do nó
        • Componentes
          • Output
            • Texto
            • Texto randômico
            • Texto sequencial
            • Base de conhecimento
            • LivePerson - Conteúdo Estruturado
            • Arquivo
          • Input
            • Pergunta aberta
            • Autocomplete
            • Data
            • Feedback NPS
            • Feedback Custom
            • Lista inline
            • Lista modal
            • Quick Replies
            • Upload de arquivo
            • Upload de arquivo LP
            • Carrossel de Opções
            • Desambiguação
          • Fluxo de Inatividade
          • Variáveis
          • Ações
            • HTTP Request
            • Satisfaction
            • Validar celular
            • Validar CEP
            • Validar CPF
            • Validar CPF/CNPJ
            • Validar CNPJ
            • Validar nome completo
            • Validar e-mail
            • Procurar atendimento
            • Transferência entre skills Liveperson
            • Setar contexto LivePerson
            • Encerrar Atendimento LivePerson
            • Encerrar chat
            • Socket Event
            • Facebook Profile
            • Facebook Transbordo
            • Workplace Profile
            • Iniciar LiveChat
            • Functions
            • Setar NLU
            • Transferência entre assistentes
            • Contact Return
            • Intent Feedback
          • Eventos
    • Functions
    • Atributos
  • CONNECT
    • APIs
      • Agent connector API
      • Outbound
        • Outbound WhatsApp
        • Outbound Zenvia
        • Outbound Wavy
        • Outbound LivePerson
        • Outbound Infobip
        • Outbound RCS
      • Eventos
      • Atendimentos
      • LGPD
    • Canais
      • Capabilities
      • Instagram
      • Google Business Messages
      • Bot API
      • Facebook
        • Integração Messenger via Zenvia NLU
        • Integração Messenger via Liveperson
      • Google RCS
      • Microsoft Teams
      • Whatsapp
        • Zenvia
        • Blip
        • Wavy
        • Infobip
        • Liveperson
      • Widget
      • Workplace
    • Telegram
    • Contingência
    • LiveChat
      • Transbordo ALTU Connector API
        • Transbordo Tech4Humans
      • Transbordo LivePerson
      • Transbordo Zendesk Ticket
      • Transbordo Zendesk Chat
      • Transbordo Salesforce
  • TRAIN
    • Primeiros passos
    • Visão Geral
    • Configuração do NLU
    • Avaliação de Mensagens
    • Análise e ajustes
  • Mais
    • Release
      • Controle de Versão
      • 27/10/2021
      • 06/10/2021
      • 22/09/2021
      • 09/09/2021
      • 11/08/2021
      • 28/07/2021
      • 14/07/2021
      • 30/06/2021
      • 16/06/2021
      • 01/06/2021
      • 18/05/2021
      • 04/05/2021
      • 20/04/2021
      • 06/04/2021
      • 23/03/2021
      • 09/03/2021
      • 23/02/2021
      • 09/02/2021
      • 26/01/2021
      • 12/01/2021
      • 22/12/2020
      • 08/12/2020
      • 24/11/2020
      • 10/11/2020
      • 27/10/2020
      • 13/10/2020
      • 29/09/2020
      • 15/09/2020
      • 01/09/2020
      • 18/08/2020
      • 03/08/2020
      • 21/07/2020
      • 08/07/2020
      • 30/06/2020
      • 04/06/2020
      • 22/05/2020
      • 14/05/2020
      • 29/04/2020
      • 01/04/2020
      • 24/03/2020
      • 16/03/2020
    • Glossário
Powered by GitBook
On this page
  • Objetivo
  • Request
  • Limitações

Was this helpful?

  1. CONNECT
  2. APIs

Atendimentos

PreviousEventosNextLGPD

Last updated 2 years ago

Was this helpful?

Objetivo

A API de atendimentos (Contacts) tem por objetivo consultar os atendimentos de uma determinada instância do Zenvia NLU.

Request

POST https://api.altubots.com/contacts/<instancia>

Headers

Name
Type
Description

x-api-key

<token>

{
    "contacts": [
        ...
        {
            "id": 3213,
            "identifier": "52fe68c3-4501-cde1-e6fb-d3cb11d0ad9c",
            "assistantId": 1,
            "source": "widget",
            "externalId": null,
            "interactions": 30,
            "dateCreated": "2020-06-01"
            "finishedAt": "2020-06-03"
            "attributes": {
                "name": "...",
                "email": "...",
                ...
            },
            "history": [
                {
                    "time": "2020-06-01T12:45:59.158Z",
                    "sender": "bot",
                    "message": [
                        {
                            "text": "Olá! Eu sou o assistente virtual.",
                            "type": "text"
                        },
                        {
                            "text": "O que você deseja?",
                            "type": "text"
                        }
                    ]
                },
                ...
            ]
            "events": [
                ...
                {
                    "id": 13213,
                    "assistantId": 1,
                    "contactId": 16267,
                    "externalId": null,
                    "eventName": "transbordo",
                    "eventId": 12,
                    "extra1": null,
                    "extra2": null,
                    "details": {
                        "cpf": "12345678909",
                        "skill": "assistencia_tecnica"
                    },
                    "date": "2020-06-22 16:38:42"
                },
                ...
            ]
        },
        ...
    ]
    "resultCount": "150",
    "pagination": "Hash para consultar a próxima página"
}
{
    "message": "Bad request",
    "invalidParams": [
        ...
    ]
}
{
    "message": "Unauthorized"
}
{
    "contacts": [],
    "resultCount": 0
}
{
    "status": "error",
    "message": "Unexpected error"
}

Body template

{
    "filters": {
        "id": "ID do atendimento",
        "assistantId": "ID do assistente",
        "identifier": "Identifier do contato",
        "externalId": "External id do atendimento",
        "startDate": "Início do período da consulta (Y-m-d)",
        "endDate": "Fim do período da consulta (Y-m-d)",
        "source": "Canal de origem do atendimento",
        "limit": "Quantidade de resultados por página" //Default: 100 - max: 500
    }
    "attributes": {
        "cpf": "CPF do atendimento",
        "phone": "Telefone do atendimento",
        "email": "Email do atendimento",
        "identification_number": "Extra de identificação",
        "identification_number2": "Extra de identificação 2",
        "identification_number3": "Extra de identificação 3",
        "identification_number4": "Extra de identificação 4"        
    },
    "flags": {
        "history": "Boolean para trazer ou não o histórico de mensagens do atendimento",  //Default: false
        "events": "Boolean para trazer ou não o histórico de eventos do atendimento" //Default: false
    },
    "pagination": "Hash para consultar a próxima página"
}

Limitações

  • Máximo de resultados por consulta: 500

    • Utilizar paginação para buscar páginas seguintes

  • Consultas que não tenham o filter id, identifier ou phone não retornarão histórico e eventos

  • Um fluxo comum de requisições/consultas seria:

    1. Consultar pelo assistantId, startDate e endDate

    2. Em cada atendimento encontrado, usar o id ou identifier para fazer uma nova consulta com a flag history: true para buscar o histórico daquele atendimento

  • Limite de 50000 consultas por dia e 10 por segundo

O paginationé disponibilizado no response da primeira consulta para que você possa referenciá-lo no body da próxima consulta e assim sucessivamente.