Inicie aplicativos externos em uma chamada telefônica recebida v2

Este artigo foi traduzido automaticamente. Veja a versão de referência em inglês.

Rainbow permite recuperar informações sobre chamadas telefônicas recebidas. Você pode usar essas informações transferindo-as para outro aplicativo.
Com essa "Computer Telephony Integration", você pode se beneficiar das informações do Rainbow combinadas com outro banco de dados.

É necessária uma configuração específica para cada aplicativo externo que você deseja usar para esse tipo de integração. Consulte a documentação do aplicativo para obter a sintaxe correta para a transmissão de variáveis.
No final deste artigo, você encontrará alguns exemplos de integração entre Rainbow e a ferramenta de teste "MicroCRM".

Configurar o arquivo custo-manifest.json

Com essa nova versão, você pode exportar diretamente do aplicativo para desktop (1) um modelo do novo arquivo custo-manifest.json, incluindo alguma ajuda de sintaxe. Depois de modificar o arquivo, você pode importar (2) a configuração na mesma página de configuração.

Esse arquivo contém uma lista de ações a serem executadas em um evento predefinido.

Eventos para chamadas recebidas:

Há 4 eventos disponíveis:

• on-incoming-pbx-call-actions (aplicativo externo iniciado quando uma nova chamada recebida é apresentada)
• on-incoming-pbx-call-display-actions (uso de CPaaS - exibe mais informações quando uma nova chamada recebida é apresentada, seja de um arquivo, usando a API REST ou iniciando um bot Rainbow )
• on-answering-incoming-pbx-call-actions (aplicativo externo iniciado quando uma chamada recebida é atendida)
• on-releasing-incoming-pbx-call-actions (aplicativo externo iniciado quando uma chamada recebida é liberada)
• on-incoming-pbx-call-button-actions (aplicativo externo iniciado somente ao clicar em um botão adicionado no pop-up de chamada recebida)

Para o evento selecionado, você terá de configurar pelo menos a seção "command" composta de um "url" e "params". O campo "name" deve ser preenchido somente para o evento on-incoming-pbx-call-button-actions; ele será o nome exibido no botão no pop-up de chamada recebida.

"url" - Local do aplicativo externo

no campo URL, você fornecerá o URL ou o caminho do aplicativo externo

"params" - Variável a ser transmitida ao aplicativo externo

Há diferentes variáveis disponíveis:

Parte chamada (Rainbow usuário atualmente conectado ao aplicativo de desktop):

• ${localUser.firstName}
• ${localUser.lastName}
• ${localUser.email}
• ${localUser.canonicalNumber}
• ${localUser.phoneNumber}
• ${localUser.internalNumber}

Quem está ligando

• ${caller.firstName}
• ${caller.lastName}
• ${caller.phoneNumber}

Número de telefone chamado (quando a chamada é redirecionada ou quando Rainbow obtém o número do grupo)

• ${called.phoneNumber}

Contexto da chamada (somente para OXE)

• ${call.callId}
• ${call.globalCallId}

Opções específicas para as ações on-answering-incoming-pbx-call

"RaiseChangeCall": falso | verdadeiro | somente

Essa opção permite configurar o comportamento ao receber uma chamada transferida:

• false = somente as chamadas diretas para o usuário acionarão o evento.
• true = o evento é acionado para chamadas diretas para o usuário e também para chamadas que foram transferidas para esse usuário.
• only = somente as chamadas transferidas para o usuário acionam o evento.

Arquivo de modelo

{
"version": "2",
"extension-points": {
	"on-incoming-pbx-call-actions": [
		{
			"name": " ",
			"command": {
				"url": " ",
				"params": " "
			}
		}
	],
        "on-incoming-pbx-call-display-actions": [
                {
                        "name": " ",
                        "command": {
                             "commandType": " ",
                             "url": " ",
                             "method": " ",
                             "params": " ",
                             "header": [
                                " "
                             ],
                             "Jid": ""
                        },
                        "responseType": " ",
                        "jsonField": " "
                }
        ],
	"on-answering-incoming-pbx-call-actions": [
		{
			"name": " ",
			"command": {
				"url": " ",
				"params": " "
			},
                        "RaiseChangeCall": false
		}
	],
	"on-releasing-incoming-pbx-call-actions": [
		{
			"name": " ",
			"command": {
				"url": " ",
				"params": " "
			}
		}
	],
	"on-incoming-pbx-call-button-actions": [
		{
			"name": " ",
			"command": {
				"url": " ",
				"params": " "
			},
			"AnswerOnClick": false
		}
	]
},

"help": [
  " This Json file contents events customization for Rainbow Desktop application ",
  " Sources of events: ",
  " - on-incoming-pbx-call-actions : when a new incoming call is presented. ",
  " - on-incoming-pbx-call-display-actions : when a new incoming call is presented. ",
  " - on-answering-incoming-pbx-call-actions : when an incoming call is answered. ",
  " - on-releasing-incoming-pbx-call-actions : when an incoming call is released. ",
  " - on-incoming-pbx-call-button-actions : on click on a button added in the incoming call popup",
  " ",
  " name : is used only for the action button as the label of the button. ",
  " filter: set with value NoShortNumber will no invoke command if caller number is an internal. ",
  " AnswerOnClick: only for `on-incoming-pbx-call-button-actions` when set to `true`, the click ",
  " button will both answers the call and invoke the command ",
  " RaiseChangeCall: only for `on-answering-incoming-pbx-call-actions` when set to `true` or `only`",
  " will raise the event in transfer/switch call. ",
  " responseType: only for `on-incoming-pbx-call-display-actions` with commandType `file` or `rest`",
  " and can be `markdown` or `json`. ",
  " jsonField: only for `on-incoming-pbx-call-display-actions` with responseType `json` ",
  " ",
  " Available command keys: ",
  " url: is the path of the executable or an URL ",
  " params: is string with variable ${xx} which will be replaced by value when command invoked ",
  " commandType: only for `on-incoming-pbx-call-display-actions` and can be `file` or `rest` or `rainbowBot`",
  " method: only for `on-incoming-pbx-call-display-actions` with commandType `rest`and can be `GET` or `POST`",
  " header: only for `on-incoming-pbx-call-display-actions` with commandType `rest` is optional ",
  " and will be inserted as a header line in REST request ",
  " Jid: only for `on-incoming-pbx-call-display-actions` with commandType `rainbowBot` ",
  " ",
  " Variable for Rainbow user (ME) ",
  " ${localUser.firstName} ${localUser.lastName} ${localUser.email} ",
  " ${localUser.canonicalNumber} ${localUser.phoneNumber} ${localUser.internalNumber} ${localUser.phonePbx}",
  " ",
  " Variable for caller user ",
  " ${caller.firstName} ${caller.lastName} ${caller.phoneNumber} ",
  " ",
  " Variable for called number - when call is redirected or when Rainbow gets the group number ",
  " ${called.phoneNumber} ",
  " ",
  " Variable for call context ",
  " ${call.callId} ",
  " ${call.globalCallId} (OXE only) ",
  " ${call.correlatorData} ",
  " ${call.hexCorrelatorData} "                                              "
 ]
}

