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
  • Visão geral
  • Habilitar e configurar API
  • Estrutura
  • Versão 1.0
  • Body's templates:
  • Webhook de status
  • Versão 2.0
  • Body's templates:

Was this helpful?

  1. CONNECT
  2. APIs
  3. Outbound

Outbound LivePerson

PreviousOutbound WavyNextOutbound Infobip

Last updated 2 years ago

Was this helpful?

Visão geral

Com a ferramenta Proactive Messaging da é possível criar campanhas e templates para envio de mensagens ativas via WhatsApp e Apple Business Chat.

Antes de habilitar a API de Outbound no Zenvia NLU, você deverá da LivePerson e se certificar que cumpriu todos os requisitos, com atenção especial ao template ()

Caso você fique preso na tela de apresentação "LivePerson Proactive Messaging" realize a limpeza de cache e cookies do seu navegador

Os próximos passos serão dedicados a habilitar e configurar API para envio de outbound via WhatsApp.

Habilitar e configurar API

Vá até Canais > WhatsApp > LivePerson

Estrutura

Na tela inicial da área de edição de integrações você verá todas as informações da integração. No fim da página você irá encontrar um botão para habilitar a API de outbound.

Você deverá escolher entre a versão 1.0 ou 2.0, conforme a versão da sua conta na LivePerson.

Versão 1.0

Ao habilitar a API de outbound 1.0 é gerado um endpoint e um token. Eles serão utilizados para realizar o envio das mensagens ativas. Use a ferramenta de requisição de API’s de sua preferência, e a configure utilizando as seguintes informações:

POST https://outbound.ms.altubots.com/liveperson/<slug>/<id_integracao>

Headers

Name
Type
Description

Content-type

string

application/json

Authorization

string

<token>

{
  "status": "pending",
  "messageId": 161
}
{
	"status": "error",
	"message": "Invalid destination!"
}
{ 
	"status": "error",
	"message": "Contact not found!" 
}
{ 
	"status": "error",
	"message": "Unexpected error" 
}

Você encontra um exemplo de como fazer a requisição no campo de “documentação” que fica ao lado das configurações da API. Essas informações podem ser copiadas e coladas.

Body's templates:

Utilize este body quando for enviar uma mensagem ativa somente com texto e variáveis, SEM imagens, botões ou documentos:

{
    "destination": "35999999999",
    "context": {
        "status": "aprovado"
    },
    "hsm": true,
    "richTemplateName": "meu_template",
    "richTemplateVariables": {
        "variable_number": "variable_value"
    },
    "restartContact": false,
    "skill": "minha_skill",
		"inactivityTime": 2
}

Atributos:

  • destination: número que irá receber a mensagem

  • context (opcional): variáveis que serão salvas no contexto do usuário

  • hsm: campo necessário para envio de mensagem hsm

  • richTemplateName: nome do template de mensagem a ser enviado

  • richTemplateVariables (opcional): variáveis do template

    • variable_number: número da variável dentro do template (1, 2, 3...)

    • variable_value: valor que substituirá o número da variável no template

  • restartContact (opcional): boleano para resetar as variáveis de contexto do usuário

  • skill (opcional): habilidade na liveperson que atenderá o usuário

  • inactivityTime (opcional): tempo em minutos que deve passar desde a última interação do usuário com o assistente para que a mensagem seja enviada. Exemplo: Se o usuário está interagindo ou interagiu com assistente a 1 minuto e o tempo de inatividade necessário para mensagem ser enviada é 2 minutos("inactivityTime": 2) a mensagem não é enviada, caso a interação tivesse ocorrido a 3 minutos a mensagem seria enviada.

Com este body é possível enviar uma mensagem ativa com imagens, documentos e botões:

{
   "destination": "11999999999",
   "context": {
       "status": "aprovado",
   },
   "hsm": true,
   "richTemplateName": "richtemplate",
   "richTemplateVariables": {
       "pic": "https:imageURL.png",
       "variable_number": "variable_value"
   }
}

Atributos:

  • destination: número que irá receber a mensagem

  • context (opcional): variáveis que serão salvas no contexto do usuário

  • hsm: campo necessário para envio de mensagem hsm

  • richTemplateName: nome do template de mensagem a ser enviado

  • richTemplateVariables (opcional): variáveis do template

    • variable_number: número da variável dentro do template (1, 2, 3...)

    • variable_value: valor que substituirá o número da variável no template

Caso o assistente tenha recebido uma mensagem da pessoa usuária nas últimas 24 horas, você pode enviar uma notificação para continuar a conversa. Utilize este body:

