Luware Nimbus

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

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	Luware Helpdesk
URL	https://helpdesk.luware.cloud/
Email	nimbus.support@luware.com

Metadados do conector
Publicador	Luware
Site	https://luware.com/
Política de Privacidade	https://luware.com/en/privacy-policy/
Categorias	Comunicação; Colaboração

O Conector do Luware Nimbus permite a integração entre o Nimbus e softwares de terceiros, como CRMs ou sistemas de tíquetes. Ele permite que você ouça os eventos de entrada de tarefa e agendador que ocorrem no Luware Nimbus. Você pode criar tarefas, enriquecer tarefas existentes com dados de informações do chamador, adicionar parâmetros de roteamento ou disparar um evento em seu sistema de terceiros. 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 do IVR no Nimbus para um CRM.
Crie um item de trabalho após a chamada em um CRM.
Crie uma tarefa de chamada de volta para uma chamada perdida em um CRM.
Crie uma chamada de saída do Nimbus com base em uma campanha no CRM.
Rotear uma chamada de acordo com as preferências do cliente.
Mostrar preferências de chamador para uma chamada de entrada.
Crie tíquetes em um sistema de terceiros.
Crie uma lista de chamadas perdidas em um sistema de terceiros.
Abra o registro do cliente quando um agente atender a chamada.

Encontre mais informações e muita ajuda na base de dados de conhecimento do Luware: https://help.luware.com/nimbus-power-automate-connector

Pré-requisitos

