API Omnichannel
Com nossa API, você pode interagir por meio de vários canais para que sua central de contatos esteja sempre conectada.
Lembre-se de que, para usar a API, você precisa
Autenticar e obter um token para a sessão
Usar o token na autorização do cabeçalho
Encerrar a sessão
WhatsApp/SMS
Dentro dessa categoria, podemos executar as seguintes ações:
Envio de WhatsApp/SMS
URL https://dominio.ucontactcloud.com/Integra/resources/SMS/SendSMS
Method: POST
content-type:application/x-www-form-urlencoded; charset=UTF-8
Parâmetros: destination (Número do destino do sms)
message (Mensagem de texto)
campaign (Campanha de saída)
agent (Agente do remetente)
source (Identificador de chamadas ou número da porta)
Result: TEXTO OK
ERRO
Envio de WhatsApp/SMS versão 2
URL https://dominio.ucontactcloud.com/Integra/resources/SMS/SendSMSv2
Method: POST
content-type:application/x-www-form-urlencoded; charset=UTF-8
Parâmetros: destination (Número do destino do sms)
message (Mensagem de texto)
campaign (Campanha de saída)
agent (Agente do remetente)
source (Identificador de chamadas ou número da porta)
Result: TEXT(json) {
id:"{smsId}”
}
Envio via proxy
<script type=“text/javascript” src=“https://cdnjs.cloudflare.com/ajax/libs/porthole/1.0.0/porthole.js”></script>
<script type=“text/javascript”>
função SMS () {
var windowProxy;
windowProxy = new Porthole.WindowProxy(window.location.protocol + window.location.hostname);
windowProxy.post({'action': 'sms', 'campaign' : '<CAMPAIGN>', 'message' : '<MESSAGE>', 'destination' : '<NUMBER>'});
}
</script>
Receber WhatsApp/SMS
URL https://dominio.ucontactcloud.com/Integra/resources/InboundSMS/ReceiveURLSMS
Method: GET
content-type:application/x-www-form-urlencoded; charset=UTF-8
Params: phone (Número de origem do sms)
message (Mensaje de texto)
Result: TEXTO OK
ERRO
Agendar WhatsApp/SMS
O discador de WhatsApp/SMS serve para agendar WhatsAppSMS e o discador será executado no momento certo. Para esse tipo de agendamento, existe um serviço da Web REST que permite isso. E isso é possível a partir de Froms, Workflows ou de sistemas externos.
Basicamente o processo é que existe uma tabela onde estão as chamadas que são agendadas com todas as informações pertinentes.
sms_scheduler
calldate | campaign | phone destiny | data |
---|---|---|---|
data e hora que deve executar a run | test1 | 098344484 | menssagem |
O programador estará colocando no sms_spool com prioridade 1 as mensagens que devem ser executadas naquele minuto, o que fará com que o discador as receba o mais rápido possível para enviar a mensagem, é nomeado com base em Schedule e Date para ver quais são os sms que foram agendados e quando eles devem ser executados para comparar com o sms_repo dateprocessed.
URL relativo: Integra/resources/SMS/ScheduleDialerSMS
Method: POST
content-type:application/x-www-form-urlencoded; charset=UTF-8
Parâmetros: sms (objeto JSON)
Resultado: 1
Json Object
{
“calldate” : ‘2015-10-11 15:00:00’, // Data do Sms
“campaign” : ‘Ventas->’, // Campanha do discador de Sms
“destination” : ‘098344484’, // Destino do Sms
“data” : ‘Message’ // Mensagem de texto de Sms
}
Exemplo:
POST
http://<IP-INTEGRASERVER>/Integra/resources/SMS/ScheduleDialerSMS
param: @FormParam("sms")
(json con formato sms_scheduler)
{
"calldate" : "2015-10-11 15:00:00",
"campaign" : "Vendas->",
"destination" : "098344484",
"data" : "Mensagem"
}
Carregar base WhatsApp/SMS
https://dominio.ucontactcloud.com/Integra/resources/SMS/uploadbase
Método: POST
content-type:application/x-www-form-urlencoded; charset=UTF-8
Parámetros: filename (Nome arquivo)
fileb64 (Conteudo do arquivo em base64)
campaign (Nome da campanha)
Resultado: 1 (Asincrónico)
Formato de arquivo
teste1;098344484;Hola Mundo!;9999
campanha;número;texto;prioridad
El marcador debe estar en fecha y habilitado para poder procesar mensajes, de lo contrario una vez vuelva a estar activo son los primeros en salir.
E-mail
Para email podremos cargar las bases de los Marcadores.
Subir base de Email
https://dominio.ucontactcloud.com/IntegraChannels/resources/DialersResources/uploadDialerBase
Método: POST
content-type:application/x-www-form-urlencoded; charset=UTF-8
Parámetros: filename (Nombre archivo)
fileb64 (Contenido del archivo csv en base64)
channel 'email' (el valor de este parametro siempre será el mismo)
user nombre de usuario
dialer nombre del discador
filter subject del email
cant cantidad de registros
Resultado: 1 (Asincrónico)
Formato de archivo
NombreCampana;ejemplo@gmail.com;Este es un mensaje de ejemplo;;"Var1":"value","Var2":"value";9999
Enviar email
https://dominio.ucontactcloud.com/IntegraChannels/resources/Forms/SendMailv2
Método: POST
content-type:application/x-www-form-urlencoded; charset=UTF-8
Parámetros: body
agent
body: string en formato JSON con la información que se muestra en Integra Framework en el metodo UC_sendMailCampaignv2_async
agent: nombre de agente para guardar en la base de datos
Formato de archivo
NombreCampana;ejemplo@gmail.com;Este es un mensaje de ejemplo;;"Var1":"value","Var2":"value";9999
Colección de postman con ejemplo de llamadas a Envío de WhatsAppSMS.