Partilhar via


Luware Nimbus

Conector para serviços licenciados de Contact Center e Enterprise Routing da Nimbus para conectar rapidamente a Nimbus a sistemas de terceiros. Ao ouvir e reagir a eventos de disparo, o conector pode acompanhar com ações de fluxo, por exemplo, para recuperar dados de sistemas externos e armazená-los em parâmetros Nimbus para uso posterior em seus fluxos de trabalho Nimbus.

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 Luware Helpdesk
URL https://helpdesk.luware.cloud/
Email nimbus.support@luware.com
Metadados do conector
Editora Luware
Sítio Web https://luware.com/
Política de Privacidade https://luware.com/en/privacy-policy/
Categorias Comunicação; Colaboração

O Luware Nimbus Connector permite a integração entre o Nimbus e o software de terceiros, como CRMs ou sistemas de emissão de bilhetes. Ele permite que você ouça os eventos de entrada de tarefas e agendadores que acontecem no Luware Nimbus. Você pode criar tarefas, enriquecer tarefas existentes com dados de informações do chamador, adicionar parâmetros de roteamento ou acionar um evento em seu sistema de terceiros 3rd. Além disso, você pode gerenciar catálogos de endereços, agendar chamadas de saída ou adicionar tarefas externas.

Alguns casos de uso são:

  • Mostrar detalhes de contato no Nimbus para uma chamada de entrada.
  • Persista a escolha do idioma da URA no Nimbus para um CRM.
  • Crie um item de trabalho pós-chamada após a chamada em um CRM.
  • Crie uma tarefa de retorno de chamada para uma chamada perdida em um CRM.
  • Crie uma chamada de saída Nimbus com base em uma campanha no CRM.
  • Encaminhe uma chamada de acordo com as preferências do cliente.
  • Mostrar as preferências do chamador para uma chamada de entrada.
  • Crie bilhetes num sistema de 3rd party.
  • Crie uma lista de chamadas perdidas em um sistema de terceiros 3rd.
  • Abra o registro do cliente quando um agente atender a chamada.

Por favor, encontre mais informações e muita ajuda na base de conhecimento da Luware: https://help.luware.com/nimbus-power-automate-connector

