Como podemos ajudar?

22. Iniciar LiveChat
8 min
Criado por LA em 16/03/2023 17:50
Atualizado por Ligia Sarmento em 09/08/2023 11:47

As integrações de Live Chat são configuradas no menu Live Chat contendo integrações com a LivePerson e Zendesk.

LivePerson

Estrutura

[
{
"name": "start_live_chat",
"parameters": {
"integration_id": "ID da integração configurada",
"start_message": "Mensagem para o agente"
},
"result_variable": "response",
}
]

Atributos

  • parameters: {}
  • skill_id (opcional): ID da skill (habilidade) que deve receber o atendimento na LivePerson. Se esse atributo não for setado será usado a configuração padrão na LivePerson.
  • agent (opcional): ID do agente que atenderá o usuário. O valor pode ser número ou string.
  • start_message (opcional): Mensagem que será enviada para o agente quando a conversa iniciar.
  • campaign_info (opcional): {}
  • campaign_id (opcional): ID da campanha na LivePerson. Se esse atributo não for setado será usado a configuração padrão na LivePerson.
  • engagement_id( opcional): ID do engagement na LivePerson. Se esse atributo não for setado será usado a configuração padrão na LivePerson.
  • result_variable: variável de contexto que receberá o resultado do envio do atendimento para a LivePerson. Em caso de sucesso, essa variável conterá um JSON como o do exemplo abaixo:
{
"status": "ok",
"body": {
"reqId": "2a0b043e-7d81-45d0-9907-689564fdaeb1",
"code": "OK",
"body": {
"conversationId": "ebe75240-0e78-4ca5-bf5c-4818ae5d137f"
}
}
}

Exemplo

[
{
"name": "start_live_chat",
"parameters": {
"skill_id": "1589664150",
"campaign_info": {
"campaign_id": "1614784350",
"engagement_id": "1614784550"
},
"integration_id": 7,
"start_message": "Mensagem inicial para o agente"
},
"result_variable": "lp_widget_response"
}
]

 

Informações para o agente: insira informações adicionais para serem enviadas ao agente. Para isso utilize o extra_info :

[
{
"name": "start_live_chat",
"parameters": {
"extra_info": {
"endereco": {
"país": "Brasil",
"estado": "SP",
"cidade": "São Paulo",
"bairro": "Consolação",
"logradouro": "R. Sergipe",
"numero": "475",
"complemento": "5º Andar"
}
}
},
"result_variable": "response"
}
]

Atributos

  • extra_info: Informações adicionais que serão enviadas para o agente, obj/array, string ou num
  • contact_info: informações sobre o atendimento que serão repassadas ao agente, obj/array.
    O limite do json é de 1024 caracteres. Só será enviado para ALTU SDK, ficando de fora Liveperson e Zendesk.

⚠️Atenção:

  1. Esse atributo só funcionará para Live Chat com a LivePerson e ALTU SDK, ficando de fora a Zendesk;
  2. Em Liveperson, o atributo extra_info terá um limite de 256 caracteres. Passando disso, a action enviará um valor vazio;
  3. Para o ALTU SDK o limite é de 1024 caracteres.

 

Para saber mais: Agent Connector SDK

Encerramento da chamada

Após o transbordo, o bot "sai de cena" e os agentes da Liveperson assumem a conversa com o usuário.
Em seguida, o encerramento dessa conversa o bot é acionado novamente. O mesmo se aplica caso aconteça algum erro ou ninguém atenda a chamada após o tempo máximo de espera.
Nessas situações, o builder é acionado novamente com a variável input contendo as seguintes informações em cada situação:

Agente encerrou a chamada

{
"live_chat": {
"status": "agent_closed"
}
}

Usuário (cliente) encerrou a chamada

{
"live_chat": {
"status": "user_closed"
}
}

Nenhum agente atendeu a chamada dentro do tempo de espera

{
"live_chat": {
"status": "timeout"
}
}

Erro inesperado

{
"live_chat": {
"status": "error"
}
}

 

Zendesk

Estrutura

[
{
"name": "start_live_chat",
"parameters": {
"assignee_id":"9999999",
"tags": [
"<? $zendeskTag ?>",
"canal_smkwhatsapp",
"smkreceptivo"
],
"subject": "<? $zendeskSubject ?>",
"custom_fields": [
{
"id": "360023232032",
"value": "<? contact.cpf ?>"
},
{
"id": "360024868372",
"value": "<? contact.phone ?>"
}
],
"integration_id": "1",
"before_action_messages": [
"Aguarde um minuto..."
]
},
"result_variable": "ticketResponse"
}
]

Atributos

  • parameters: {}
  • assignee_id(opcional): ID do agente para qual o ticket será automaticamente atribuído. Se não for setado, será enviado para uma listagem junto aos demais tickets.
  • subject: assunto do ticket.
  • integration_id: id da integração.
  • tags: tags para definir/orientar o ticket.
  • user_fields (opcional): campos do usuário, visíveis apenas para agentes. Clique aqui para ver lista completa.
  • custom_fields (opcional): campos customizados, visíveis apenas para agentes.
  • brand_id (opcional): Id da marca
  • requester_id (opcional): o id do usuário (solicitante) cadastrado previamente na Zendesk
  • ticket_form_id (opcional): o id do formulário de ticket associado a solicitação se o formulário estiver visível para os usuários finais
  • group_id (opcional): A id do grupo atribuído se o campo estiver visível para os usuários finais.
  • before_action_messages: mensagem que será enviada ao usuário antes da abertura do ticket.
  • result_variable: variável de contexto que receberá o resultado da operação. Em caso de sucesso, essa variável conterá o seguinte JSON:

 

{
"response": {
"body": "<retorno esperado>",
"status": "ok"
}
}
Este artigo resolveu sua dúvida?
Últimos artigos visitados