Veja as diferentes possibilidades que nossa API lhe oferece para integrar o uContact a sistemas externos.

Para usar a API, você precisa:

Autenticar e obter um token para a sessão.
Usar o token no cabeçalho de autorização.
Fazer logout.

Recomenda-se criar um usuário que seja usado exclusivamente com a API do uContact.

Exemplos

Em primeiro lugar, precisamos obter a APIkey. Para isso, usamos o serviço getUserToken com um nome de usuário e uma senha válidos do SuperUser.

Serviço getUserToken

https://dominio.ucontactcloud.com/Integra/resources/auth/getUserToken
Método: POST
content-type:application/x-www-form-urlencoded; charset=UTF-8
Parámetros: user
            password
Resultado: JSON

Supervisor sem telefone

Al final de la lista

[ ...
    "QWRtaW46OTgzNWM1MjUtMzU2Ny00YjgyLWEwYWYtY2NkMjNlMDhjNzA3"
]

Si es Error Respuesta 0

Código de exemplo para jQuery

$.ajax({
  type: 'POST', 
  url: 'https://dominio.ucontactcloud.com/Integra/resources/auth/getUserToken',
  contentType: 'application/x-www-form-urlencoded; charset=UTF-8',
  dataType: 'text',
  data: {
    user: 'ExampleUsername',
    password: 'ExamplePassword'
  },
  success: (resp) => {},
  error: (resp) => {}
});

Depois que você tiver seu token de login, vamos ver como usá-lo nas consultas de API:

O jQuery pode ser configurado para usar o token em todas as solicitações.
Caso contrário, ele pode ser especificado nos cabeçalhos de cada solicitação feita.

Exemplo de configuração de jQuery

$.ajaxSetup({
  headers: {
    'Authorization': "Basic " + APIKey
  }
});

Exemplo de token em cabeçalhos de solicitação

$.ajax({
    type: 'POST',
    url: 'https://dominio.ucontactcloud.com/Integra/resources/any/request',
    contentType: 'application/x-www-form-urlencoded; charset=UTF-8',
    dataType: 'text',
    headers:{
        'Authorization': 'Basic <APIKey>'
    },
    data: {
        param1: 'exampleParam1',
        param2: 'exampleParam2'
    },
    success: (resp) => {},
    error: (resp) => {}
});

Depois de usar a API, é necessário encerrar a sessão. Dessa forma, evitaremos problemas de segurança ao desativar o token gerado no login inicial.

Método

https://dominio.ucontactcloud.com/Integra/resources/auth/EndSession
Method: POST
content-type:application/x-www-form-urlencoded; charset=UTF-8
Params: user
	    token
Result: 1 OK  0 ERROR

Código de exemplo para jQuery

$.ajax({
    type: 'POST',
    url: 'https://dominio.ucontactcloud.com/Integra/resources/auth/EndSession',
    contentType: 'application/x-www-form-urlencoded; charset=UTF-8',
    dataType: 'text',
    headers:{
        'Authorization': 'Basic <APIKey>'
    },
    data: {
        user: 'ExampleUser',
        token: '<token>'
    },
    success: (resp) => {},
    error: (resp) => {}
});

Informações relevante

Todos os WebServices são do tipo REST.
O uContact usa https por padrão (http2).

Conexão entre Domínios

Conexão entre domínios
Com o proxy do Windows, podemos manipular eventos de um iframe inserido em um formulário, para poder fazer disposições, desligar a chamada, fechar o formulário ou o que você quiser, por exemplo. Para fazer isso, não é necessário nenhum plug-in.

Etapas anteriores
No formulário, você deve colocar:

window.addEventListener('message', event => {
    if (event.data.action === 'CLOSE_TAB') {
		parent.closeActiveTab(); 
	} else if (event.data.action === 'DISPOSITION_CALL') {
		let dataDisp = event.data.disposition;
		UC_DispositionCall(dataDisp.campaign, dataDisp.callerid, dataDisp.guid, dataDisp.l1, dataDisp.l2, dataDisp.l3, dataDisp.d1, dataDisp.d2, dataDisp.comment, dataDisp.schedule, callbackDiposition, errorDiposition);
	}   
});

event.data pode ser usado para identificar o tipo de ação.

E o atributo disposition é usado como um objeto para enviar mais informações.

Como solicita-lô?

A maneira de solicitar é:

let dataDisp = {
	 campaign: 'CampañaTest',
	 callerid: '123456Test',
	 guid:'3123-3123-3123-312-3123',
	 l1:'nivel1',
	 l2:'nivel2',
	 l3:'nivel3',
	 d1:'data1',
	 d2:'data2',
	 comment:'ComentarioTest',
	 schedule:'2019-05-04 15:55:55'
};

window.parent.postMessage({ action: 'DISPOSITION_CALL', disposition:dataDisp}, '*');

Criação de tokens

Os usuários com a função “SuperUser” no uContact têm a funcionalidade de criar tokens para uso fora do aplicativo. Para criar um token, siga estas etapas:

Acesse o menu do usuário.
Selecione a opção “API tokens” no menu suspenso e um modal será aberto para sua criação.
Digite o nome que você deseja usar para identificar o token e clique no botão “Save” (Salvar) para criar um novo token.
Depois que um token for criado no uContact, os “SuperUser” poderão compartilhá-lo com outros usuários. Para isso, basta clicar no ícone de clipe. Isso copiará automaticamente o token para a área de transferência e ele poderá ser enviado para qualquer pessoa com quem você queira compartilhá-lo.

API

API Omnichannel

API Telefonia

API Outras ações

API Gamification

Base de Dados

Exemplos

Serviço getUserToken

Supervisor sem telefone

Código de exemplo para jQuery

Exemplo de configuração de jQuery

Exemplo de token em cabeçalhos de solicitação

Método

Código de exemplo para jQuery

Informações relevante

Conexão entre Domínios

Criação de tokens

Links de interesse

Subir base de chamadas

Webcallback

Gravações

Coleção Postman para login e logout.