Pré-requisitos

  • Um plano Microsoft PowerApps ou PowerAutomate com nível "Premium"
  • Um locatário do Azure
  • Pelo menos um Luware Nimbus Service provisionado
  • Um papel no Luware Nimbus permitindo o uso do conector Luware Nimbus (https://help.luware.com/power-automate-roles)

Como estabelecer uma ligação segura

As APIs do Nimbus são protegidas por meio do Azure Ative Directory (AAD) / Microsoft Entra ID usando permissões delegadas. Como Administrador de Locatários, você precisa conceder essas permissões para o aplicativo "Luware Nimbus Login" para que o conector possa acessar o Luware Nimbus com segurança. Na maioria dos casos, essas permissões já foram concedidas durante a integração do Nimbus e não precisam ser reconfirmadas.

Após a conclusão desta etapa, você pode usar o conector estabelecendo uma conexão com clusters Nimbus. Certifique-se de escolher o mesmo local de cluster que sua instalação do Nimbus. Se você não tiver certeza sobre isso, faça login na Administração do Nimbus para verificar para qual cluster você será redirecionado.

Introdução ao conector

  1. Selecione o gatilho "Quando uma tarefa muda de estado" nos gatilhos Luware Nimbus.
  2. Configure seu serviço Nimbus no qual você deseja ouvir as chamadas recebidas.
  3. Selecione o Evento "Sistema aceito" (acionado quando a atividade "Aceitar conversa" no fluxo de trabalho é alcançada).
  4. Implemente a pesquisa das informações do chamador com base no Número de Telefone do Chamador, por exemplo, no seu CRM ou para fins de teste em uma Planilha do Excel hospedada no Sharepoint.
  5. Use a ação "Atualizar tarefa" para definir as informações do cliente como nome/sobrenome, endereço, cidade, país, etc. na tarefa.

Consulte nossa seção de casos de uso na base de conhecimento: https://help.luware.com/power-automate-use-cases

Problemas conhecidos e limitações

  • Perder permissões (RBAC) no Luware Nimbus desativará gatilhos na automação de energia sem informações transparentes para o usuário final. Os fluxos simplesmente não serão mais acionados.
  • Luware não tem influência no tempo de execução dos fluxos, então os resultados podem chegar de volta ao Nimbus com um atraso. Fluxos de trabalho dependendo da conclusão do fluxo devem ser construídos tendo em mente essa limitação.

Erros e soluções comuns

Código de erro HTTP:

  • 400: A solicitação que você enviou para a API Luware Nimbus não contém parâmetros válidos ou eles não podem ser aplicados. Exemplos: Todos os usuários preferenciais passados são inválidos, portanto, os usuários preferenciais não estão definidos OU Você tenta excluir uma Tarefa Externa quando ela já está atribuída a um usuário.
  • 401: O token de autenticação fornecido não pode ser analisado ou é inválido. Verifique a configuração correta do registro do aplicativo Azure AD / Entra ID e se você forneceu as credenciais corretas para sua Conta do O365.
  • 403: Sua conta não tem as permissões necessárias no Nimbus para executar a ação configurada em seu fluxo. Consulte a Base de Dados de Conhecimento e entre em contato com o administrador caso precise de funções/direitos adicionais.
  • 404: O(s) identificador(es) passado(s) não pode(m) ser correspondido(s) a nenhuma entidade no back-end.

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
Localização cadeia (de caracteres) A localização em que o seu inquilino está localizado. Verdade

Limites de Limitação

Name Chamadas Período de Renovação
Chamadas de API por conexão 100 60 segundos

Ações

Adicionar um contacto a um livro de endereços

Adiciona um novo contato a um catálogo de endereços específico. O ExternalId é usado como referência em outras solicitações.

Adicionar uma nova tarefa externa

Adicionar uma nova tarefa externa

Agendar uma nova chamada de saída

Agende uma nova chamada de saída (entrada do agendador).

Agendar uma nova chamada de saída com fluxo de trabalho

Agende uma nova chamada de saída com fluxo de trabalho (entrada do agendador).

Atualizar um contato em um catálogo de endereços

Atualiza um único contato no catálogo de endereços especificado.

Atualizar uma chamada de saída com a entrada do agendador de fluxo de trabalho

Altere as configurações de uma chamada de saída já criada com a entrada do agendador de fluxo de trabalho.

Atualizar uma entrada do agendador

Altere as configurações de uma entrada do agendador já criada.

Esvaziar um livro de endereços

Remova todos os contatos no catálogo de endereços especificado.

Obter contato(s) de um catálogo de endereços

Retorna contatos de um catálogo de endereços.

Obter dados do assistente de usuário virtual

Retorna dados do assistente de usuário virtual para a sessão de serviço selecionada.

Obter horário de funcionamento

Obter um horário de funcionamento do serviço: ele retorna o status do serviço (Aberto, Fechado, Feriado, etc.) em um determinado momento.

Obter todas as entradas do agendador

Retorna todas as entradas do agendador para o serviço especificado.

Remover contato(s) de um catálogo de endereços

Remova um ou vários contatos de um catálogo de endereços.

Remover uma entrada do agendador

Remova uma entrada do agendador do sistema. Só é possível, enquanto a entrada do agendador ainda não estiver em andamento.

Remover uma tarefa externa

Remover uma tarefa externa

Tarefa de atualização

Atualize as informações do cliente, o parâmetro de contexto e/ou as configurações preferidas do usuário para uma tarefa em andamento.

Adicionar um contacto a um livro de endereços

Adiciona um novo contato a um catálogo de endereços específico. O ExternalId é usado como referência em outras solicitações.

Parâmetros

Name Chave Necessário Tipo Description
Livro de endereços
AddressBook True string

O catálogo de endereços ao qual adicionar o contato.

ID Externo de Contato
externalId True string

ID do contacto fornecido pelo sistema externo.

Nome próprio do contato
firstName string

Nome próprio do contacto.

Sobrenome de contato
lastName string

Apelido do contacto.

Nome de exibição do contato
displayName string

Nome para exibição do contato.

Iniciais de contato
initials string

Iniciais do contato.

Entre em contato com a empresa
company string

Empresa do contacto.

Departamento de Contacto
department string

Departamento do contato.

Contato Job Title
jobTitle string

Cargo do contato.

Nome principal do usuário de contato
userPrincipalName string

Nome principal do usuário do contato.

Endereços de mensagens instantâneas de contato
imAddresses array of string

Lista de endereços de mensagens instantâneas.

Endereços de e-mail de contato
emailAddresses array of string

Lista de endereços de e-mail.

Entre em contato com telefones comerciais
businessPhones array of string

Lista de telefones comerciais.

Contacto Telemóveis
mobilePhones array of string

Lista de telemóveis.

Telefones domésticos de contato
homePhones array of string

Lista de telefones domésticos.

Endereço Street
street string

Rua e número do endereço.

Endereço Cidade
city string

Cidade do endereço.

Endereço País
country string

País do endereço.

Estado do endereço
state string

Estado do endereço.

Endereço Código Postal
postalCode string

Código postal do endereço.

Nome
name True string

Designação do campo personalizado.

Valor
value string

Valor do campo personalizado.

Devoluções

Adicionar uma nova tarefa externa

Adicionar uma nova tarefa externa

Parâmetros

Name Chave Necessário Tipo Description
Serviço UPN
serviceUpn True string

UPN do serviço.

Identificador do cliente
customerIdentifier string

Identificador de relatório exclusivo opcional, anônimo quando vazio.

Nome do Cliente
firstName string

Nome próprio do cliente.

Apelido do Cliente
lastName string

Apelido do cliente.

Nome de exibição do cliente
displayName string

Nome para exibição do cliente.

Empresa Cliente
company string

Empresa do cliente.

Cargo do Cliente
jobTitle string

Cargo do cliente.

Departamento de Clientes
department string

Departamento do cliente.

Endereço do cliente
streetAddress string

Endereço do cliente.

Código postal do cliente
postCode string

Código postal do cliente.

Localidade do Cliente
city string

Cidade do cliente.

Estado do Cliente
state string

Estado do cliente.

País do Cliente
country string

País do cliente.

Número de telefone principal do cliente
primaryTelNumber string

Número de telefone principal do cliente.

Nome
name True string

Designação do número de telefone.

Valor
value string

Valor do número de telefone.

Cliente UPN
UPN string

UPN do cliente.

Endereço de IM do cliente
imAddress string

Endereço IM do cliente.

E-mail do cliente
email string

Email do cliente.

Nome
name True string

Designação do campo personalizado.

Valor
value string

Valor do campo personalizado.

Nome
name True string

Nome do parâmetro de contexto personalizado.

Valor
value string

Valor do parâmetro de contexto personalizado.

Prioridade de distribuição
distributionPriority string

Prioridade com a qual a tarefa deve ser tratada no Nimbus uma vez devida.

UPN
upn True string

O UPN do usuário preferido.

Priority
priority integer

A prioridade. 1 alta a 99 baixa.

Devoluções

Agendar uma nova chamada de saída

Agende uma nova chamada de saída (entrada do agendador).

Parâmetros

Name Chave Necessário Tipo Description
ID de Referência
ReferenceId string

O ID para referência passado pelo sistema de terceiros.

Destino
destination True string

Destino das entradas do agendador com a direção "Outbound".

Prioridade de distribuição
distributionPriority string

Prioridade com a qual a tarefa deve ser tratada no Nimbus.

Data de Vencimento Hora (UTC)
dueDateTimeUtc True date-time

Data e hora de vencimento em UTC: Exemplo: '2020-03-23T11:00:00Z'.

Serviço UPN
serviceUpn True string

UPN do serviço.

Máximo de tentativas
maxAttempts integer

Máximo de tentativas para chegar ao destino.

Tempo limite de tentativa em segundos
attemptTimeoutInSeconds integer

Tempo limite (intervalos) entre novas tentativas de conexão até que o número máximo de tentativas seja atingido.

Tempo máximo de fila em segundos
maxQueueTimeInSeconds integer

Define quanto tempo o Nimbus tenta resolver a tarefa até que a tarefa seja considerada Limite Atingido.

Tempo limite de RONA em segundos
ronaTimeoutInSeconds integer

Define quanto tempo o Nimbus tenta alcançar o usuário até que a tarefa seja considerada RONA e um novo usuário seja selecionado.

Nome
name True string

Nome do parâmetro de contexto personalizado.

Valor
value string

Valor do parâmetro de contexto personalizado.

Nome do Cliente
firstName string

Nome próprio do cliente.

Apelido do Cliente
lastName string

Apelido do cliente.

Nome de exibição do cliente
displayName string

Nome para exibição do cliente.

Empresa Cliente
company string

Empresa do cliente.

Cargo do Cliente
jobTitle string

Cargo do cliente.

Departamento de Clientes
department string

Departamento do cliente.

Endereço do cliente
streetAddress string

Endereço do cliente.

Código postal do cliente
postCode string

Código postal do cliente.

Localidade do Cliente
city string

Cidade do cliente.

Estado do Cliente
state string

Estado do cliente.

País do Cliente
country string

País do cliente.

Número de telefone principal do cliente
primaryTelNumber string

Número de telefone principal do cliente.

Nome
name True string

Designação do número de telefone.

Valor
value string

Valor do número de telefone.

Cliente UPN
UPN string

UPN do cliente.

Endereço de IM do cliente
imAddress string

Endereço IM do cliente.

E-mail do cliente
email string

Email do cliente.

Nome
name True string

Designação do campo personalizado.

Valor
value string

Valor do campo personalizado.

Devoluções

Agendar uma nova chamada de saída com fluxo de trabalho

Agende uma nova chamada de saída com fluxo de trabalho (entrada do agendador).

Parâmetros

Name Chave Necessário Tipo Description
ID de Referência
ReferenceId string

O ID para referência passado pelo sistema de terceiros.

Destino
destination True string

Destino da chamada de saída com fluxo de trabalho.

Data de Vencimento Hora (UTC)
dueDateTimeUtc True date-time

Data e hora de vencimento em UTC: Exemplo: '2020-03-23T11:00:00Z'.

Serviço UPN
serviceUpn True string

UPN do serviço.

Máximo de tentativas
maxAttempts integer

Máximo de tentativas para chegar ao destino.

Tempo limite de tentativa em segundos
attemptTimeoutInSeconds integer

Define quanto tempo o Nimbus tenta chegar ao Destino antes que a tentativa seja interrompida.

Nome
name True string

Nome do parâmetro de contexto personalizado.

Valor
value string

Valor do parâmetro de contexto personalizado.

Nome do Cliente
firstName string

Nome próprio do cliente.

Apelido do Cliente
lastName string

Apelido do cliente.

Nome de exibição do cliente
displayName string

Nome para exibição do cliente.

Empresa Cliente
company string

Empresa do cliente.

Cargo do Cliente
jobTitle string

Cargo do cliente.

Departamento de Clientes
department string

Departamento do cliente.

Endereço do cliente
streetAddress string

Endereço do cliente.

Código postal do cliente
postCode string

Código postal do cliente.

Localidade do Cliente
city string

Cidade do cliente.

Estado do Cliente
state string

Estado do cliente.

País do Cliente
country string

País do cliente.

Número de telefone principal do cliente
primaryTelNumber string

Número de telefone principal do cliente.

Nome
name True string

Designação do número de telefone.

Valor
value string

Valor do número de telefone.

Cliente UPN
UPN string

UPN do cliente.

Endereço de IM do cliente
imAddress string

Endereço IM do cliente.

E-mail do cliente
email string

Email do cliente.

Nome
name True string

Designação do campo personalizado.

Valor
value string

Valor do campo personalizado.

Devoluções

Atualizar um contato em um catálogo de endereços

Atualiza um único contato no catálogo de endereços especificado.

Parâmetros

Name Chave Necessário Tipo Description
Livro de endereços
AddressBook True string

O catálogo de endereços para atualizar o contato.

ID Externo de Contato
externalId True string

ID do contacto fornecido pelo sistema externo.

Nome próprio do contato
firstName string

Nome próprio do contacto.

Sobrenome de contato
lastName string

Apelido do contacto.

Nome de exibição do contato
displayName string

Nome para exibição do contato.

Iniciais de contato
initials string

Iniciais do contato.

Entre em contato com a empresa
company string

Empresa do contacto.

Departamento de Contacto
department string

Departamento do contato.

Contato Job Title
jobTitle string

Cargo do contato.

Nome principal do usuário de contato
userPrincipalName string

Nome principal do usuário do contato.

Endereços de mensagens instantâneas de contato
imAddresses array of string

Lista de endereços de mensagens instantâneas.

Endereços de e-mail de contato
emailAddresses array of string

Lista de endereços de e-mail.

Entre em contato com telefones comerciais
businessPhones array of string

Lista de telefones comerciais.

Contacto Telemóveis
mobilePhones array of string

Lista de telemóveis.

Telefones domésticos de contato
homePhones array of string

Lista de telefones domésticos.

Endereço Street
street string

Rua e número do endereço.

Endereço Cidade
city string

Cidade do endereço.

Endereço País
country string

País do endereço.

Estado do endereço
state string

Estado do endereço.

Endereço Código Postal
postalCode string

Código postal do endereço.

Nome
name True string

Designação do campo personalizado.

Valor
value string

Valor do campo personalizado.

Devoluções

Atualizar uma chamada de saída com a entrada do agendador de fluxo de trabalho

Altere as configurações de uma chamada de saída já criada com a entrada do agendador de fluxo de trabalho.

Parâmetros

Name Chave Necessário Tipo Description
ID de entrada do agendador
SchedulerEntryID True string

ID da entrada do agendador a ser atualizada.

ID de Referência
ReferenceId string

O ID para referência passado pelo sistema de terceiros.

Destino
destination True string

Destino da chamada de saída com fluxo de trabalho.

Data de Vencimento Hora (UTC)
dueDateTimeUtc True date-time

Data e hora de vencimento em UTC: Exemplo: '2020-03-23T11:00:00Z'.

Serviço UPN
serviceUpn True string

UPN do serviço.

Máximo de tentativas
maxAttempts integer

Máximo de tentativas para chegar ao destino.

Tempo limite de tentativa em segundos
attemptTimeoutInSeconds integer

Define quanto tempo o Nimbus tenta chegar ao Destino antes que a tentativa seja interrompida.

Nome
name True string

Nome do parâmetro de contexto personalizado.

Valor
value string

Valor do parâmetro de contexto personalizado.

Nome do Cliente
firstName string

Nome próprio do cliente.

Apelido do Cliente
lastName string

Apelido do cliente.

Nome de exibição do cliente
displayName string

Nome para exibição do cliente.

Empresa Cliente
company string

Empresa do cliente.

Cargo do Cliente
jobTitle string

Cargo do cliente.

Departamento de Clientes
department string

Departamento do cliente.

Endereço do cliente
streetAddress string

Endereço do cliente.

Código postal do cliente
postCode string

Código postal do cliente.

Localidade do Cliente
city string

Cidade do cliente.

Estado do Cliente
state string

Estado do cliente.

País do Cliente
country string

País do cliente.

Número de telefone principal do cliente
primaryTelNumber string

Número de telefone principal do cliente.

Nome
name True string

Designação do número de telefone.

Valor
value string

Valor do número de telefone.

Cliente UPN
UPN string

UPN do cliente.

Endereço de IM do cliente
imAddress string

Endereço IM do cliente.

E-mail do cliente
email string

Email do cliente.

Nome
name True string

Designação do campo personalizado.

Valor
value string

Valor do campo personalizado.

Devoluções

Atualizar uma entrada do agendador

Altere as configurações de uma entrada do agendador já criada.

Parâmetros

Name Chave Necessário Tipo Description
ID de entrada do agendador
SchedulerEntryID True string

ID da entrada do agendador a ser atualizada.

ID de Referência
ReferenceId string

O ID para referência passado pelo sistema de terceiros.

Destino
destination True string

Destino das entradas do agendador com a direção "Outbound".

Prioridade de distribuição
distributionPriority string

Prioridade com a qual a tarefa deve ser tratada no Nimbus.

Data de Vencimento Hora (UTC)
dueDateTimeUtc True date-time

Data e hora de vencimento em UTC: Exemplo: '2020-03-23T11:00:00Z'.

Serviço UPN
serviceUpn True string

UPN do serviço.

Máximo de tentativas
maxAttempts integer

Máximo de tentativas para chegar ao destino.

Tempo limite de tentativa em segundos
attemptTimeoutInSeconds integer

Tempo limite (intervalos) entre novas tentativas de conexão até que o número máximo de tentativas seja atingido.

Tempo máximo de fila em segundos
maxQueueTimeInSeconds integer

Define quanto tempo o Nimbus tenta resolver a tarefa até que a tarefa seja considerada Limite Atingido.

Tempo limite de RONA em segundos
ronaTimeoutInSeconds integer

Define quanto tempo o Nimbus tenta alcançar o usuário até que a tarefa seja considerada RONA e um novo usuário seja selecionado.

Nome
name True string

Nome do parâmetro de contexto personalizado.

Valor
value string

Valor do parâmetro de contexto personalizado.

Nome do Cliente
firstName string

Nome próprio do cliente.

Apelido do Cliente
lastName string

Apelido do cliente.

Nome de exibição do cliente
displayName string

Nome para exibição do cliente.

Empresa Cliente
company string

Empresa do cliente.

Cargo do Cliente
jobTitle string

Cargo do cliente.

Departamento de Clientes
department string

Departamento do cliente.

Endereço do cliente
streetAddress string

Endereço do cliente.

Código postal do cliente
postCode string

Código postal do cliente.

Localidade do Cliente
city string

Cidade do cliente.

Estado do Cliente
state string

Estado do cliente.

País do Cliente
country string

País do cliente.

Número de telefone principal do cliente
primaryTelNumber string

Número de telefone principal do cliente.

Nome
name True string

Designação do número de telefone.

Valor
value string

Valor do número de telefone.

Cliente UPN
UPN string

UPN do cliente.

Endereço de IM do cliente
imAddress string

Endereço IM do cliente.

E-mail do cliente
email string

Email do cliente.

Nome
name True string

Designação do campo personalizado.

Valor
value string

Valor do campo personalizado.

Devoluções

Esvaziar um livro de endereços

Remova todos os contatos no catálogo de endereços especificado.

Parâmetros

Name Chave Necessário Tipo Description
Livro de endereços
AddressBook True string

O livro de endereços a esvaziar

Obter contato(s) de um catálogo de endereços

Retorna contatos de um catálogo de endereços.

Parâmetros

Name Chave Necessário Tipo Description
Livro de endereços
AddressBook True string

O catálogo de endereços para obter o(s) contato(s).

Identificação externa
externalIds array

IDs externos dos contatos a serem buscados. Opcional: Se nenhum for fornecido, todos os contatos serão retornados.

Devoluções

Os contatos retornados.

Obter dados do assistente de usuário virtual

Retorna dados do assistente de usuário virtual para a sessão de serviço selecionada.

Parâmetros

Name Chave Necessário Tipo Description
ID da Sessão de Serviço
serviceSessionId True string

ID da sessão de serviço para a qual os dados do assistente de usuário virtual devem ser retornados.

ID da sessão do usuário
userSessionId string

ID da sessão do usuário para a qual os dados do assistente de usuário virtual devem ser retornados.

Tipo de dados
dataType True string

Tipo de dados que devem ser retornados para a sessão de serviço.

Devoluções

As saídas desta operação são dinâmicas.

Obter horário de funcionamento

Obter um horário de funcionamento do serviço: ele retorna o status do serviço (Aberto, Fechado, Feriado, etc.) em um determinado momento.

Parâmetros

Name Chave Necessário Tipo Description
Serviço UPN
serviceUpn True string

UPN do serviço para o qual o status será verificado.

Data de Vencimento Hora (UTC)
time date-time

Data e hora de vencimento em UTC: Exemplo: '2020-03-23T11:00:00Z'.

Devoluções

O estado do serviço (Aberto, Fechado, etc.).

response
CalendarStatus

Obter todas as entradas do agendador

Retorna todas as entradas do agendador para o serviço especificado.

Parâmetros

Name Chave Necessário Tipo Description
Serviço UPN
serviceUpn True string

UPN do serviço para o qual as entradas do agendador devem ser devolvidas.

Devoluções

Lista de todas as tarefas agendadas para o serviço especificado

Remover contato(s) de um catálogo de endereços

Remova um ou vários contatos de um catálogo de endereços.

Parâmetros

Name Chave Necessário Tipo Description
Livro de endereços
AddressBook True string

O catálogo de endereços do qual remover o contato.

externalIds
externalIds True array of string

Remover uma entrada do agendador

Remova uma entrada do agendador do sistema. Só é possível, enquanto a entrada do agendador ainda não estiver em andamento.

Parâmetros

Name Chave Necessário Tipo Description
ID de entrada do agendador
SchedulerEntryID True string

ID da entrada do agendador a ser removida.

Remover uma tarefa externa

Remover uma tarefa externa

Parâmetros

Name Chave Necessário Tipo Description
ID da Tarefa Externa
externalTaskId True string

ID da Tarefa Externa que está sendo removida

Tarefa de atualização

Atualize as informações do cliente, o parâmetro de contexto e/ou as configurações preferidas do usuário para uma tarefa em andamento.

Parâmetros

Name Chave Necessário Tipo Description
ID da tarefa
taskId True string

O ID específico do Nimbus da tarefa.

Nome do Cliente
firstName string

Nome próprio do cliente.

Apelido do Cliente
lastName string

Apelido do cliente.

Nome de exibição do cliente
displayName string

Nome para exibição do cliente.

Empresa Cliente
company string

Empresa do cliente.

Cargo do Cliente
jobTitle string

Cargo do cliente.

Departamento de Clientes
department string

Departamento do cliente.

Endereço do cliente
streetAddress string

Endereço do cliente.

Código postal do cliente
postCode string

Código postal do cliente.

Localidade do Cliente
city string

Cidade do cliente.

Estado do Cliente
state string

Estado do cliente.

País do Cliente
country string

País do cliente.

Número de telefone principal do cliente
primaryTelNumber string

Número de telefone principal do cliente.

Nome
name True string

Designação do número de telefone.

Valor
value string

Valor do número de telefone.

Cliente UPN
UPN string

UPN do cliente.

Endereço de IM do cliente
imAddress string

Endereço IM do cliente.

E-mail do cliente
email string

Email do cliente.

Nome
name True string

Designação do campo personalizado.

Valor
value string

Valor do campo personalizado.

Nome
name True string

Nome do parâmetro de contexto personalizado.

Valor
value string

Valor do parâmetro de contexto personalizado.

UPN
upn True string

O UPN do usuário preferido.

Priority
priority integer

A prioridade. 1 alta a 99 baixa.

ID da Sessão de Serviço
serviceSessionId string

O ID da sessão de serviço.

ID da sessão do usuário
userSessionId string

O ID da sessão do usuário.

Acionadores

Quando o assistente de usuário virtual tem uma atualização

Esse evento é acionado quando o assistente de usuário virtual tem uma nova atualização.

Quando uma entrada do agendador muda de estado

Gerado sempre que uma entrada do agendador que corresponde aos critérios de filtro muda de estado.

Quando uma tarefa muda de estado

Gerado sempre que uma tarefa que corresponde aos critérios de filtro muda de estado.

Quando o assistente de usuário virtual tem uma atualização

Esse evento é acionado quando o assistente de usuário virtual tem uma nova atualização.

Parâmetros

Name Chave Necessário Tipo Description
Services
services True array of string

UPNs dos serviços, para os quais os eventos para as tarefas devem ser buscados.

Eventos do Virtual User Assistant
virtualUserAssistantEvents True array of string

Eventos do assistente virtual do usuário, para os quais esse gatilho deve ser acionado.

Devoluções

Quando uma entrada do agendador muda de estado

Gerado sempre que uma entrada do agendador que corresponde aos critérios de filtro muda de estado.

Parâmetros

Name Chave Necessário Tipo Description
Services
services True array of string

UPNs dos serviços, para os quais os eventos para as tarefas devem ser buscados.

Eventos de entrada do agendador
schedulerEntryEvents True array of string

Eventos da entrada do agendador, para os quais esse gatilho deve ser acionado.

Devoluções

Quando uma tarefa muda de estado

Gerado sempre que uma tarefa que corresponde aos critérios de filtro muda de estado.

Parâmetros

Name Chave Necessário Tipo Description
Services
services True array of string

UPNs dos serviços, para os quais os eventos para as tarefas devem ser buscados.

Eventos da Tarefa
taskEvents True array of string

Eventos das tarefas, para os quais este gatilho deve ser levantado.

Modalidades
modalities array of string

Especificar as modalidades iniciais das tarefas.

Instruções
directions array of string

Especifique as direções das tarefas.

Devoluções

Definições

TaskEventData

Name Caminho Tipo Description
ID da tarefa
taskId string

O ID específico do Nimbus da tarefa.

ID da Sessão de Serviço
serviceSessionId string

A ID da sessão de serviço

ID da sessão do usuário
userSessionId string

A ID da sessão do usuário

Sessão de usuário iniciada com transferência
userSessionStartedWithTransfer boolean

Indica se a sessão do usuário foi iniciada como resultado de uma transferência.

ID da cadeia de chamadas
callChainId string

O ID da cadeia de chamadas da Microsoft da tarefa.

Event
event string

O evento que ocorreu dentro do Nimbus para a tarefa.

Direction
direction string

Direção da tarefa em andamento no Nimbus (Inbound/Outbound/None).

Modality
modality string

Modalidade inicial da tarefa em Nimbus.

Criado
created string

Carimbo de data/hora, quando a tarefa tiver sido criada.

Terminado
terminated string

Carimbo de data/hora, quando a tarefa tiver sido encerrada.

Reason
reason string

Motivo da rescisão.

ID do último usuário conectado
lastConnectedUserId string

ID do objeto (AAD) do último usuário conectado da tarefa.

UPN do último usuário conectado
LastConnectedUserUPN string

UPN do último usuário conectado da tarefa.

E-mail do último usuário conectado
LastConnectedUserEmail string

E-mail do último usuário conectado da tarefa.

ID do chamador da Microsoft
microsoftCallerId string

ID do objeto (AAD) do chamador.

ID de Referência
referenceId string

O ID para referência passado pelo sistema de terceiros.

ID do chamador
callerId string

ID interno para o chamador no Nimbus. ID do objeto (AAD) se o chamador for conhecido.

Número de telefone do chamador
callerTelNumber string

Número de telefone (E.164) do autor da chamada. Defina apenas para tarefas com modality=Audio.

Chamador UPN
callerUPN string

UPN do cliente.

ID de destino da Microsoft
microsoftDestinationId string

ID do objeto (AAD) do destinatário em uma tarefa de saída.

ID de destino
destinationId string

ID interno do destino (Outbound) no Nimbus. ID do objeto (AAD) se o chamador for conhecido.

Número de telefone de destino
destinationTelNumber string

Número de telefone (E.164) do destino (Outbound).

UPN de destino
destinationUPN string

UPN do destino (Outbound).

ACS ID
acsId string

ID de Comunicação do Azure do chamador.

É anónimo
isAnonymous boolean

Sinalizador definido como true, quando o chamador é anônimo.

Identificador do cliente
customerIdentifier string

Identificador do cliente em todos os tipos de tarefas.

Mensagem Inicial
initialMessage string

Primeira mensagem ao cliente de mensagens instantâneas.

ID do serviço
serviceId string

ID interno do serviço Nimbus.

Nome do serviço
serviceName string

Nome do serviço Nimbus.

Descrição do Serviço
serviceDescription string

Descrição do serviço Nimbus (herdado do Microsoft Teams).

Nome de exibição do serviço
serviceDisplayName string

Nome de exibição do serviço Nimbus.

Serviço UPN
serviceUPN string

UPN do serviço Nimbus.

Número de Telefone de Serviço
serviceTelNumber string

Número de telefone (E.164) do serviço Nimbus.

Assunto do e-mail
emailSubject string

Assunto do e-mail.

Rich Text exclusivo do corpo do e-mail
emailBodyUniqueRichText string

Corpo do e-mail, rich text.

Corpo do e-mail Texto simples exclusivo
emailBodyUniquePlainText string

Corpo do e-mail, texto simples.

UPN da Caixa de Correio do Serviço de Email
emailServiceMailboxUPN string

UPN da caixa de correio atribuída ao serviço.

Tentativas de saída
outboundAttempt integer

Número de tentativas para chegar ao destino de saída.

Nome do parâmetro atualizado
updatedParameterName string

Nome do último parâmetro que foi atualizado.

Valor do parâmetro atualizado
updatedParameterValue string

Valor do último parâmetro que foi atualizado.

Informações sobre a tarefa
taskInformation TaskInformation

Contém informações sobre o cliente, parâmetro de contexto personalizado e usuários preferenciais.

TaskInformation

Contém informações sobre o cliente, parâmetro de contexto personalizado e usuários preferenciais.

Name Caminho Tipo Description
cliente
customer Customer

Objeto que contém todas as informações do cliente.

Parâmetros de contexto personalizados
customContextParameters array of CustomContextParameter

Lista de parâmetros de contexto personalizados (Key-Value).

Utilizadores Preferidos
preferredUsers array of PreferredUser

Lista de usuários preferidos para as tarefas (UPN-Priority).

Cliente

Objeto que contém todas as informações do cliente.

Name Caminho Tipo Description
Nome do Cliente
firstName string

Nome próprio do cliente.

Apelido do Cliente
lastName string

Apelido do cliente.

Nome de exibição do cliente
displayName string

Nome para exibição do cliente.

Empresa Cliente
company string

Empresa do cliente.

Cargo do Cliente
jobTitle string

Cargo do cliente.

Departamento de Clientes
department string

Departamento do cliente.

Endereço do cliente
streetAddress string

Endereço do cliente.

Código postal do cliente
postCode string

Código postal do cliente.

Localidade do Cliente
city string

Cidade do cliente.

Estado do Cliente
state string

Estado do cliente.

País do Cliente
country string

País do cliente.

Número de telefone principal do cliente
primaryTelNumber string

Número de telefone principal do cliente.

Números de telefone
telNumbers array of TelNumber

Lista de números de telefone adicionais do Cliente.

Cliente UPN
UPN string

UPN do cliente.

Endereço de IM do cliente
imAddress string

Endereço IM do cliente.

E-mail do cliente
email string

Email do cliente.

Campos personalizados
customFields array of CustomField

Lista de campos personalizados do cliente.

TelNumber

Name Caminho Tipo Description
Nome
name string

Designação do número de telefone.

Valor
value string

Valor do número de telefone.

Campo Personalizado

Name Caminho Tipo Description
Nome
name string

Designação do campo personalizado.

Valor
value string

Valor do campo personalizado.

CustomContextParameter

Name Caminho Tipo Description
Nome
name string

Nome do parâmetro de contexto personalizado.

Valor
value string

Valor do parâmetro de contexto personalizado.

PreferredUser

Name Caminho Tipo Description
UPN
upn string

O UPN do usuário preferido.

Priority
priority integer

A prioridade. 1 alta a 99 baixa.

ContactReadDto

Name Caminho Tipo Description
ID Externo de Contato
externalId string

ID do contacto fornecido pelo sistema externo.

Nome próprio do contato
firstName string

Nome próprio do contacto.

Sobrenome de contato
lastName string

Apelido do contacto.

Nome de exibição do contato
displayName string

Nome para exibição do contato.

Iniciais de contato
initials string

Iniciais do contato.

Entre em contato com a empresa
company string

Empresa do contacto.

Departamento de Contacto
department string

Departamento do contato.

Contato Job Title
jobTitle string

Cargo do contato.

Nome principal do usuário de contato
userPrincipalName string

Nome principal do usuário do contato.

Endereços de mensagens instantâneas de contato
imAddresses array of string

Lista de endereços de mensagens instantâneas.

Endereços de e-mail de contato
emailAddresses array of string

Lista de endereços de e-mail.

Entre em contato com telefones comerciais
businessPhones array of string

Lista de telefones comerciais.

Contacto Telemóveis
mobilePhones array of string

Lista de telemóveis.

Telefones domésticos de contato
homePhones array of string

Lista de telefones domésticos.

addresses
addresses array of Address

Lista de endereços.

customFields
customFields array of CustomField

Lista de campos personalizados do contato.

Address

Name Caminho Tipo Description
Endereço Street
street string

Rua e número do endereço.

Endereço Cidade
city string

Cidade do endereço.

Endereço País
country string

País do endereço.

Estado do endereço
state string

Estado do endereço.

Endereço Código Postal
postalCode string

Código postal do endereço.

SchedulerEntryEventData

Name Caminho Tipo Description
ID de entrada do agendador
schedulerEntryId string

O ID específico do Nimbus da entrada do agendador.

Tipo de Conversação
conversationType string

O tipo de conversa da entrada do agendador.

Event
event string

O evento que ocorreu dentro do Nimbus para a tarefa agendada.

Direction
direction string

Direção da tarefa em andamento no Nimbus (Inbound/Outbound/None).

Modality
modality string

Modalidade inicial da tarefa em Nimbus.

ID de Referência
ReferenceId string

O ID para referência passado pelo sistema de terceiros.

ID de Conversação Unificada
unifiedConversationId string

ID de conversação unificada.

Motivo da conclusão
completionReason string

Resultado da entrada do agendador quando terminado.

Destino
destination string

Destino das entradas do agendador com a direção "Outbound".

Prioridade de distribuição
distributionPriority string

Prioridade com a qual a tarefa deve ser tratada no Nimbus.

Data de Vencimento Hora (UTC)
dueDateTimeUtc date-time

Data e hora de vencimento em UTC: Exemplo: '2020-03-23T11:00:00Z'.

Serviço UPN
serviceUpn string

UPN do serviço para o qual a entrada está agendada.

Máximo de tentativas
maxAttempts integer

Máximo de tentativas para chegar ao destino.

Tempo limite de tentativa em segundos
attemptTimeoutInSeconds integer

Tempo limite (intervalos) entre novas tentativas de conexão até que o número máximo de tentativas seja atingido.

Tempo máximo de fila em segundos
maxQueueTimeInSeconds integer

Define quanto tempo o Nimbus tenta resolver a tarefa até que a tarefa seja considerada Limite Atingido.

Tempo limite de RONA em segundos
ronaTimeoutInSeconds integer

Define quanto tempo o Nimbus tenta alcançar o usuário até que a tarefa seja considerada RONA e um novo usuário seja selecionado.

Parâmetros de contexto personalizados
customCallContextParameters array of CustomContextParameter

Lista de parâmetros de contexto personalizados (Key-Value).

cliente
customer Customer

Objeto que contém todas as informações do cliente.

OutboundCallWithWorkflowSchedulerEntryEventData

Name Caminho Tipo Description
ID de entrada do agendador
schedulerEntryId string

O ID específico do Nimbus da entrada do agendador.

Tipo de Conversação
conversationType string

O tipo de conversa da entrada do agendador.

Event
event string

O evento que ocorreu dentro do Nimbus para a tarefa agendada.

Direction
direction string

Direção da tarefa em andamento no Nimbus (Inbound/Outbound/None).

Modality
modality string

Modalidade inicial da tarefa em Nimbus.

ID de Referência
ReferenceId string

O ID para referência passado pelo sistema de terceiros.

ID de Conversação Unificada
unifiedConversationId string

ID de conversação unificada.

Motivo da conclusão
completionReason string

Resultado da entrada do agendador quando terminado.

Destino
destination string

Destino das entradas do agendador com a direção "Outbound".

Prioridade de distribuição
distributionPriority string

Prioridade com a qual a tarefa deve ser tratada no Nimbus.

Data de Vencimento Hora (UTC)
dueDateTimeUtc date-time

Data e hora de vencimento em UTC: Exemplo: '2020-03-23T11:00:00Z'.

Serviço UPN
serviceUpn string

UPN do serviço para o qual a entrada está agendada.

Máximo de tentativas
maxAttempts integer

Máximo de tentativas para chegar ao destino.

Tempo limite de tentativa em segundos
attemptTimeoutInSeconds integer

Define quanto tempo o Nimbus tenta chegar ao Destino antes que a tentativa seja interrompida.

Parâmetros de contexto personalizados
customCallContextParameters array of CustomContextParameter

Lista de parâmetros de contexto personalizados (Key-Value).

cliente
customer Customer

Objeto que contém todas as informações do cliente.

VirtualUserAssistantEventData

Name Caminho Tipo Description
ID de sessão unificada
unifiedSessionId string

O ID da sessão unificada Nimbus relacionada.

ID da Sessão de Serviço
serviceSessionId string

O ID da sessão de serviço Nimbus relacionada.

ID da sessão do usuário
userSessionId string

O ID da sessão de usuário Nimbus relacionada.

Serviço UPN
serviceUpn string

UPN do serviço para o qual o evento ocorreu.

ID do serviço
serviceId string

ID do serviço para o qual o evento ocorreu.

Nome do serviço
serviceName string

Nome do serviço para o qual o evento ocorreu.

Event
event string

O evento de assistente de usuário virtual que ocorreu dentro do Nimbus.

Sessão de usuário iniciada com transferência
userSessionStartedWithTransfer boolean

Indica se a sessão do usuário foi iniciada como resultado de uma transferência.

ExternalTaskWriteResult

Name Caminho Tipo Description
ID de Tarefa Externa
id string

A ID da tarefa externa adicionada.

Modality
modality Modality

A modalidade da tarefa.

Criado
created string

Carimbo de data/hora, quando a tarefa externa tiver sido criada.

Tipo
type string

O tipo de tarefa externa.

É anónimo
isAnonymous boolean

Sinalizador definido como true, quando o chamador é anônimo.

ID do serviço
serviceId string

ID interno do serviço Nimbus.

Nome do serviço
serviceName string

Nome do serviço Nimbus.

Descrição do Serviço
serviceDescription string

Descrição do serviço Nimbus (herdado do Microsoft Teams).

Nome de exibição do serviço
serviceDisplayName string

O nome para exibição do serviço.

Serviço UPN
serviceUPN string

A UPN do serviço.

Número de telefone do serviço
serviceTelNumber string

O número de telefone do serviço.

Utilizadores Preferidos
preferredUsers array of PreferredUser

Lista de utilizadores preferidos para as tarefas (UPN-Priority).

Modality

A modalidade da tarefa.

A modalidade da tarefa.

Modality
string

CalendarStatus

O estado do serviço (Aberto, Fechado, etc.).

O estado do serviço (Aberto, Fechado, etc.).

Estado do Horário de Funcionamento
string