{
    "destination": "35988841854",
    "messages": "Envie um 'Oi' para iniciar o atendimento",
    "context": {
        "status": "aprovado"
    },
		"inactivityTime": 2
}

Atributos:

  • destination: número que irá receber a mensagem

  • messages: mensagem a ser enviada

  • context (opcional): variáveis de contexto do usuário que serão salvas

  • inactivityTime (opcional): tempo em minutos que deve passar desde a última interação do usuário com o assistente para que a mensagem seja enviada. Exemplo: Se o usuário interagiu com assistente a 1 minuto e o tempo de inatividade necessário para mensagem ser enviada é 2 minutos ("inactivityTime": 2) a mensagem não será enviada. Caso a interação tivesse ocorrido a 3 minutos a mensagem seria enviada.

Exemplo HSM Padrão:

TemplateName: template_test

Mensagem: Olá {{1}}! Temos uma atualização a respeito da sua solicitação aberta. Envie um "oi" para saber mais.

{
    "destination": "35998631234",
    "context": {
        "status": "aprovado"
    },
    "hsm": true,
    "richTemplateName": "template_test",
    "richTemplateVariables": {
        "1": "TESTE"
    },
    "restartContact": false,
    "skill": "atendimento",
		"inactivityTime": 2
}    

Mensagem recebida:

Olá TESTE! Temos uma atualização a respeito da sua solicitação aberta. Envie um "oi" para saber mais.

Webhook de status

Um webhook é uma infraestrutura que recebe informações sobre as mensagens de outbound enviadas. Ele é composto por um endpoint (link do webhook, onde o cliente receberá as atualizações de status) e um token (acesso gerado pela equipe Zenvia NLU para realizar a integração). Você vai precisar das seguintes informações, que são encontradas logo abaixo da área de configuração da API de outbound:

  • Header: token gerado pelo Zenvia NLU, que é específico para cada assistente e canal

  • Post: link com o endpoint informado para acesso

Os status retornados via webhook são:

  • Enviado (sent): retorno exclusivo para ativos enviados pela LivePerson, indica o sucesso no encaminhamento da mensagem.

  • Entregue (delivered): Indica que a mensagem foi entregue (equivalente ao sinal único de visto ✅ no WhatsApp).

  • Respondido (replied): Indica que a mensagem foi respondida pelo usuário.

  • Erro (error): Indica que houve um erro no envio da mensagem.

O status <enviado> é instantâneo. O <respondido>será entregue primeiro e tem prioridade no <entregue>

{
  "external_id": "36ef4510-9c96-11eb-8ccf-dfce354710ee",
  "status": "sent",
  "destination": "35999999999",
  "client": "demo",
  "date": "2021-04-13T17:24:16-03:00"
}
{
  "external_id": "36ef4510-9c96-11eb-8ccf-dfce354710ee",
  "status": "delivered",
  "destination": "35999999999",
  "client": "demo",
  "date": "2021-04-13T17:24:15-03:00"
}
{
  "external_id": "36ef4510-9c96-11eb-8ccf-dfce354710ee",
  "status": "replied",
  "destination": "35999999999",
  "client": "demo",
  "message": "Ola",   //resposta enviada pelo usuario
  "date": "2021-04-13T17:24:25-03:00"
}
{
  "external_id": "36ef4510-9c96-11eb-8ccf-dfce354710ee",
  "status": "error",
  "destination": "35999999999",
  "client": "demo",
  "message": "Erro ao enviar HSM",
  "date": "2021-04-13T17:24:15-03:00"
}

Versão 2.0

Na tela de configuração da API de outbound, ao selecionar a opção V 2.0 a configuração passa a ser a seguinte:

  • ALTU Token: token configurado que será usado na requisição

  • Domínio do serviço: informação preenchida automaticamente de acordo com o id da conta cadastrado na integração

  • Domínio da API: informação preenchida automaticamente de acordo com o id da conta cadastrado na integração

  • Id do cliente: Id do cliente localizado na conta LivePerson

  • Segredo do cliente: Id do cliente localizado na conta LivePerson

Ao salvar a integração na versão 2.0, não será possível voltar para a 1.0

POST https://outbound.ms.altubots.com/liveperson/<slug>/<id_integracao>

Headers

Name
Type
Description

Content-type

string

application/json

Authorization

string

<token>

{
  "status": "sent",
  "messageId": 163,
  "external_id": "1405d120-c801-11ea-bc3c-331e67fe876f",
  "contact_id": 1
}
{
  "status": "error",
  "message": "Invalid destination!"
}
{
  "status": "error",
  "message": "5535988841852 is not eligible for wa."
}

