Bate-papo ao vivo
O LiveChat é um software de atendimento ao cliente on-line com suporte ao vivo, software de help desk e recursos de análise da web.
Este conector está disponível nos seguintes produtos e regiões:
| Serviço | Class | Regiões |
|---|---|---|
| Estúdio Copiloto | Premium | Todas as regiões do Power Automatic , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Aplicações Lógicas | Standard | Todas as regiões do Logic Apps , exceto as seguintes: - Regiões do Azure Government - Regiões do Azure China - Departamento de Defesa dos EUA (DoD) |
| Aplicações Power | Premium | Todas as regiões do Power Apps , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Automatize o poder | Premium | Todas as regiões do Power Automatic , exceto as seguintes: - Governo dos EUA (CCG) - 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 | |
|---|---|
| Editora | Microsoft |
| Sítio Web | https://www.livechat.com/ |
| Política de privacidade | https://www.livechat.com/legal/privacy-policy/ |
| Categorias | Comunicação |
A criar uma ligação
O conector suporta os seguintes tipos de autenticação:
| Predefinição | 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.
Esta conexão não é compartilhável. Se o aplicativo avançado for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.
| Nome | Tipo | Description | Obrigatório |
|---|---|---|---|
| ID de Entidade Legado (obsoleto) | cadeia (de caracteres) | O ID da Entidade (endereço de email) é usado apenas pelas operações obsoletas da API LiveChat v2. | |
| ID da conta | cadeia (de caracteres) | O ID da Conta (GUID) é mostrado na página de Tokens de Acesso Pessoal do LiveChat. Novas operações de conector (V2) utilizam este valor com a API LiveChat v3.6. | Verdade |
| Token de acesso pessoal | securestring | O Token de Acesso Pessoal completo, não codificado, para esta conta. | Verdade |
Limites de Limitação
| Name | Chamadas | Período de Renovação |
|---|---|---|
| Chamadas de API por conexão | 100 | 60 segundos |
Ações
| Agentes de lista (obsoleto) [OBSOLETO] |
Esta operação obsoleta devolve agentes usando a API LiveChat v2. Use agentes de listas (V2) em vez disso. |
| Agentes de lista (V2) |
Devolve todos os agentes na licença LiveChat usando a API LiveChat v3.6. O Personal Access Token requer o âmbito dos agentes--all:ro. |
| Criar um novo agente (preterido) [PRETERIDO] |
Esta operação obsoleta cria um agente usando a API LiveChat v2. Use Criar um novo agente (V2) em vez disso. |
| Criar um novo agente (V2) |
Cria um agente usando a API do LiveChat v3.6. O agente pode necessitar de aprovação dependendo dos escopos do Personal Access Token e da subscrição do LiveChat. |
| Criar um novo ticket (obsoleto) [OBSOLETO] |
Esta operação obsoleta utiliza a API de Tickets do LiveChat desativada. |
| Get ticket (obsoleto) [OBSOLETO] |
Esta operação obsoleta utiliza a API de Tickets do LiveChat desativada. |
| Listar bilhetes (obsoletos) [OBSOLETOS] |
Esta operação obsoleta utiliza a API de Tickets do LiveChat desativada. |
| Remover um agente (obsoleto) [OBSOLETO] |
Esta operação obsoleta remove um agente que utiliza a API LiveChat v2. Use Remover um agente (V2) em vez disso. |
| Remover um agente (V2) |
Remove um agente usando a API do LiveChat v3.6. Remover outro agente requer os escopos dos agentes—all:rw e accounts—all:rw. |
| Ticket de atualização (obsoleto) [OBSOLETO] |
Esta operação obsoleta utiliza a API de Tickets do LiveChat desativada. |
Agentes de lista (obsoleto) [OBSOLETO]
Esta operação obsoleta devolve agentes usando a API LiveChat v2. Use agentes de listas (V2) em vez disso.
Devoluções
Lista de todos os agentes com seus detalhes.
- Itens
- ListAgents_Response
Agentes de lista (V2)
Devolve todos os agentes na licença LiveChat usando a API LiveChat v3.6. O Personal Access Token requer o âmbito dos agentes--all:ro.
Devoluções
Os agentes na licença do LiveChat.
- Itens
- ListAgentsV2_Response
Criar um novo agente (preterido) [PRETERIDO]
Esta operação obsoleta cria um agente usando a API LiveChat v2. Use Criar um novo agente (V2) em vez disso.
Parâmetros
| Name | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
Email
|
login | True | string | |
|
Nome
|
name | True | string | |
|
Estado de início de sessão
|
login_status | string | ||
|
Title
|
job_title | string |
O padrão é: Agente de suporte. |
|
|
Permissão
|
permission | string | ||
|
Palavra-passe
|
password | string |
Comprimento mínimo 5. |
|
|
Contagem máxima de bate-papo
|
max_chats_count | string |
Limite dos chats simultâneos. |
Devoluções
- Body
- CreateAgent_Response
Criar um novo agente (V2)
Cria um agente usando a API do LiveChat v3.6. O agente pode necessitar de aprovação dependendo dos escopos do Personal Access Token e da subscrição do LiveChat.
Parâmetros
| Name | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
ID do Agente
|
id | True | string |
O ID do agente, normalmente o endereço de email do agente. |
|
Nome
|
name | True | string |
O nome do agente. |
|
Função
|
role | string |
Criar um cargo acima do normal requer o âmbito accounts.roles.lc--all:rw. |
|
|
Estado de início de sessão
|
login_status | string | ||
|
Cargo
|
job_title | string | ||
|
Mobile
|
mobile | string | ||
|
Número máximo de conversas
|
max_chats_count | integer | ||
|
Aguardando aprovação
|
awaiting_approval | boolean |
Definir isto como falso requer o âmbito private subscription.lc:rw. |
|
|
ID do grupo
|
id | True | integer | |
|
Priority
|
priority | True | string | |
|
Notifications
|
notifications | array of string | ||
|
Assinaturas de e-mail
|
email_subscriptions | array of string | ||
|
Fuso horário
|
timezone | string |
O fuso horário utilizado pelo horário de trabalho. |
|
|
Dia
|
day | True | string | |
|
Enabled
|
enabled | True | boolean | |
|
Start
|
start | True | string | |
|
Fim
|
end | True | string |
Criar um novo ticket (obsoleto) [OBSOLETO]
Esta operação obsoleta utiliza a API de Tickets do LiveChat desativada.
Parâmetros
| Name | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
Message
|
message | True | string | |
|
E-mail do solicitante
|
True | string | ||
|
Nome do Requerente
|
name | string | ||
|
Assunto
|
subject | string | ||
|
Identificação do cessionário
|
id | string | ||
|
Tipo de fonte
|
type | string |
Escolha uma fonte |
|
|
URL de origem
|
url | string |
Se o tipo de origem for janela de chat. |
Devoluções
- Body
- TicketResponse
Get ticket (obsoleto) [OBSOLETO]
Esta operação obsoleta utiliza a API de Tickets do LiveChat desativada.
Parâmetros
| Name | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
ID do bilhete
|
ticketId | True | string |
O ID do bilhete |
Devoluções
- Body
- TicketResponse
Listar bilhetes (obsoletos) [OBSOLETOS]
Esta operação obsoleta utiliza a API de Tickets do LiveChat desativada.
Devoluções
- Itens
- ListTicketsResponse
Remover um agente (obsoleto) [OBSOLETO]
Esta operação obsoleta remove um agente que utiliza a API LiveChat v2. Use Remover um agente (V2) em vez disso.
Parâmetros
| Name | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
Email
|
login | True | string |
O e-mail do agente. |
Devoluções
- Body
- DeleteAgent_Response
Remover um agente (V2)
Remove um agente usando a API do LiveChat v3.6. Remover outro agente requer os escopos dos agentes—all:rw e accounts—all:rw.
Parâmetros
| Name | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
ID do Agente
|
id | True | string |
A identificação do agente a remover. |
Ticket de atualização (obsoleto) [OBSOLETO]
Esta operação obsoleta utiliza a API de Tickets do LiveChat desativada.
Parâmetros
| Name | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
ID do bilhete
|
ticketId | True | string |
O ID do bilhete |
|
Message
|
message | string | ||
|
E-mail do solicitante
|
True | string | ||
|
Nome do Requerente
|
name | string | ||
|
Assunto
|
subject | string | ||
|
Identificação do cessionário
|
id | string |
Escolha um cessionário. |
|
|
Tipo de fonte
|
type | string |
Escolha uma fonte. |
|
|
URL de origem
|
url | string |
Se o tipo de origem for janela de chat. |
Devoluções
- Body
- TicketResponse
Acionadores
| Quando um chat começa (obsoleto) [OBSOLETO] |
Esta operação obsoleta utiliza a API LiveChat v2. |
| Quando um chat termina (obsoleto) [DESCONTINUADO] |
Esta operação obsoleta utiliza a API LiveChat v2. |
| Quando um ticket é criado (obsoleto) [OBSOLETO] |
Esta operação obsoleta utiliza a API de Tickets do LiveChat desativada. |
Quando um chat começa (obsoleto) [OBSOLETO]
Quando um chat termina (obsoleto) [DESCONTINUADO]
Quando um ticket é criado (obsoleto) [OBSOLETO]
Esta operação obsoleta utiliza a API de Tickets do LiveChat desativada.
Devoluções
Definições
WebhookChatResponse
| Name | Caminho | Tipo | Descrição |
|---|---|---|---|
|
agents
|
chat.agents | array of object |
agents |
|
E-mail do agente
|
chat.agents.login | string |
Endereço de e-mail do agente. |
|
Nome do agente
|
chat.agents.name | string |
Nome do agente. |
|
Carimbo de data/hora encerrado
|
chat.ended_timestamp | string |
aaaa-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 do Evento
|
chat.events.timestamp | string |
aaaa-MM-ddTHH:mm:ss.fffZ |
|
Tipo de Evento
|
chat.events.type | string |
Tipo de evento. |
|
Tipo de usuário do evento
|
chat.events.user_type | string |
Tipo de utilizador. |
|
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 exclusivo 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 |
aaaa-MM-ddTHH:mm:ss.fffZ |
|
Tipo de Utilizador
|
chat.messages.user_type | string |
Tipo do usuário que envia a mensagem. |
|
Começou Date-Time
|
chat.started_timestamp | string |
aaaa-MM-ddTHH:mm:ss.fffZ |
|
tags
|
chat.tags | array of string | |
|
URL
|
chat.url | string |
URL do site onde o bate-papo começou. |
|
ID do Evento
|
event_unique_id | string |
ID exclusivo do evento associado ao chat. |
|
Pesquisa pré-bate-papo
|
pre_chat_survey | array of object |
Variedade de respostas da pesquisa pré-chat. |
|
Resposta
|
pre_chat_survey.answer | string |
Resposta ao inquérito. |
|
ID da pesquisa
|
pre_chat_survey.id | string |
ID da pesquisa pré-chat. |
|
Question
|
pre_chat_survey.label | string |
Pergunta do inquérito. |
|
Email
|
visitor.email | string |
Endereço de e-mail do visitante. |
|
Id
|
visitor.id | string |
ID único 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 bate-papo se originou. |
WebhookTicketResponse
| Name | Caminho | Tipo | Descrição |
|---|---|---|---|
|
Id
|
ticket.assignee.id | string |
Identificador exclusivo do usuário. |
|
Nome
|
ticket.assignee.name | string |
Nome do cessionário. |
|
events
|
ticket.events | array of object | |
|
Id
|
ticket.events.author.id | string |
ID exclusivo do usuário. |
|
Nome
|
ticket.events.author.name | string |
Nome do autor. |
|
Tipo
|
ticket.events.author.type | string |
Agente ou cliente. |
|
Date-Time do Evento
|
ticket.events.date | date-time |
aaaa-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, e-mail ou lc2. |
|
URL
|
ticket.events.source.url | string |
URL do site de onde o bilhete foi enviado. |
|
Tipo de Evento
|
ticket.events.type | string |
Tipo de evento que gerou o bilhete. |
|
Grupo
|
ticket.groups | array of object |
Detalhes do grupo associado. |
|
Id
|
ticket.groups.id | integer |
ID único do grupo. |
|
Nome
|
ticket.groups.name | string |
Nome do grupo. |
|
ID do bilhete
|
ticket.id | string |
Identificação única do bilhete. |
|
IP
|
ticket.requester.ip | string |
Endereço IP do requerente. |
|
Email
|
ticket.requester.mail | string |
Endereço de e-mail do solicitante. |
|
Nome
|
ticket.requester.name | string |
Nome do requerente. |
|
Id
|
ticket.source.id | string |
ID exclusivo da fonte. |
|
Tipo
|
ticket.source.type | string |
Lc2, mail, facebook, agent-app-manual ou chat-window. |
|
URL
|
ticket.source.url | string |
URL do site onde o ticket foi criado. |
|
Situação
|
ticket.status | string |
Aberto, pendente, resolvido ou spam. |
|
Assunto
|
ticket.subject | string |
Breve descrição do bilhete. |
|
tags
|
ticket.tags | array of string |
ListTicketsResponse
| Name | Caminho | Tipo | Descrição |
|---|---|---|---|
|
Criado Date-Time
|
date | date-time |
aaaa-MM-ddTHH:mm:ss.fffZ |
|
ID do bilhete
|
id | string |
Identificador único do bilhete. |
|
Modificado Date-Time
|
modified | date-time |
aaaa-MM-ddTHH:mm:ss.fffZ |
|
IP
|
requester.ip | string |
Endereço IP do requerente. |
|
Email
|
requester.mail | string |
Endereço de e-mail do solicitante. |
|
Nome
|
requester.name | string |
Nome completo do requerente. |
|
Id
|
source.id | string |
Identificador único da fonte. |
|
Tipo
|
source.type | string |
De chat, e-mail ou lc2. |
|
URL
|
source.url | string |
Página Web onde o bilhete foi criado. |
|
Situação
|
status | string |
Aberto, pendente, resolvido ou spam. |
|
Assunto
|
subject | string |
Descrição da fonte do bilhete. |
TicketResponse
| Name | Caminho | Tipo | Descrição |
|---|---|---|---|
|
Id
|
currentGroup.id | integer |
ID único do grupo. |
|
Nome
|
currentGroup.name | string |
Nome do grupo. |
|
Criado Date-Time
|
date | date-time |
aaaa-MM-ddTHH:mm:ss.fffZ |
|
events
|
events | array of object | |
|
Id
|
events.author.id | string |
ID exclusivo do usuário. |
|
Nome
|
events.author.name | string |
Nome do autor. |
|
Tipo
|
events.author.type | string |
Agente ou cliente. |
|
Date-Time do Evento
|
events.date | date-time |
aaaa-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, e-mail ou lc2. |
|
URL
|
events.source.url | string |
URL do site de onde o bilhete foi enviado. |
|
Tipo de Evento
|
events.type | string |
Tipo de evento que gerou o bilhete. |
|
Grupo
|
groups | array of object |
Detalhes do grupo associado. |
|
Id
|
groups.id | integer |
ID único do grupo. |
|
Nome
|
groups.name | string |
Nome do grupo. |
|
ID do bilhete
|
id | string |
Identificação única do bilhete. |
|
IP
|
requester.ip | string |
Endereço IP do requerente. |
|
Email
|
requester.mail | string |
Endereço de e-mail do solicitante. |
|
Nome
|
requester.name | string |
Nome do requerente. |
|
Id
|
source.id | string |
ID exclusivo da fonte. |
|
Tipo
|
source.type | string |
Lc2, mail, facebook, agent-app-manual ou chat-window. |
|
URL
|
source.url | string |
URL do site onde o ticket foi criado. |
|
Situação
|
status | string |
Aberto, pendente, resolvido ou spam. |
|
Assunto
|
subject | string |
Breve descrição do bilhete. |
|
tags
|
tags | array of string |
ListAgentsV2_Response
Os agentes na licença do LiveChat.
| Name | Caminho | Tipo | Descrição |
|---|---|---|---|
|
Itens
|
AgentV2 |
AgentV2
| Name | Caminho | Tipo | Descrição |
|---|---|---|---|
|
ID do Agente
|
id | string |
O ID do agente, normalmente 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 |
O papel de agente. |
|
Estado de início de sessão
|
login_status | string |
O estado do login do agente. |
|
Cargo
|
job_title | string |
O título do cargo de agente. |
|
Mobile
|
mobile | string |
O número de telemóvel do agente. |
|
Número máximo de conversas
|
max_chats_count | integer |
O número máximo de conversas simultâneas. |
|
Suspenso
|
suspended | boolean |
Se o agente está suspenso. |
|
Aguardando aprovação
|
awaiting_approval | boolean |
Se o agente está à espera de aprovação. |
|
groups
|
groups | array of AgentGroupV2 |
Os grupos atribuídos ao agente. |
AgentGroupV2
| Name | Caminho | Tipo | Descrição |
|---|---|---|---|
|
ID do grupo
|
id | integer | |
|
Priority
|
priority | string |
ListAgents_Response
Lista de todos os agentes com seus detalhes.
| Name | Caminho | Tipo | Descrição |
|---|---|---|---|
|
Avatar
|
avatar | string |
Caminho para a imagem no Amazon s3. |
|
E-mail de login
|
login | string |
O endereço de e-mail do agente. |
|
Nome
|
name | string |
Nome do agente. |
|
Permissão
|
permission | string |
Proprietário, administrador ou normal. |
CreateAgent_Response
| Name | Caminho | Tipo | Descrição |
|---|---|---|---|
|
Avatar
|
avatar | string |
Caminho para a imagem no Amazon s3. |
|
Matriz de grupos
|
groups | array of object |
Lista de todos os grupos dos quais o agente faz parte. |
|
ID do Grupo
|
groups.id | integer |
ID único do grupo. |
|
Nome do Grupo
|
groups.name | string |
Nome do grupo. |
|
Cargo
|
job_title | string |
Agente de suporte por padrão. |
|
Email
|
login | string |
O endereço de e-mail do agente. |
|
Estado de Login
|
login_status | string |
Aceitar chats ou não aceitar chats. |
|
Contagens máximas de bate-papo
|
max_chats_count | integer |
Limite dos chats simultâneos. |
|
Nome
|
name | string |
Nome do agente. |
|
Permissão
|
permission | string |
Proprietário, administrador ou normal |
|
Situação
|
status | string |
Aceitar chats, não aceitar chats ou offline. |