LiveChat
O LiveChat é um software de atendimento ao cliente online com suporte ao vivo, software de suporte técnico e recursos de análise da Web.
Esse conector está disponível nos seguintes produtos e regiões:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Aplicativos Lógicos | Standard | Todas as regiões dos Aplicativos Lógicos , exceto as seguintes: – Regiões do Azure Governamental - Regiões do Azure China - Departamento de Defesa dos EUA (DoD) |
| Power Apps | Premium | Todas as regiões do Power Apps , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Power Automate | Premium | Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Contato | |
|---|---|
| Nome | Microsoft |
| URL | https://www.livechat.com/ |
| Metadados do conector | |
|---|---|
| Publicador | Microsoft |
| Site | https://www.livechat.com/ |
| Política de privacidade | https://www.livechat.com/legal/privacy-policy/ |
| Categories | Comunicação |
Criando uma conexão
O conector dá suporte aos seguintes tipos de autenticação:
| Default | Parâmetros para criar conexão. | Todas as regiões | Não compartilhável |
Padrão
Aplicável: todas as regiões
Parâmetros para criar conexão.
Essa não é uma conexão compartilhável. Se o aplicativo de energia for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.
| Nome | Tipo | Description | Obrigatório |
|---|---|---|---|
| ID da entidade herdada (preterida) | cadeia | A ID da Entidade (endereço de email) usada somente por operações preteridas da API do LiveChat v2. | |
| ID da conta | cadeia | A ID da Conta (GUID) mostrada na página Tokens de Acesso Pessoal do LiveChat. Novas operações de conector (V2) usam esse valor com a API do LiveChat v3.6. | Verdade |
| Token de acesso pessoal | secureString | O Token de Acesso Pessoal completo e não codificado para essa conta. | Verdade |
Limitações
| Nome | Chamadas | Período de renovação |
|---|---|---|
| Chamadas à API por conexão | 100 | 60 segundos |
Ações
| Agentes de lista (preteridos) [PRETERIDOS] |
Essa operação preterida retorna agentes usando a API do LiveChat v2. Em vez disso, use agentes de lista (V2). |
| Atualizar tíquete (preterido) [PRETERIDO] |
Essa operação preterida usa a API de Ingressos do LiveChat desativada. |
| Criar um novo agente (preterido) [PRETERIDO] |
Essa operação preterida cria um agente usando a API do LiveChat v2. Em vez disso, use Criar um novo agente (V2). |
| Criar um novo agente (V2) |
Cria um agente usando a API do LiveChat v3.6. O agente pode exigir aprovação dependendo dos escopos do Token de Acesso Pessoal e da assinatura do LiveChat. |
| Criar um novo tíquete (preterido) [PRETERIDO] |
Essa operação preterida usa a API de Ingressos do LiveChat desativada. |
| Listar agentes (V2) |
Retorna todos os agentes na licença do LiveChat usando a API do LiveChat v3.6. O Token de Acesso Pessoal requer os agentes– escopo all:ro. |
| Listar tíquetes (preteridos) [PRETERIDO] |
Essa operação preterida usa a API de Ingressos do LiveChat desativada. |
| Obter tíquete (preterido) [PRETERIDO] |
Essa operação preterida usa a API de Ingressos do LiveChat desativada. |
| Remover um agente (preterido) [PRETERIDO] |
Essa operação preterida remove um agente usando a API do LiveChat v2. Em vez disso, use Remover um agente (V2). |
| Remover um agente (V2) |
Remove um agente usando a API do LiveChat v3.6. A remoção de outro agente requer os escopos de todos:rw e de todos os agentes. |
Agentes de lista (preteridos) [PRETERIDOS]
Essa operação preterida retorna agentes usando a API do LiveChat v2. Em vez disso, use agentes de lista (V2).
Retornos
Lista de todos os agentes com seus detalhes.
- Itens
- ListAgents_Response
Atualizar tíquete (preterido) [PRETERIDO]
Essa operação preterida usa a API de Ingressos do LiveChat desativada.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do tíquete
|
ticketId | True | string |
A ID do tíquete |
|
Message
|
message | string | ||
|
Email do solicitante
|
True | string | ||
|
Nome do solicitante
|
name | string | ||
|
Assunto
|
subject | string | ||
|
ID do atribuídor
|
id | string |
Escolha um atribuídor. |
|
|
Tipo de Fonte
|
type | string |
Escolha uma origem. |
|
|
URL de origem
|
url | string |
Se o tipo de origem for uma janela de chat. |
Retornos
- Corpo
- TicketResponse
Criar um novo agente (preterido) [PRETERIDO]
Essa operação preterida cria um agente usando a API do LiveChat v2. Em vez disso, use Criar um novo agente (V2).
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Email
|
login | True | string | |
|
Nome
|
name | True | string | |
|
Status de logon
|
login_status | string | ||
|
Title
|
job_title | string |
O padrão é: Agente de Suporte. |
|
|
Permissão
|
permission | string | ||
|
Senha
|
password | string |
Comprimento mínimo 5. |
|
|
Contagens máximas de chat
|
max_chats_count | string |
Limite dos chats simultâneos. |
Retornos
- Corpo
- CreateAgent_Response
Criar um novo agente (V2)
Cria um agente usando a API do LiveChat v3.6. O agente pode exigir aprovação dependendo dos escopos do Token de Acesso Pessoal e da assinatura do LiveChat.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Agente
|
id | True | string |
A ID do agente, geralmente o endereço de email do agente. |
|
Nome
|
name | True | string |
O nome do agente. |
|
Função
|
role | string |
A criação de uma função maior que o normal requer o escopo accounts.roles.lc--all:rw. |
|
|
Status de logon
|
login_status | string | ||
|
Cargo
|
job_title | string | ||
|
Mobile
|
mobile | string | ||
|
Contagem máxima de chat
|
max_chats_count | integer | ||
|
Aguardando aprovação
|
awaiting_approval | boolean |
Definir isso como false requer o escopo private subscription.lc:rw. |
|
|
ID do grupo
|
id | True | integer | |
|
Prioridade
|
priority | True | string | |
|
Notifications
|
notifications | array of string | ||
|
Assinaturas de email
|
email_subscriptions | array of string | ||
|
Fuso horário
|
timezone | string |
O fuso horário usado pela agenda de trabalho. |
|
|
Dia
|
day | True | string | |
|
Habilitado
|
enabled | True | boolean | |
|
Start
|
start | True | string | |
|
participante
|
end | True | string |
Criar um novo tíquete (preterido) [PRETERIDO]
Essa operação preterida usa a API de Ingressos do LiveChat desativada.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Message
|
message | True | string | |
|
Email do solicitante
|
True | string | ||
|
Nome do solicitante
|
name | string | ||
|
Assunto
|
subject | string | ||
|
ID do atribuídor
|
id | string | ||
|
Tipo de Fonte
|
type | string |
Escolher uma origem |
|
|
URL de origem
|
url | string |
Se o tipo de origem for uma janela de chat. |
Retornos
- Corpo
- TicketResponse
Listar agentes (V2)
Retorna todos os agentes na licença do LiveChat usando a API do LiveChat v3.6. O Token de Acesso Pessoal requer os agentes– escopo all:ro.
Retornos
Os agentes na licença do LiveChat.
- Itens
- ListAgentsV2_Response
Listar tíquetes (preteridos) [PRETERIDO]
Essa operação preterida usa a API de Ingressos do LiveChat desativada.
Retornos
- Itens
- ListTicketsResponse
Obter tíquete (preterido) [PRETERIDO]
Essa operação preterida usa a API de Ingressos do LiveChat desativada.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do tíquete
|
ticketId | True | string |
A ID do tíquete |
Retornos
- Corpo
- TicketResponse
Remover um agente (preterido) [PRETERIDO]
Essa operação preterida remove um agente usando a API do LiveChat v2. Em vez disso, use Remover um agente (V2).
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Email
|
login | True | string |
O email do agente. |
Retornos
- Corpo
- DeleteAgent_Response
Remover um agente (V2)
Remove um agente usando a API do LiveChat v3.6. A remoção de outro agente requer os escopos de todos:rw e de todos os agentes.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Agente
|
id | True | string |
A ID do agente a ser removida. |
Gatilhos
| Quando um chat termina (preterido) [PRETERIDO] |
Esta operação preterida usa a API do LiveChat v2. |
| Quando um chat é iniciado (preterido) [PRETERIDO] |
Esta operação preterida usa a API do LiveChat v2. |
| Quando um tíquete é criado (preterido) [PRETERIDO] |
Essa operação preterida usa a API de Ingressos do LiveChat desativada. |
Quando um chat termina (preterido) [PRETERIDO]
Quando um chat é iniciado (preterido) [PRETERIDO]
Quando um tíquete é criado (preterido) [PRETERIDO]
Essa operação preterida usa a API de Ingressos do LiveChat desativada.
Retornos
- Corpo
- WebhookTicketResponse
Definições
WebhookChatResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
agentes
|
chat.agents | array of object |
agentes |
|
Email do agente
|
chat.agents.login | string |
Endereço de email do agente. |
|
Nome do agente
|
chat.agents.name | string |
Nome do agente. |
|
Carimbo de data/hora encerrado
|
chat.ended_timestamp | string |
yyyyy-MM-ddTHH:mm:ss.fffZ |
|
events
|
chat.events | array of object |
Matriz de eventos. |
|
Texto do evento
|
chat.events.text | string |
Mensagem associada ao evento. |
|
Date-Time de evento
|
chat.events.timestamp | string |
yyyyy-MM-ddTHH:mm:ss.fffZ |
|
Tipo de evento
|
chat.events.type | string |
Tipo de evento. |
|
Tipo de usuário de evento
|
chat.events.user_type | string |
Tipo de usuário. |
|
groups
|
chat.groups | array of integer | |
|
ID do grupo
|
chat.id | string |
Identificador exclusivo do grupo. |
|
Message
|
chat.messages | array of object |
Matriz de mensagens. |
|
ID do agente
|
chat.messages.agent_id | string |
ID exclusiva do agente associado à mensagem. |
|
Nome do autor
|
chat.messages.author_name | string |
Nome do autor da mensagem.. |
|
Texto
|
chat.messages.text | string |
Corpo da mensagem. |
|
Enviado Date-Time
|
chat.messages.timestamp | string |
yyyyy-MM-ddTHH:mm:ss.fffZ |
|
Tipo de usuário
|
chat.messages.user_type | string |
Tipo do usuário que está enviando a mensagem. |
|
Iniciado Date-Time
|
chat.started_timestamp | string |
yyyyy-MM-ddTHH:mm:ss.fffZ |
|
tags
|
chat.tags | array of string | |
|
URL
|
chat.url | string |
URL do site em que o chat começou. |
|
ID do Evento
|
event_unique_id | string |
ID exclusiva do evento associado ao chat. |
|
Pesquisa pré-chat
|
pre_chat_survey | array of object |
Matriz de respostas de pesquisa pré-chat. |
|
Resposta
|
pre_chat_survey.answer | string |
Resposta da pesquisa. |
|
ID da pesquisa
|
pre_chat_survey.id | string |
ID da pesquisa pré-chat. |
|
Pergunta
|
pre_chat_survey.label | string |
Pergunta da pesquisa. |
|
Email
|
visitor.email | string |
Endereço de email do visitante. |
|
ID
|
visitor.id | string |
ID exclusiva do visitante. |
|
Linguagem
|
visitor.language | string |
Idioma associado à conta do visitante. |
|
Nome
|
visitor.name | string |
Nome do visitante. |
|
Página
|
visitor.page_current | string |
Página da Web da qual o chat se originou. |
WebhookTicketResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
ticket.assignee.id | string |
Identificador exclusivo do usuário. |
|
Nome
|
ticket.assignee.name | string |
Nome do atribuídor. |
|
events
|
ticket.events | array of object | |
|
ID
|
ticket.events.author.id | string |
ID exclusiva do usuário. |
|
Nome
|
ticket.events.author.name | string |
Nome do autor. |
|
Tipo
|
ticket.events.author.type | string |
Agente ou cliente. |
|
Date-Time de evento
|
ticket.events.date | date-time |
yyyyy-MM-ddTHH:mm:ss.fffZ |
|
É privado
|
ticket.events.is_private | boolean |
True se o evento for privado. |
|
Message
|
ticket.events.message | string |
Descrição do evento. |
|
Tipo
|
ticket.events.source.type | string |
Janela de chat, email ou lc2. |
|
URL
|
ticket.events.source.url | string |
URL do site da qual o tíquete foi enviado. |
|
Tipo de evento
|
ticket.events.type | string |
Tipo de evento que gerou o tíquete. |
|
Grupo
|
ticket.groups | array of object |
Detalhes do grupo associado. |
|
ID
|
ticket.groups.id | integer |
ID exclusiva do grupo. |
|
Nome
|
ticket.groups.name | string |
Nome do grupo. |
|
ID do tíquete
|
ticket.id | string |
ID exclusiva do tíquete. |
|
IP
|
ticket.requester.ip | string |
Endereço IP do solicitante. |
|
Email
|
ticket.requester.mail | string |
Endereço de email do solicitante. |
|
Nome
|
ticket.requester.name | string |
Nome do solicitante. |
|
ID
|
ticket.source.id | string |
ID exclusiva da origem. |
|
Tipo
|
ticket.source.type | string |
Lc2, email, facebook, agent-app-manual ou chat-window. |
|
URL
|
ticket.source.url | string |
URL do site em que o tíquete foi criado. |
|
Situação
|
ticket.status | string |
Abrir, pendente, resolvido ou spam. |
|
Assunto
|
ticket.subject | string |
Breve descrição do tíquete. |
|
tags
|
ticket.tags | array of string |
ListTicketsResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Criado Date-Time
|
date | date-time |
yyyyy-MM-ddTHH:mm:ss.fffZ |
|
ID do tíquete
|
id | string |
Identificador exclusivo do tíquete. |
|
Date-Time modificado
|
modified | date-time |
yyyyy-MM-ddTHH:mm:ss.fffZ |
|
IP
|
requester.ip | string |
Endereço IP do solicitante. |
|
Email
|
requester.mail | string |
Endereço de email do solicitante. |
|
Nome
|
requester.name | string |
Nome completo do solicitante. |
|
ID
|
source.id | string |
Identificador exclusivo da origem. |
|
Tipo
|
source.type | string |
De chat, email ou lc2. |
|
URL
|
source.url | string |
Página da Web em que o tíquete foi criado. |
|
Situação
|
status | string |
Abrir, pendente, resolvido ou spam. |
|
Assunto
|
subject | string |
Descrição da origem do tíquete. |
TicketResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
currentGroup.id | integer |
ID exclusiva do grupo. |
|
Nome
|
currentGroup.name | string |
Nome do grupo. |
|
Criado Date-Time
|
date | date-time |
yyyyy-MM-ddTHH:mm:ss.fffZ |
|
events
|
events | array of object | |
|
ID
|
events.author.id | string |
ID exclusiva do usuário. |
|
Nome
|
events.author.name | string |
Nome do autor. |
|
Tipo
|
events.author.type | string |
Agente ou cliente. |
|
Date-Time de evento
|
events.date | date-time |
yyyyy-MM-ddTHH:mm:ss.fffZ |
|
É privado
|
events.is_private | boolean |
True se o evento for privado. |
|
Message
|
events.message | string |
Descrição do evento. |
|
Tipo
|
events.source.type | string |
Janela de chat, email ou lc2. |
|
URL
|
events.source.url | string |
URL do site da qual o tíquete foi enviado. |
|
Tipo de evento
|
events.type | string |
Tipo de evento que gerou o tíquete. |
|
Grupo
|
groups | array of object |
Detalhes do grupo associado. |
|
ID
|
groups.id | integer |
ID exclusiva do grupo. |
|
Nome
|
groups.name | string |
Nome do grupo. |
|
ID do tíquete
|
id | string |
ID exclusiva do tíquete. |
|
IP
|
requester.ip | string |
Endereço IP do solicitante. |
|
Email
|
requester.mail | string |
Endereço de email do solicitante. |
|
Nome
|
requester.name | string |
Nome do solicitante. |
|
ID
|
source.id | string |
ID exclusiva da origem. |
|
Tipo
|
source.type | string |
Lc2, email, facebook, agent-app-manual ou chat-window. |
|
URL
|
source.url | string |
URL do site em que o tíquete foi criado. |
|
Situação
|
status | string |
Abrir, pendente, resolvido ou spam. |
|
Assunto
|
subject | string |
Breve descrição do tíquete. |
|
tags
|
tags | array of string |
ListAgentsV2_Response
Os agentes na licença do LiveChat.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Itens
|
AgentV2 |
AgentV2
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID do Agente
|
id | string |
A ID do agente, geralmente o endereço de email do agente. |
|
Nome
|
name | string |
O nome do agente. |
|
Avatar
|
avatar | string |
A URL do avatar do agente. |
|
Função
|
role | string |
A função de agente. |
|
Status de logon
|
login_status | string |
O status de logon do agente. |
|
Cargo
|
job_title | string |
O cargo de agente. |
|
Mobile
|
mobile | string |
O número do celular do agente. |
|
Contagem máxima de chat
|
max_chats_count | integer |
O número máximo de chats simultâneos. |
|
Suspenso
|
suspended | boolean |
Se o agente está suspenso. |
|
Aguardando aprovação
|
awaiting_approval | boolean |
Se o agente está aguardando aprovação. |
|
groups
|
groups | array of AgentGroupV2 |
Os grupos atribuídos ao agente. |
AgentGroupV2
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID do grupo
|
id | integer | |
|
Prioridade
|
priority | string |
ListAgents_Response
Lista de todos os agentes com seus detalhes.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Avatar
|
avatar | string |
Caminho para a imagem na Amazon s3. |
|
Email de logon
|
login | string |
O endereço de email do agente. |
|
Nome
|
name | string |
O nome do agente. |
|
Permissão
|
permission | string |
Proprietário, administrador ou normal. |
CreateAgent_Response
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Avatar
|
avatar | string |
Caminho para a imagem na Amazon s3. |
|
Matriz de Grupos
|
groups | array of object |
Lista de todos os grupos dos qual o agente faz parte. |
|
ID do grupo
|
groups.id | integer |
ID exclusiva do grupo. |
|
Nome de Grupo
|
groups.name | string |
Nome do grupo. |
|
Cargo
|
job_title | string |
Suporte ao agente por padrão. |
|
Email
|
login | string |
O endereço de email do agente. |
|
Status de logon
|
login_status | string |
Aceitando chats ou não aceitando chats. |
|
Contagens máximas de chat
|
max_chats_count | integer |
Limite dos chats simultâneos. |
|
Nome
|
name | string |
O nome do agente. |
|
Permissão
|
permission | string |
Proprietário, administrador ou normal |
|
Situação
|
status | string |
Aceitando chats, não aceitando chats ou offline. |