Exemplos de configuração com a ferramenta MicroCRM

Para abrir ou criar um registro no banco de dados do MicroCRM, para transmitir o número de telefone, a ferramenta deve ser executada com o parâmetro -number:

MicroCRM.exe -number phonenumber

• Para os exemplos abaixo, usaremos o número de telefone do chamador, que é a variável ${caller.phoneNumber}
• O MicroCRM está instalado no PC no seguinte local: C:\MicroCRM\MicroCRM.exe

Exemplo 1 - Abrir o MicroCRM ao atender uma chamada

Você só precisa modificar a seguinte parte do arquivo:

"on-answering-incoming-pbx-call-actions": [
 {
 "name": " ",
 "command": { "url": " C:\\MicroCRM\\MicroCRM.exe",
 "params": " -number${caller.phoneNumber}"
 }
 }
 ],

Observação: Não se esqueça de usar \\\ duplo para o caminho C:\\MicroCRM\\MicroCRM.exe

Exemplo 2 - Abra o MicroCRM quando você atender a uma chamada usando o botão dedicado na notificação de chamada recebida

Você só precisa modificar a seguinte parte do arquivo:

"on-incoming-pbx-call-button-actions": [
 {
 "name": "Open MicroCRM",
 "command": { "url": " C:\\MicroCRM\\MicroCRM.exe",
 "params": " -number${caller.phoneNumber}"
 },
 "AnswerOnClick": true}
 ]

Observação: para abrir o aplicativo externo e atender à chamada simultaneamente, você terá de definir o parâmetro "AnswerOnClick" como true.

Exemplo 3 - Abrir página da Web do diretório reverso francês na chamada recebida

Neste exemplo, não usamos um aplicativo instalado no PC, mas abriremos uma página da Web e a variável é fornecida diretamente na "url"

"on-incoming-pbx-call-actions": [
 {
 "name": " ",
 "command": { "url": "https://www.pagesjaunes.fr/annuaireinverse/recherche",
 "params": "quoiqui=${caller.phoneNumber}&proximite=0"
 }
 } 
 ],

Opções de instalação para implementar o custo-manifest.json usando uma ferramenta de distribuição de software

O arquivo de manifesto deve primeiro ser implementado no PC, por exemplo, o arquivo pode ser copiado para uma pasta de usuário C:\Users\username\Rainbow_custom_manifest\.

Em seguida, a configuração do aplicativo Rainbow Desktop deve ser iniciada com o parâmetro /Custom para aplicar o arquivo de manifesto personalizado ao usuário.

Usando configurações MSI:

msiexec /i "Rainbow_installer_user.msi" WRAPPED_ARGUMENTS="/Custom=C:\\Users\\username\\Rainbow_custom_manifest\\\custo-manifest.json"

Usando configurações de exe:

Rainbow_Installer.exe /Custom=C:\\Users\\\username\\Rainbow_custom_manifest\\custo-manifest.json

Desativar o recurso

Para uma instalação por meio da ferramenta de distribuição de software

Para desativar o uso do arquivo de manifesto personalizado, execute a instalação com /Custom sem nenhum valor
, por exemplo, Rainbow_Installer .exe /Custom ou desinstale e instale novamente o aplicativo de desktop Rainbow.

Para instalação manual/do usuário (importação do arquivo custo-manifesto)

Vá para a pasta C:\Users\username\AppData\Roaming\Alcatel-Lucent Enterprise\Rainbow

Exclua o arquivo custo-manifest.json

Migração Lançamento de aplicativos externos v1 para v2

Um usuário que já usa a versão 1 pode continuar a usá-la sem nenhuma alteração

A importação/exportação não será apresentada.

Para migrar da versão 1 para a versão 2, você deve:

1. Salvar o arquivo de manifesto personalizado v1
2. Alterar o arquivo Rainbow Settings e definir a linha "customizationDirectory": true
   • Local do arquivo C:\Users\username\AppData\Roaming\Alcatel-Lucent Enterprise\Rainbow
   • Observe que você terá que sair do site Rainbow antes de alterar o arquivo.
3. Agora, em Settings->Telephony->Customization, a seção fica visível
4. Exporte o modelo, adicione nesse arquivo os comandos personalizados do seu arquivo salvo na etapa 1 e, em seguida, importe-o novamente.