Um plano do Microsoft PowerApps ou PowerAutomate com a camada "Premium"
Um locatário do Azure
Pelo menos um Serviço Do Luware Nimbus provisionado
Uma função no Luware Nimbus que permite o uso do conector do Luware Nimbus (https://help.luware.com/power-automate-roles)

Como estabelecer uma conexão segura

As APIs do Nimbus são protegidas por meio do AAD (Azure Active Directory) /Microsoft Entra ID usando permissões delegadas. Como Administrador de Locatários, você precisa conceder essas permissões para o aplicativo "Logon do Luware Nimbus" 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 confirmadas novamente.

Depois que essa etapa for concluída, você poderá usar o conector estabelecendo uma conexão com clusters nimbus. Escolha o mesmo local do cluster que a instalação do Nimbus. Se você não tiver certeza sobre isso, faça logon na Administração do Nimbus para verificar para qual Cluster você será redirecionado.

Introdução ao conector

Selecione o gatilho "Quando uma tarefa altera o estado" nos gatilhos do Luware Nimbus.
Configure seu Serviço Nimbus no qual você deseja ouvir chamadas de entrada.
Selecione o evento "Sistema aceito" (Disparado quando a atividade "Aceitar Conversa" no fluxo de trabalho é atingida).
Implemente a pesquisa das informações do chamador com base no Número de Telefone do Chamador, por exemplo, em seu CRM ou para fins de teste em uma Planilha do Excel hospedada no Sharepoint.
Use a ação "Tarefa de Atualização" para definir as informações do cliente como Nome/Sobrenome, Endereço, Cidade, País etc. na tarefa.

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

Problemas e limitações conhecidos

A perda de permissões (RBAC) no Luware Nimbus desabilitará gatilhos no power automate sem informações transparentes para o usuário final. Os fluxos simplesmente não serão mais disparados.
O Luware não tem influência sobre o tempo de execução dos fluxos, portanto, os resultados podem chegar de volta ao Nimbus com um atraso. Os fluxos de trabalho dependendo da conclusão do fluxo devem ser criados, tendo essa limitação em mente.

Erros e soluções comuns

Código de erro HTTP:

400: A solicitação enviada à API do Luware Nimbus não contém parâmetros válidos ou não podem ser aplicados. Exemplos: Todos os usuários preferenciais passados são inválidos, portanto, os usuários preferenciais não sã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 de aplicativo do 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: Os identificadores passados não podem ser correspondidos a nenhuma entidade no back-end.

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
Localização	cadeia	O local em que seu locatário está localizado.	Verdade

Limitações

Nome	Chamadas	Período de renovação
Chamadas à API por conexão	100	60 segundos

Ações

Adicionar um contato a um catálogo de endereços	Adiciona um novo contato a um catálogo de endereços específico. O ExternalId é usado como referência em solicitações adicionais.
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 tarefa	Atualize as informações do cliente, o parâmetro de contexto e/ou as configurações de usuário preferenciais para uma tarefa em andamento.
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 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 de agendador já criada.
Esvaziar um catálogo de endereços	Remova todos os contatos no catálogo de endereços especificado.
Obter contatos 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	Obtenha um horário de funcionamento do serviço: ele retorna o status do serviço (Abrir, 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 contatos de um catálogo de endereços	Remova um ou muitos 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 está em andamento.
Remover uma tarefa externa	Remover uma tarefa externa

Adicionar um contato a um catálogo de endereços

ID da operação:: AddContact

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

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Addressbook	AddressBook	True	string	O catálogo de endereços ao qual adicionar o contato.
Entrar em contato com a ID Externa	externalId	True	string	ID do contato dado pelo sistema externo.
Nome do contato	firstName		string	Nome do contato.
Sobrenome do Contato	lastName		string	Sobrenome do contato.
Nome de Exibição de Contato	displayName		string	Nome de exibição do contato.
Iniciais de contato	initials		string	Iniciais do contato.
Contate a Empresa	company		string	Empresa do contato.
Departamento de Contatos	department		string	Departamento do contato.
Título do trabalho de contato	jobTitle		string	Cargo do contato.
Contate o nome da entidade de usuário	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.
Contatar endereços de email	emailAddresses		array of string	Lista de endereços de email.
Telefones Comerciais de Contato	businessPhones		array of string	Lista de telefones comerciais.
Contatar telefones celulares	mobilePhones		array of string	Lista de telefones celulares.
Telefones Domésticos de Contato	homePhones		array of string	Lista de telefones domésticos.
Rua do Endereço	street		string	Rua e número do endereço.
Cidade do Endereço	city		string	Cidade do endereço.
País de endereço	country		string	País do endereço.
Estado do endereço	state		string	Estado do endereço.
Endereço Postcode	postalCode		string	Código postal do endereço.
Nome	name	True	string	Designação do campo personalizado.
Value	value		string	Valor do campo personalizado.

Retornos

Corpo: ContactReadDto

Adicionar uma nova tarefa externa

ID da operação:: AddExternalTask

Adicionar uma nova tarefa externa

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
UPN de serviço	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 do cliente.
Sobrenome do cliente	lastName		string	Sobrenome do cliente.
Nome de exibição do cliente	displayName		string	Nome de exibição do cliente.
Empresa do Cliente	company		string	Empresa do cliente.
Título do trabalho do cliente	jobTitle		string	Cargo do cliente.
Departamento do Cliente	department		string	Departamento do cliente.
Endereço da Rua do Cliente	streetAddress		string	Endereço de rua do cliente.
Código postal do cliente	postCode		string	Código postal do cliente.
Cidade 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 primário do cliente	primaryTelNumber		string	Número de telefone primário do cliente.
Nome	name	True	string	Designação do número de telefone.
Value	value		string	Valor do número de telefone.
UPN do cliente	UPN		string	UPN do cliente.
Endereço de mensagens instantâneas do cliente	imAddress		string	Endereço de mensagens instantâneas do cliente.
Email do cliente	email		string	Email do cliente.
Nome	name	True	string	Designação do campo personalizado.
Value	value		string	Valor do campo personalizado.
Nome	name	True	string	Nome do parâmetro de contexto personalizado.
Value	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 quando for concluída.
UPN	upn	True	string	O UPN do usuário preferencial.
Priority	priority		integer	A prioridade. 1 alta a 99 baixa.

Retornos

Corpo: ExternalTaskWriteResult

Agendar uma nova chamada de saída

ID da operação:: CreateSchedulerEntry

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

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID de Referência	ReferenceId		string	A ID para referência passada pelo sistema de terceiros.
Destino	destination	True	string	Destino das entradas do agendador com a direção "Saída".
Prioridade de distribuição	distributionPriority		string	Prioridade com a qual a tarefa deve ser tratada no Nimbus.
Hora da data de conclusão (UTC)	dueDateTimeUtc	True	date-time	Data e hora de conclusão em UTC: Exemplo: '2020-03-23T11:00:00Z'.
UPN de serviço	serviceUpn	True	string	UPN do serviço.
Tentativas máximas	maxAttempts		integer	Máximo de tentativas de chegar ao Destino.
Tempo limite da 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 da fila em segundos	maxQueueTimeInSeconds		integer	Define por 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 será selecionado.
Nome	name	True	string	Nome do parâmetro de contexto personalizado.
Value	value		string	Valor do parâmetro de contexto personalizado.
Nome do cliente	firstName		string	Nome do cliente.
Sobrenome do cliente	lastName		string	Sobrenome do cliente.
Nome de exibição do cliente	displayName		string	Nome de exibição do cliente.
Empresa do Cliente	company		string	Empresa do cliente.
Título do trabalho do cliente	jobTitle		string	Cargo do cliente.
Departamento do Cliente	department		string	Departamento do cliente.
Endereço da Rua do Cliente	streetAddress		string	Endereço de rua do cliente.
Código postal do cliente	postCode		string	Código postal do cliente.
Cidade 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 primário do cliente	primaryTelNumber		string	Número de telefone primário do cliente.
Nome	name	True	string	Designação do número de telefone.
Value	value		string	Valor do número de telefone.
UPN do cliente	UPN		string	UPN do cliente.
Endereço de mensagens instantâneas do cliente	imAddress		string	Endereço de mensagens instantâneas do cliente.
Email do cliente	email		string	Email do cliente.
Nome	name	True	string	Designação do campo personalizado.
Value	value		string	Valor do campo personalizado.

Retornos

Corpo: SchedulerEntryEventData

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

ID da operação:: CreateOutboundCallWithWorkflowSchedulerEntry

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

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID de Referência	ReferenceId		string	A ID para referência passada pelo sistema de terceiros.
Destino	destination	True	string	Destino da chamada de saída com fluxo de trabalho.
Hora da data de conclusão (UTC)	dueDateTimeUtc	True	date-time	Data e hora de conclusão em UTC: Exemplo: '2020-03-23T11:00:00Z'.
UPN de serviço	serviceUpn	True	string	UPN do serviço.
Tentativas máximas	maxAttempts		integer	Máximo de tentativas de chegar ao Destino.
Tempo limite da tentativa em segundos	attemptTimeoutInSeconds		integer	Define por 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.
Value	value		string	Valor do parâmetro de contexto personalizado.
Nome do cliente	firstName		string	Nome do cliente.
Sobrenome do cliente	lastName		string	Sobrenome do cliente.
Nome de exibição do cliente	displayName		string	Nome de exibição do cliente.
Empresa do Cliente	company		string	Empresa do cliente.
Título do trabalho do cliente	jobTitle		string	Cargo do cliente.
Departamento do Cliente	department		string	Departamento do cliente.
Endereço da Rua do Cliente	streetAddress		string	Endereço de rua do cliente.
Código postal do cliente	postCode		string	Código postal do cliente.
Cidade 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 primário do cliente	primaryTelNumber		string	Número de telefone primário do cliente.
Nome	name	True	string	Designação do número de telefone.
Value	value		string	Valor do número de telefone.
UPN do cliente	UPN		string	UPN do cliente.
Endereço de mensagens instantâneas do cliente	imAddress		string	Endereço de mensagens instantâneas do cliente.
Email do cliente	email		string	Email do cliente.
Nome	name	True	string	Designação do campo personalizado.
Value	value		string	Valor do campo personalizado.

Retornos

Corpo: OutboundCallWithWorkflowSchedulerEntryEventData

Atualizar tarefa

ID da operação:: UpdateTask

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

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID da Tarefa	taskId	True	string	A ID específica do Nimbus da tarefa.
Nome do cliente	firstName		string	Nome do cliente.
Sobrenome do cliente	lastName		string	Sobrenome do cliente.
Nome de exibição do cliente	displayName		string	Nome de exibição do cliente.
Empresa do Cliente	company		string	Empresa do cliente.
Título do trabalho do cliente	jobTitle		string	Cargo do cliente.
Departamento do Cliente	department		string	Departamento do cliente.
Endereço da Rua do Cliente	streetAddress		string	Endereço de rua do cliente.
Código postal do cliente	postCode		string	Código postal do cliente.
Cidade 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 primário do cliente	primaryTelNumber		string	Número de telefone primário do cliente.
Nome	name	True	string	Designação do número de telefone.
Value	value		string	Valor do número de telefone.
UPN do cliente	UPN		string	UPN do cliente.
Endereço de mensagens instantâneas do cliente	imAddress		string	Endereço de mensagens instantâneas do cliente.
Email do cliente	email		string	Email do cliente.
Nome	name	True	string	Designação do campo personalizado.
Value	value		string	Valor do campo personalizado.
Nome	name	True	string	Nome do parâmetro de contexto personalizado.
Value	value		string	Valor do parâmetro de contexto personalizado.
UPN	upn	True	string	O UPN do usuário preferencial.
Priority	priority		integer	A prioridade. 1 alta a 99 baixa.
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.

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

ID da operação:: UpdateContact

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

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Addressbook	AddressBook	True	string	O catálogo de endereços no qual atualizar o contato.
Entrar em contato com a ID Externa	externalId	True	string	ID do contato dado pelo sistema externo.
Nome do contato	firstName		string	Nome do contato.
Sobrenome do Contato	lastName		string	Sobrenome do contato.
Nome de Exibição de Contato	displayName		string	Nome de exibição do contato.
Iniciais de contato	initials		string	Iniciais do contato.
Contate a Empresa	company		string	Empresa do contato.
Departamento de Contatos	department		string	Departamento do contato.
Título do trabalho de contato	jobTitle		string	Cargo do contato.
Contate o nome da entidade de usuário	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.
Contatar endereços de email	emailAddresses		array of string	Lista de endereços de email.
Telefones Comerciais de Contato	businessPhones		array of string	Lista de telefones comerciais.
Contatar telefones celulares	mobilePhones		array of string	Lista de telefones celulares.
Telefones Domésticos de Contato	homePhones		array of string	Lista de telefones domésticos.
Rua do Endereço	street		string	Rua e número do endereço.
Cidade do Endereço	city		string	Cidade do endereço.
País de endereço	country		string	País do endereço.
Estado do endereço	state		string	Estado do endereço.
Endereço Postcode	postalCode		string	Código postal do endereço.
Nome	name	True	string	Designação do campo personalizado.
Value	value		string	Valor do campo personalizado.

Retornos

Corpo: ContactReadDto

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

ID da operação:: UpdateOutboundCallWithWorkflowSchedulerEntry

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

Parâmetros

Nome	Chave	Obrigató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	A ID para referência passada pelo sistema de terceiros.
Destino	destination	True	string	Destino da chamada de saída com fluxo de trabalho.
Hora da data de conclusão (UTC)	dueDateTimeUtc	True	date-time	Data e hora de conclusão em UTC: Exemplo: '2020-03-23T11:00:00Z'.
UPN de serviço	serviceUpn	True	string	UPN do serviço.
Tentativas máximas	maxAttempts		integer	Máximo de tentativas de chegar ao Destino.
Tempo limite da tentativa em segundos	attemptTimeoutInSeconds		integer	Define por 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.
Value	value		string	Valor do parâmetro de contexto personalizado.
Nome do cliente	firstName		string	Nome do cliente.
Sobrenome do cliente	lastName		string	Sobrenome do cliente.
Nome de exibição do cliente	displayName		string	Nome de exibição do cliente.
Empresa do Cliente	company		string	Empresa do cliente.
Título do trabalho do cliente	jobTitle		string	Cargo do cliente.
Departamento do Cliente	department		string	Departamento do cliente.
Endereço da Rua do Cliente	streetAddress		string	Endereço de rua do cliente.
Código postal do cliente	postCode		string	Código postal do cliente.
Cidade 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 primário do cliente	primaryTelNumber		string	Número de telefone primário do cliente.
Nome	name	True	string	Designação do número de telefone.
Value	value		string	Valor do número de telefone.
UPN do cliente	UPN		string	UPN do cliente.
Endereço de mensagens instantâneas do cliente	imAddress		string	Endereço de mensagens instantâneas do cliente.
Email do cliente	email		string	Email do cliente.
Nome	name	True	string	Designação do campo personalizado.
Value	value		string	Valor do campo personalizado.

Retornos

Corpo: OutboundCallWithWorkflowSchedulerEntryEventData

Atualizar uma entrada do agendador

ID da operação:: UpdateSchedulerEntry

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

Parâmetros

Nome	Chave	Obrigató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	A ID para referência passada pelo sistema de terceiros.
Destino	destination	True	string	Destino das entradas do agendador com a direção "Saída".
Prioridade de distribuição	distributionPriority		string	Prioridade com a qual a tarefa deve ser tratada no Nimbus.
Hora da data de conclusão (UTC)	dueDateTimeUtc	True	date-time	Data e hora de conclusão em UTC: Exemplo: '2020-03-23T11:00:00Z'.
UPN de serviço	serviceUpn	True	string	UPN do serviço.
Tentativas máximas	maxAttempts		integer	Máximo de tentativas de chegar ao Destino.
Tempo limite da 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 da fila em segundos	maxQueueTimeInSeconds		integer	Define por 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 será selecionado.
Nome	name	True	string	Nome do parâmetro de contexto personalizado.
Value	value		string	Valor do parâmetro de contexto personalizado.
Nome do cliente	firstName		string	Nome do cliente.
Sobrenome do cliente	lastName		string	Sobrenome do cliente.
Nome de exibição do cliente	displayName		string	Nome de exibição do cliente.
Empresa do Cliente	company		string	Empresa do cliente.
Título do trabalho do cliente	jobTitle		string	Cargo do cliente.
Departamento do Cliente	department		string	Departamento do cliente.
Endereço da Rua do Cliente	streetAddress		string	Endereço de rua do cliente.
Código postal do cliente	postCode		string	Código postal do cliente.
Cidade 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 primário do cliente	primaryTelNumber		string	Número de telefone primário do cliente.
Nome	name	True	string	Designação do número de telefone.
Value	value		string	Valor do número de telefone.
UPN do cliente	UPN		string	UPN do cliente.
Endereço de mensagens instantâneas do cliente	imAddress		string	Endereço de mensagens instantâneas do cliente.
Email do cliente	email		string	Email do cliente.
Nome	name	True	string	Designação do campo personalizado.
Value	value		string	Valor do campo personalizado.

Retornos

Corpo: SchedulerEntryEventData

Esvaziar um catálogo de endereços

ID da operação:: ClearContacts

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

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Addressbook	AddressBook	True	string	O catálogo de endereços a ser vazio

Obter contatos de um catálogo de endereços

ID da operação:: GetContacts

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

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Addressbook	AddressBook	True	string	O catálogo de endereços do qual obter os contatos.
ExternalId	externalIds		array	IDs externas dos contatos a serem buscados. Opcional: se nenhum for fornecido, todos os contatos serão retornados.

Retornos

Os contatos retornados.

Contatos: array of ContactReadDto

Obter dados do assistente de usuário virtual

ID da operação:: GetVirtualUserAssistantData

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

Parâmetros

Nome	Chave	Obrigató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.

Retornos

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

Obter horário de funcionamento

ID da operação:: GetOpeningHours

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

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
UPN de serviço	serviceUpn	True	string	UPN do serviço para o qual o status será verificado.
Hora da data de conclusão (UTC)	time		date-time	Data e hora de conclusão em UTC: Exemplo: '2020-03-23T11:00:00Z'.

Retornos

O status do serviço (Abrir, Fechado etc.).

response: CalendarStatus

Obter todas as entradas do agendador

ID da operação:: GetSchedulerEntries

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

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
UPN de serviço	serviceUpn	True	string	UPN do serviço para o qual as entradas do agendador devem ser retornadas.

Retornos

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

Tarefas Agendadas: array of SchedulerEntryEventData

Remover contatos de um catálogo de endereços

ID da operação:: RemoveContacts

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

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Addressbook	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

ID da operação:: DeleteSchedulerEntry

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

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID de entrada do agendador	SchedulerEntryID	True	string	ID da entrada do agendador a ser removida.

Remover uma tarefa externa

ID da operação:: RemoveExternalTask

Remover uma tarefa externa

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID da tarefa externa	externalTaskId	True	string	ID da Tarefa Externa sendo removida

Gatilhos

Quando o assistente de usuário virtual tiver uma atualização	Esse evento é disparado quando o assistente de usuário virtual tem uma nova atualização.
Quando uma entrada de agendador altera o estado	Gerado sempre que uma entrada de agendador que corresponde aos critérios de filtro altera seu estado.
Quando uma tarefa altera o estado	Gerado sempre que uma tarefa que corresponde aos critérios de filtro altera seu estado.

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

ID da operação:: RegisterVirtualUserAssistantTrigger

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

Parâmetros

Nome	Chave	Obrigató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 Assistente de Usuário Virtual	virtualUserAssistantEvents	True	array of string	Eventos do assistente de usuário virtual, para os quais esse gatilho deve ser gerado.

Retornos

Corpo: VirtualUserAssistantEventData

Quando uma entrada de agendador altera o estado

ID da operação:: RegisterSchedulerEntryTrigger

Gerado sempre que uma entrada de agendador que corresponde aos critérios de filtro altera seu estado.

Parâmetros

Nome	Chave	Obrigató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 gerado.

Retornos

Corpo: SchedulerEntryEventData

Quando uma tarefa altera o estado

ID da operação:: RegisterTaskWebHook

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

Parâmetros

Nome	Chave	Obrigató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 tarefa	taskEvents	True	array of string	Eventos das tarefas para as quais esse gatilho deve ser gerado.
Modalidades	modalities		array of string	Especifique as modalidades iniciais das tarefas.
Instruções	directions		array of string	Especifique as instruções das tarefas.

Retornos

Corpo: TaskEventData

Definições

TaskEventData

Nome	Caminho	Tipo	Description
ID da Tarefa	taskId	string	A ID específica 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 do 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	A ID da Cadeia de Chamadas da Microsoft da tarefa.
Event	event	string	O evento que ocorreu no Nimbus para a tarefa.
Direção	direction	string	Direção da tarefa em andamento no Nimbus (Entrada/Saída/Nenhum).
Modality	modality	string	Modalidade inicial da tarefa no Nimbus.
Criado	created	string	Carimbo de data/hora, quando a tarefa foi criada.
Encerrado(a)	terminated	string	Carimbo de data/hora, quando a tarefa foi encerrada.
Reason	reason	string	Motivo do término.
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.
Email do último usuário conectado	LastConnectedUserEmail	string	Email 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	A ID para referência passada pelo sistema de terceiros.
Identificação de chamadas	callerId	string	ID interna do 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 chamador. Defina apenas para tarefas com modalidade=Áudio.
UPN do chamador	callerUPN	string	UPN do cliente.
ID de destino da Microsoft	microsoftDestinationId	string	ID do objeto (AAD) do destinatário da chamada em uma tarefa de saída.
ID de destino	destinationId	string	ID interna do destino (saída) 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 (saída).
UPN de destino	destinationUPN	string	UPN do destino (saída).
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 para o cliente em todos os tipos de tarefa.
Mensagem Inicial	initialMessage	string	Primeira mensagem do cliente de mensagens instantâneas.
ID do Serviço	serviceId	string	ID interna 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.
UPN de serviço	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 de email	emailSubject	string	Assunto do e-mail.
Texto avançado exclusivo do corpo do email	emailBodyUniqueRichText	string	Corpo do email, rich text.
Texto sem formatação exclusivo do corpo do email	emailBodyUniquePlainText	string	Corpo do email, texto sem formatação.
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 de 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 da tarefa	taskInformation	TaskInformation	Contém informações sobre o cliente, o parâmetro de contexto personalizado e os usuários preferenciais.

TaskInformation

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

Nome	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).
Usuários preferenciais	preferredUsers	array of PreferredUser	Lista de usuários preferenciais para as tarefas (UPN-Priority).

Customer

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

Nome	Caminho	Tipo	Description
Nome do cliente	firstName	string	Nome do cliente.
Sobrenome do cliente	lastName	string	Sobrenome do cliente.
Nome de exibição do cliente	displayName	string	Nome de exibição do cliente.
Empresa do Cliente	company	string	Empresa do cliente.
Título do trabalho do cliente	jobTitle	string	Cargo do cliente.
Departamento do Cliente	department	string	Departamento do cliente.
Endereço da Rua do Cliente	streetAddress	string	Endereço de rua do cliente.
Código postal do cliente	postCode	string	Código postal do cliente.
Cidade 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 primário do cliente	primaryTelNumber	string	Número de telefone primário do cliente.
Números de telefone	telNumbers	array of TelNumber	Lista de números de telefone adicionais do Cliente.
UPN do cliente	UPN	string	UPN do cliente.
Endereço de mensagens instantâneas do cliente	imAddress	string	Endereço de mensagens instantâneas do cliente.
Email do cliente	email	string	Email do cliente.
Campos personalizados	customFields	array of CustomField	Lista de campos personalizados do cliente.

TelNumber

Nome	Caminho	Tipo	Description
Nome	name	string	Designação do número de telefone.
Value	value	string	Valor do número de telefone.

CustomField

Nome	Caminho	Tipo	Description
Nome	name	string	Designação do campo personalizado.
Value	value	string	Valor do campo personalizado.

CustomContextParameter

Nome	Caminho	Tipo	Description
Nome	name	string	Nome do parâmetro de contexto personalizado.
Value	value	string	Valor do parâmetro de contexto personalizado.

PreferredUser

Nome	Caminho	Tipo	Description
UPN	upn	string	O UPN do usuário preferencial.
Priority	priority	integer	A prioridade. 1 alta a 99 baixa.

ContactReadDto

Nome	Caminho	Tipo	Description
Entrar em contato com a ID Externa	externalId	string	ID do contato dado pelo sistema externo.
Nome do contato	firstName	string	Nome do contato.
Sobrenome do Contato	lastName	string	Sobrenome do contato.
Nome de Exibição de Contato	displayName	string	Nome de exibição do contato.
Iniciais de contato	initials	string	Iniciais do contato.
Contate a Empresa	company	string	Empresa do contato.
Departamento de Contatos	department	string	Departamento do contato.
Título do trabalho de contato	jobTitle	string	Cargo do contato.
Contate o nome da entidade de usuário	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.
Contatar endereços de email	emailAddresses	array of string	Lista de endereços de email.
Telefones Comerciais de Contato	businessPhones	array of string	Lista de telefones comerciais.
Contatar telefones celulares	mobilePhones	array of string	Lista de telefones celulares.
Telefones Domésticos de Contato	homePhones	array of string	Lista de telefones domésticos.
endereços	addresses	array of Address	Lista de endereços.
customFields	customFields	array of CustomField	Lista de campos personalizados do contato.

Endereço

Nome	Caminho	Tipo	Description
Rua do Endereço	street	string	Rua e número do endereço.
Cidade do Endereço	city	string	Cidade do endereço.
País de endereço	country	string	País do endereço.
Estado do endereço	state	string	Estado do endereço.
Endereço Postcode	postalCode	string	Código postal do endereço.

SchedulerEntryEventData

Nome	Caminho	Tipo	Description
ID de entrada do agendador	schedulerEntryId	string	A ID específica 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 no Nimbus para a tarefa agendada.
Direção	direction	string	Direção da tarefa em andamento no Nimbus (Entrada/Saída/Nenhum).
Modality	modality	string	Modalidade inicial da tarefa no Nimbus.
ID de Referência	ReferenceId	string	A ID para referência passada pelo sistema de terceiros.
ID de conversa unificada	unifiedConversationId	string	ID de conversa unificada.
Motivo da conclusão	completionReason	string	Resultado da entrada do agendador quando encerrado.
Destino	destination	string	Destino das entradas do agendador com a direção "Saída".
Prioridade de distribuição	distributionPriority	string	Prioridade com a qual a tarefa deve ser tratada no Nimbus.
Hora da data de conclusão (UTC)	dueDateTimeUtc	date-time	Data e hora de conclusão em UTC: Exemplo: '2020-03-23T11:00:00Z'.
UPN de serviço	serviceUpn	string	UPN do serviço para o qual a entrada está agendada.
Tentativas máximas	maxAttempts	integer	Máximo de tentativas de chegar ao Destino.
Tempo limite da 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 da fila em segundos	maxQueueTimeInSeconds	integer	Define por 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 será selecionado.
Parâmetros de contexto personalizados	customCallContextParameters	array of CustomContextParameter	Lista de parâmetro de contexto personalizado (Key-Value).
cliente	customer	Customer	Objeto que contém todas as informações do cliente.

OutboundCallWithWorkflowSchedulerEntryEventData

Nome	Caminho	Tipo	Description
ID de entrada do agendador	schedulerEntryId	string	A ID específica 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 no Nimbus para a tarefa agendada.
Direção	direction	string	Direção da tarefa em andamento no Nimbus (Entrada/Saída/Nenhum).
Modality	modality	string	Modalidade inicial da tarefa no Nimbus.
ID de Referência	ReferenceId	string	A ID para referência passada pelo sistema de terceiros.
ID de conversa unificada	unifiedConversationId	string	ID de conversa unificada.
Motivo da conclusão	completionReason	string	Resultado da entrada do agendador quando encerrado.
Destino	destination	string	Destino das entradas do agendador com a direção "Saída".
Prioridade de distribuição	distributionPriority	string	Prioridade com a qual a tarefa deve ser tratada no Nimbus.
Hora da data de conclusão (UTC)	dueDateTimeUtc	date-time	Data e hora de conclusão em UTC: Exemplo: '2020-03-23T11:00:00Z'.
UPN de serviço	serviceUpn	string	UPN do serviço para o qual a entrada está agendada.
Tentativas máximas	maxAttempts	integer	Máximo de tentativas de chegar ao Destino.
Tempo limite da tentativa em segundos	attemptTimeoutInSeconds	integer	Define por 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âmetro de contexto personalizado (Key-Value).
cliente	customer	Customer	Objeto que contém todas as informações do cliente.

VirtualUserAssistantEventData

Nome	Caminho	Tipo	Description
ID da sessão unificada	unifiedSessionId	string	A ID da sessão unificada do Nimbus relacionada.
ID da sessão de serviço	serviceSessionId	string	A ID da sessão de serviço nimbus relacionada.
ID da Sessão do Usuário	userSessionId	string	A ID da sessão de usuário do Nimbus relacionada.
UPN de serviço	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 do assistente de usuário virtual que ocorreu no Nimbus.
Sessão do 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

Nome	Caminho	Tipo	Description
ID da 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 foi criada.
Tipo	type	string	O tipo da tarefa externa.
É Anônimo	isAnonymous	boolean	Sinalizador definido como true, quando o chamador é anônimo.
ID do Serviço	serviceId	string	ID interna 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 de exibição do serviço.
UPN de serviço	serviceUPN	string	O UPN do serviço.
Número tel do serviço	serviceTelNumber	string	O número de telefone do serviço.
Usuários preferenciais	preferredUsers	array of PreferredUser	Lista de usuários preferenciais para as tarefas (UPN-Priority).

Modality

A modalidade da tarefa.

Modality: string

CalendarStatus

O status do serviço (Abrir, Fechado etc.).

Status do horário de funcionamento: string

Compartilhar via

Luware Nimbus

Pré-requisitos

Como estabelecer uma conexão segura

Introdução ao conector

Problemas e limitações conhecidos

Erros e soluções comuns

Criando uma conexão

Padrão

Limitações

Ações

Adicionar um contato a um catálogo de endereços

Parâmetros

Retornos

Adicionar uma nova tarefa externa

Parâmetros

Retornos

Agendar uma nova chamada de saída

Parâmetros

Retornos

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

Parâmetros

Retornos

Atualizar tarefa

Parâmetros

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

Parâmetros

Retornos

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

Parâmetros

Retornos

Atualizar uma entrada do agendador

Parâmetros

Retornos

Esvaziar um catálogo de endereços

Parâmetros

Obter contatos de um catálogo de endereços

Parâmetros

Retornos

Obter dados do assistente de usuário virtual

Parâmetros

Retornos

Obter horário de funcionamento

Parâmetros

Retornos

Obter todas as entradas do agendador

Parâmetros

Retornos

Remover contatos de um catálogo de endereços

Parâmetros

Remover uma entrada do agendador

Parâmetros

Remover uma tarefa externa

Parâmetros

Gatilhos

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

Parâmetros

Retornos

Quando uma entrada de agendador altera o estado

Parâmetros

Retornos

Quando uma tarefa altera o estado

Parâmetros

Retornos

Definições

TaskEventData

TaskInformation

Customer

TelNumber

CustomField

CustomContextParameter

PreferredUser

ContactReadDto

Endereço

SchedulerEntryEventData

OutboundCallWithWorkflowSchedulerEntryEventData

VirtualUserAssistantEventData

ExternalTaskWriteResult

Modality

CalendarStatus