Você encontra um exemplo de como fazer a requisição no campo de “documentação” que fica ao lado das configurações da API. Essas informações podem ser copiadas e coladas.

Body's templates:

Utilize este body quando for enviar uma mensagem ativa somente com texto e variáveis, SEM imagens, botões ou documentos:

{
    "outboundNumber": "5511999999999",
    "destination": "35999999999",
    "context": {
        "status": "aprovado"
    },
    "hsm": true,
    "templateId": "1111111111111",
    "richTemplateVariables": {
        "variable_number": "variable_value"
    },
    "restartContact": false,
    "skill": "atendimento",
		"inactivityTime": 2
} 

Atributos:

  • outboundNumber: número que irá enviar a mensagem

  • destination: número que irá receber a mensagem

  • context (opcional): variáveis que serão salvas no contexto do usuário

  • hsm: campo necessário para envio de mensagem hsm

  • templateId: nome do template de mensagem a ser enviado

  • richTemplateVariables (opcional): variáveis do template

    • variable_number: número da variável dentro do template (1, 2, 3...)

    • variable_value: valor que substituirá o número da variável no template

  • restartContact (opcional): boleano para resetar as variáveis de contexto do usuário

  • skill : habilidade na liveperson que atenderá o usuário

  • inactivityTime (opcional): tempo em minutos que deve passar desde a última interação do usuário com o assistente para que a mensagem seja enviada. Exemplo: Se o usuário está interagindo ou interagiu com assistente a 1 minuto e o tempo de inatividade necessário para mensagem ser enviada é 2 minutos("inactivityTime": 2) a mensagem não é enviada, caso a interação tivesse ocorrido a 3 minutos a mensagem seria enviada.

Com este body é possível enviar uma mensagem ativa com imagens, documentos e botões:

{
    "outboundNumber": "5511999999999",
    "destination": "35999999999",
    "context": {
        "status": "aprovado"
    },
    "hsm": true,
    "templateId": "1111111111111",
    "richTemplateVariables": {
        "1": "TESTE"
    },
    {
    "headerVariables": {
        "video": "https://file-examples-com.github.io/uploads/2017/04/file_example_MP4_640_3MG.mp4" 
    }
    },
    "restartContact": false,
    "skill": "atendimento",
		"inactivityTime": 2
} 

Atributos:

  • outboundNumber (opcional): número que dispara a mensagem

  • destination: número que irá receber a mensagem

  • context (opcional): variáveis de contexto do usuário que serão salvas

  • hsm: campo necessário para envio de mensagem hsm

  • templateId: ID template de mensagem a ser enviado

  • richTemplateVariables (opcional): variáveis do template

    • variable_number: número da variável dentro do template( 1, 2 3 ...)

    • variable_value: valor que substituirá o número da variável no template

  • headerVariables (opcional): variáveis de mídia no cabeçalho do template

  • restartContact (opcional): booleano para resetar as variáveis de contexto do usuário

  • skill: habilidade na LivePerson que atenderá o usuário

  • inactivityTime (opcional): tempo em minutos que deve passar desde a última interação do usuário com o assistente para que a mensagem seja enviada. Exemplo: Se o usuário está interagindo ou interagiu com assistente a 1 minuto e o tempo de inatividade necessário para mensagem ser enviada é 2 minutos("inactivityTime": 2) a mensagem não é enviada, caso a interação tivesse ocorrido a 3 minutos a mensagem seria enviada.

Caso o assistente tenha recebido uma mensagem da pessoa usuária nas últimas 24 horas, você pode enviar uma notificação para continuar a conversa. Utilize este body:

{
    "destination": "35988841854",
    "messages": "Envie um 'Oi' para iniciar o atendimento",
    "context": {
        "status": "aprovado"
    },
		"inactivityTime": 2
}

Na versão 2.0 o Webhook de status não está disponível.

Ao clicar sobre o ícone da LivePerson, você irá visualizar uma tela com todos os assistentes já integrados a esse Broker. Escolha qual será o responsável pelo envio e clique em editar integrações, simbolizado pelo ícone de lápis

Os dados abaixo devem ser recuperados através da URL:

https://authentication.liveperson.net/
LivePerson
consultar essa documentação
HSM
Caminho para o Proactive Messaging dentro da página LivePerson
Caminho até a integração com WhatsApp via LivePerson
Edite a integração de um assistente para habilitar a API de Outbound
Botão de habilitar API Outbound
Informações sobre endpoint e token versão v.1 no Zenvia NLU
Configuração de webhook no ALTU
Informações sobre endpoint e token versão v.2 no Zenvia NLU