PABX/Sigma
Tabela de conteúdo |
Integrando envio de eventos para o Sigma
A configuração de integração fica no menu GESTÃO ⇒ Configuração ⇒ Integrações ⇒ Sigma.
Configuração Geral
Configuração Sigma - Servidor | |
---|---|
Servidor | Este valor é fixo e não pode ser alterado. |
Token | Token de acesso a API do Sigma. Deve ser disponibilizado pelo aplicação Sigma. |
Configuração Sigma - Geral | |
---|---|
Conta Padrão | Conta padrão enviado no evento caso o PABX não encontre nenhuma conta associada. |
Porta Padrão | Porta padrão dos eventos enviados para o Sigma. Caso em algum evento não tenha configurado sua porta, ou o evento não está cadastrado no PABX, esta será a porta enviada. |
Filas | Selecione neste campo, quais filas do PABX fazer parte da integração com Sigma. |
Monitorar Ramais | Indica para o PABX monitorar o registro de ramais e troncos. Toda vez que ocorrer uma transição de registrado para não registrado, o PABX uTech irá enviar um evento informando o status do ramal. |
Configuração Sigma - Eventos | |
---|---|
Evento Padrão | Código do evento padrão, caso nenhum evento associado for encontrado. |
Ramal Ativo | Código do evento de Ramal Ativo. |
Ramal Inativo | Código do evento de Ramal Inativo. |
Configuração Sigma - Portaria Autônoma | |
---|---|
Assistente Virtual | Habilita a integração com assistente virtual. Assistente solicita informações a pessoa é visitante, entregador ou morador e envia estar informações no evento para o Sigma. |
Mensagem de Saudação | Mensagem inicial de saudação para o usuário. Ex. Bem vindo, eu sou a assistente virtual do condomínio pedro coelho!. |
Tempo Limite de Resposta | Tempo, em segundos que a assistente virtual irá aguardar pela resposta do usuário. |
Tempo Limite de Resposta de Nome | Tempo, em segundos que a assistente virtual irá aguardar pela resposta do NOME usuário. |
Configuração Sigma - Configurações de Discagem | |
---|---|
Click to Call | Habilita a integração para gerar chamadas pele interface do Sigma. Ver CLICK TO CALL |
Token | Senha de integração para gerar chamadas pele interface do Sigma. Ver CLICK TO CALL |
- Ver configuração do CLICK TO CALL abaixo!!!
Configuração de Contas
No menu contas, deve-se adicionar todas as contas existentes no Sigma.
Configuração Sigma - Adicionando Contas | |
---|---|
Estado da Conta | Valor numérico da conta. |
Conta | Valor numérico da conta. |
Descrição | Descrição da conta. |
Endereço | Endereço físico da conta. |
Configuração de Portas
No menu Portas, adicione as portas referentes a cada conta.
Configuração Sigma - Adicionando Zonas | |
---|---|
Conta | Conta pré-configurada. |
Porta | Valor numérico da porta. |
Descrição | Descrição da porta. |
Configuração de Eventos
No menu Eventos, adicione os eventos associados a cada Porta/Conta
Configuração Sigma - Adicionando Eventos | |
---|---|
Evento | Código numérico do evento. |
Descrição | Descrição do evento. |
Número | Identidade da chamada recebida para gerar este evento (Número do chamador - NA). |
Porta | Porta associada ao evento. |
Portaria Autônoma | Habilita portaria autônoma. |
Configurando Integração CTI
Considerações iniciais:
- Para cada operador do Sigma CLoud, será necessário criar no PABX uTech um usuário CTI (Agente).
- Os usuários CTI do PABX uTech são licenciados, logo, é necessário ter licenças Agentes CTI disponíveis para o número de agentes logados. (As licenças disponíveis no PABX uTech podem ser verificadas no meu GESTÃO &rArr Licenciamento.
No PABX uTech
No PABX uTech, é necessário criar um usuário CTI para cada agente logado no Sigma Cloud. Acesse o menu APLICAÇÕES ⇒ CTI.
- Usuário: Selecione o Ramal do usuário
- Senha: Insira uma senha para este usuário CTI.
- Permissão: Selecione a opção Atendente.
- Configure as permissões necessárias para o usuário CTI e o que ele terá permissão.
No Sigma Cloud
Com TODOS os usuários CTI configurados no PABX uTech, é necessário habilitar a integração no Sigma Cloud e configurar os usuários:
Habilitando a integração com PABX uTech
- Acesse o menu Configurações ⇒ Comunicação ⇒ Integração Utech, conforme imagens abaixo:
- Tipo: A conexão do Sigma Cloud com o PABX uTech pode ser realizar via WS - Websocket ou WSS - Websocket Secure. Para integração com WSS é necessário a inclusão de um certificado no PABX uTech. Para mais informações sobre como instalar/configurar um certificado no PABX uTech acesse: Certificado no PABX uTech
- IP: No campo IP, insira o endereço/domínio de acesso ao PABX uTech.
- Porta: Insira a porta de conexão com Websocket do PABX uTech. Padrão 3000.
- Atender a ocorrência pelo Sigma: Selecionado, o atendimento da chamada será pela aplicação Sigma, não sendo necessário clicar o botão de atender chamada' no softphone (como um atendimento automático).
- Atender a ocorrência pelo Softphone: Se selecionado esta opção, é necessário atendar a chamada pelo Softphone/Telefone.
Configurando os Ramais dos usuário do Sigma
No Sigma, nas configurações do usuário, selecione a opção Configurar Ramal e insira o usuário CTI e senha, conforme configurado no PABX uTech.
Configuração Click-to-Call
Configurando PABX uTech
- Acesse o menu principal do PABX, e clique na opção GESTÃO ⇒ Configurações, aba Integrações e depois Sigma.
- Vá ate a opção Configurações de Discagem;
- Para ativar a função, habilite o campo Click2Call e insira um token (senha), conforme imagem abaixo:
(Memorize a senha, ela sera inserida na url do Click2Call no Sigma.)
Configurando PABX Sigma
No Sigma Cloud, acesse o menu Configurações ⇒ Comunicação e depois a opção Click to call. Configure conforme imagem abaixo, substituindo:
- URL de chamada:
- Endereço IP: Troque o campo 10.0.0.1, pelo endereço de acesso ao PABX. Ex. 192.168.0.1:8080, pbx.dominio.com.
- Token: Substitua o valor do campo token pelo token/senha configurado no PABX uTech (Ver Configurando PABX uTech ).
- Ex: http://10.0.0.1/sigma/?token=1234&extension=2000&phone=48988887777
- URL para ouvir as chamadas:
- Endereço IP: Troque o campo 10.0.0.1, pelo endereço de acesso ao PABX. Ex. 192.168.0.1:8080, pbx.dominio.com.
- Ex: http://10.0.0.1/sigma/[ID].wav
- Endereço IP: Troque o campo 10.0.0.1, pelo endereço de acesso ao PABX. Ex. 192.168.0.1:8080, pbx.dominio.com.
- Método:
- Selecione a opção GET;
- Autenticação:
- Desabilite o campo Autenticação.
Testando a API
Para testes, execute no navegador os link's de URL de chamada e URL para ouvir chamadas.
Gerando chamada
- Ex: http://10.0.0.1/sigma/?token=1234&extension=2000&phone=48988887777
Retorno OK
{"status":"ok","id":"1608145194.5517051"}
Retorno com erro
{"status":"error","cause":"Forbidden"}
Buscando a gravação
- http://10.0.0.1/sigma/1608145194.5517051.wav
Onde o valor 1608145194.5517051 é o ID retornado ao gerar a chamada.
Ouvindo chamadas
URL para ouvir as chamadas:
Ex: http://10.0.0.1/sigma/[ID].wav.
- No caso do exemplo acima: http://10.0.0.1/sigma/1608145194.5517051.wav
Configuração URA de eventos X2 e X5
Esse serviço é executado pelo SIGMA. Quando for gerado um evento X2 ou X5, o PABX uTech receberá as informações necessárias para realizar uma ligação para o usuário do numero telefônico cadastrado no SIGMA, para confirmação/informação dos eventos X2 e X5 (Arme e desarme da central de alarmes).
NOTA: Como os eventos X2 e X5 são oriundos do Sigma CLoud e o mesmo está na internet. Assim, Quando o PABX uTech estiver instalado em uma rede interna (com NAT), é mandatório a criação de redirecionamento de porta para o PABX uTech receber os eventos do Sigma Cloud. Há duas opção de redirecionamento. Porta HTTP (80) ou HTTPS (443). p REcomendados é utilizar a porta HTTPS, porem, para utilizar https, é necessário a aquisição de um certificado SSL para instalação do PABX.
|
NOTA: Ao fazer um redirecionamento para a porta 80 ou 443, limite o acesso apenas aos endereços do Sigma Cloud. |
Para habilitar a URA de eventos X2 e X5, basta habilitar a configuração Click to Call no menu GESTÃO ⇒ Configurações, aba Integrações e depois Sigma e inserir um Token (como mostrado na imagem abaixo). Este token DEVE ser configurado no SIGMA, para autenticação das requisições X2 e X5 enviadas pelo Sigma.
Configurando a URA do Sigma Cloud
Para configurar a URA do Sigma Cloud, acesse o Sigma cloud no menu Configurações ⇒ Comunicação ⇒ URA.
- Na configuração da URA (X2 e X5) do Sigma Cloud, configure a URL conforme exemplos abaixo (Demais campos siga as orientações da Segware):
- NOTA: O campo retorno, segundo documentação da Segware, é o numero do telefone(fixo ou celular) da central de monitoramento.
- TOKEN: Insira na URL o parâmetro token=[SENHA], com a senha configurada no campo Token do PABX uTech. Ex. token=1234.
- URL: http://SEU_IP_EXTERNO:8888/sigma/?token=1234567890qazwsx&phone=#telefone#&password=#senha#&coercion=#coacao#&eventId=#evento#&contactId=#contato#&conta=#conta#&code=#codigo#
- Exemplo: http://200.201.202.203:8888/sigma/?token=1234567890qazwsx&phone=#telefone#&password=#senha#&coercion=#coacao#&eventId=#evento#&contactId=#contato#&conta=#conta#&code=#codigo#
- Tags disponíveis:
- #telefone#: telefone de destino.
- #senha#: senha.
- #coacao#: senha de coação.
- #evento#: id do evento que gerou a ligação.
- #conta#: código da conta.
- #contato#: id do contato para qual é feita ligação.
- #codigo#: código do evento que gerou a ligação (X2/X5).
Testando a Integração sem o Sigma cloud
Caso esteja com problemas para integrar, use o exemplo abaixo para testar se o PABX uTech está configurado corretamente:
- Para testar a integração/configuração do PABX, acesse de um navegador (Chrome, firefox, etc..) as seguintes URL's, trocando os campos:
- 10.20.30.40 pelo endereço IP do PABX.
- 56565656565 pelo valor no campo Token configurado no PABX uTech - GESTÃO ⇒ Configuração. Aba Integração ⇒ Sigma.
- 4833333840 pelo seu numero de telefone celular.
- Exemplo X2:
http://200.201.202.203:8888/sigma?token=56565656565&phone=04833334840&password=1234&coercion=12435&eventId=12345&contactId=12345&conta=12345&code=X2
- Exemplo X5:
http://200.201.202.203:8888/sigma?token=56565656565&phone=04833334840&password=1234&coercion=12435&eventId=12345&contactId=12345&conta=12345&code=X5
Formato dos eventos enviados
O PABX envia eventos ao Sigma Cloud, quando receber uma chamada de um número que case com um evento configurado no menu GESTÃO ⇒ Configuração ⇒ Integrações ⇒ Sigma (Eventos). Existem dois tipos de eventos enviados pelo PABX para a plataforma Sigma Cloud:
- Controle de Acesso: Evento de portaria / Controle de acesso.
- Alarme: Evento de alarme
Eventos de Controle de Acesso
- Nos campos uniqueId e eventId é enviado o CALLID da chamada em questão. Este valor pode ser utilizado para controlar a chamada com o protocolo CTI do PABX uTech
- Exemplo de evento enviado:
{ "uniqueId":"1602605782.51529", "events": [ { "account":"STRX", "code":"8888", "door":"001", "dweller":"", "eventId":"1602605782.51529", "dateTime":"2020-10-13 16:16:22", "protocolType":"CONTACT_ID", "companyId":"", "complement":"Morador", "doorPhoneExtension":"2001", "partition":"", "phoneExtension":"", "recordingUrl":"\/storage\/13102020\/2001_6566_400000a_16404_c800000a_17840_131622.wav" } ] } |
---|
Se o campo Endereço Público (Menu GESTÃO ⇒ Configuração ⇒ Integrações, aba Geral estiver configurado, o campo recordingUrl será enviado com o o prefixo Endereço Público configurado. Como mostrado no exemplo abaixo :
|
Eventos de Alarme
- Nos campos uniqueId e eventId é enviado o CALLID da chamada em questão. Este valor pode ser utilizado para controlar a chamada com o protocolo CTI do PABX uTech
- Exemplo de evento enviado:
{ "uniqueId":"1602605782.51529", "events": [ { "account":"STRX", "code":"8888", "door":"001", "auxiliary" "1234" "eventId":"1602605782.51529", "dateTime":"2020-10-13 16:16:22", "companyId":"", "partition":"", "complement":"Texto", "protocolType":"CONTACT_ID", "recordingUrl":"\/storage\/13102020\/2001_6566_400000a_16404_c800000a_17840_131622.wav" } ] } |
---|
Se o campo Endereço Público (Menu GESTÃO ⇒ Configuração ⇒ Integrações, aba Geral estiver configurado, o campo recordingUrl será enviado com o o prefixo Endereço Público configurado. Como mostrado no exemplo abaixo :
|
Importando Eventos
Tutorial de como importar eventos no PABX.
- Importando eventos do Sigma Cloud - Importando eventos para integração com Sigma Cloud.