Este documento foi atualizado para uso com a versão 1.25.1 do USCall UC, antes de utilizar a API consulte a versão do sistema.
Informamos que a API SOAP do USCall será descontinuada, e a partir dessa data não haverá mais suporte para integrações que utilizem esse padrão.
O que você precisa fazer:
Solicitamos que sua equipe técnica verifique com urgência se a integração atualmente utilizada com o USCall está baseada no protocolo SOAP. Caso positivo, é necessário migrar para o padrão RESTful o quanto antes.Prazo para migração:
📅 Até 31/12/2026
Este documento tem como objetivo auxiliar o uso da API de integração do USCall UC, para integração com softwares de terceiros através do Webservice USCall UC.
A comunicação é realizada através de requisições WEB utlizando o protocolo HTTPS (Hypertext Transfer Protocol Secure), na arquitetura SOAP (Simple Object Access Protocol), ou na arquitetura RESTful (Representational State Transfer).
Todas as resposta das requisições são retornadas no formato JSON (JavaScript Object Notation).
Todas as requisições necessitam de um token de autenticação, este token é gerado e mantido pelo administrador do sistema, e deve ser solicitado ao mesmo.
Abaixo estão exemplos de requisições, iniciando a rota startCall para efetuar uma chamada para o número 1139952800, e após o número atender direcionar para o DDR 2800, linguagem de programação PHP:
Na arquitetura SOAP, as rotas disponíveis e parâmetros de uso, podem ser consultadas diretamente no endereço do host USCall, através da URL:
https://{host uscall}/aplicativos/webservice/wsuscall.php
<?php
ini_set("soap.wsdl_cache_enabled", 0);
$context = stream_context_create([
'ssl' => [
'verify_peer' => false,
'verify_peer_name' => false,
'allow_self_signed' => true ]
]);
$client = new SoapClient(
'https://uscall.com.br/aplicativos/webservice/wsuscall.php?wsdl',
['stream_context' => $context ]
);
$result = $client->startCall(
'$1$gcNiVTZp$5IqX.EhuJyLNG7pBc5o4..',
'clicktocall',
'1139952800',
'2800',
'1'
);
var_dump($result);
Na arquitetura RESTful, o endereço da URL de consulta é : https://{host uscall}/api/{rota} :
<?php
$api_url = "https://uscall.com.br/api/";
$api_route = 'startcall';
$post_data = array(
'token' => '$1$gcNiVTZp$5IqX.EhuJyLNG7pBc5o4..',
'tipo' => 'clicktocall',
'origem' => '1139952800',
'destino' => '2800',
'categoria' => '1',
);
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $api_url.$api_route);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, $post_data);
$response = curl_exec($ch);
if (curl_errno($ch)) {
echo 'Erro ao fazer a requisição: ' . curl_error($ch);
}
curl_close($ch);
var_dump($response);
POST | GET /getextens
curl --location 'https://uscall.uniontelecom.com.br/api/getextens' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{"token":"$1$ynCJpj5r$1iwa.5loouZP4NTqBF9uG1"}'
Esta rota é utilizada para listar os ramais cadastrados no sistema.
Request
POST Body | GET params
token string required
Exemplo: "ynCJpj5r$1iwa.5loouZP4NTqBF9uG1"
ramal string
Exemplo: 2000 ,"2000-2005"
POST | GET /extenstatus
curl --location 'https://uscall.uniontelecom.com.br/api/extenstatus' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{"token":"$1$ynCJpj5r$1iwa.5loouZP4NTqBF9uG1",
"ramal": "2000-2002"}'
Esta rota é utilizada para visualizar o status dos ramais do sistema, tais dados de chamdas em curso e registro.
Request
POST Body | GET params
token string required
Exemplo: "ynCJpj5r$1iwa.5loouZP4NTqBF9uG1"
ramal string
Exemplo: 2000 ,"2000-2005"
POST | GET /monitexten
curl --location 'https://uscall.uniontelecom.com.br/api/monitexten' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"token": "$1$ynCJpj5r$1iwa.5loouZP4NTqBF9uG1",
"src": 2000,
"dst": 2001
}'
Esta rota é utilizada para monitorar uma chamada em curso de um ramal e/ou atendente de contac center.
Request
POST Body | GET params
token string required
Exemplo: "ynCJpj5r$1iwa.5loouZP4NTqBF9uG1"
src string
Exemplo: 2000
dst string required
Exemplo: 2001
tipo string required
Exemplo: escuta
POST | GET /hangupcall
curl --location 'https://uscall.uniontelecom.com.br/api/hangupcall' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"token": "$1$ynCJpj5r$1iwa.5loouZP4NTqBF9uG1",
"ramal": 2000
}'
Esta rota é utilizada para desconectar uma chamada em curso de um ramal e/ou atendente de contac center.
Request
POST Body | GET params
token string required
Exemplo: "ynCJpj5r$1iwa.5loouZP4NTqBF9uG1"
ramal string
Exemplo: 2000 ,"2000-2005"
agente string
Exemplo: yes
POST | GET /listura
curl --location 'https://uscall.uniontelecom.com.br/api/listura' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"token": "$1$ynCJpj5r$1iwa.5loouZP4NTqBF9uG1"
}'
Esta rota é utilizada para listar as URAS dinâmicas (com sintetizado de voz) cadastradas no PBX.
Request
POST Body | GET params
token string required
Exemplo: "ynCJpj5r$1iwa.5loouZP4NTqBF9uG1"
idura int
Exemplo: 84
POST | GET /startcallura
curl --location 'https://uscall.uniontelecom.com.br/api/startcallura' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"token": "$1$ynCJpj5r$1iwa.5loouZP4NTqBF9uG1",
"idura": 1,
"destino": 2804,
"categoria": 1,
"idcti": 2804578965475,
"cti_info": ["numero", "nasnasdn"]
}'
Esta rota é utilizada para efetuar uma chamada para um número e após atendimento, direcionar para uma URA de atendimento dinâmica.(ura Reversa)
Request
POST Body | GET params
token string required
Exemplo: "ynCJpj5r$1iwa.5loouZP4NTqBF9uG1"
idura number required
Exemplo: 1
destino string required
Exemplo: "2804"
categoria number required
Exemplo: 1
idcti string
Exemplo: "2804578965475"
cti_info array[string]
Exemplo: ["numero", "nasnasdn"]
POST | GET /startcall
curl --location 'https://uscall.uniontelecom.com.br/api/startcall' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"token": "$1$ynCJpj5r$1iwa.5loouZP4NTqBF9uG1",
"tipo": "clicktocall",
"origem": "011912345678",
"destino": "2001",
"categoria": 1
}'
Esta rota é utilizada para efetuar uma chamada para um número e após atendimento, direcionar para uma URA de atendimento dinâmica.(ura Reversa)
Request
POST Body | GET params
token string required
Exemplo: "ynCJpj5r$1iwa.5loouZP4NTqBF9uG1"
tipo string required
Define o tipo de chamada a ser realizada. Valores aceitos:
outbound Utilizado para efetuar uma ligação ativa por um ramal. No parâmetro origem deve ser informado o número do ramal, e no parâmetro destino o número que será discado.
clicktocall Utilizado para efetuar uma discagem para um número e direcionar para um DDR configurado no USCall. No parâmetro origem deve ser informado o número que será discado, e no parâmetro destino o número de DDR que irá receber a ligação.
Exemplo: "clicktocall"
origem string required
Número de origem da chamada. O formato e o significado variam conforme o tipo:
outbound Número do ramal que irá realizar a ligação.
clicktocall Número que será discado.
Exemplo: "011968936973"
destino string required
Número de destino da chamada. O formato e o significado variam conforme o tipo:
outbound Número que será discado.
clicktocall Número de DDR que irá receber a ligação.
Exemplo: "2001"
categoria number required
Categoria com regras de discagem no PBX. O formato do número de discagem deve estar de acordo com as regras cadastradas na categoria informada. Consulte o mantenedor para saber qual número usar.
Exemplo: 1
idcti string
ID gerado pelo integrador para buscas e consultas de registro da chamada.
Exemplo: "2804578965475"
POST | GET /transfercall
curl --location 'https://uscall.uniontelecom.com.br/api/transfercall' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"token": "$1$ynCJpj5r$1iwa.5loouZP4NTqBF9uG1",
"destino": 2001,
"origem": 2000
}'
token string required
Exemplo: "ynCJpj5r$1iwa.5loouZP4NTqBF9uG1"
origem number required
Exemplo: 2000
destino number required
Exemplo: 2001
POST | GET /listtrunk
curl --location 'https://uscall.uniontelecom.com.br/api/listtrunk' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"token": "$1$ynCJpj5r$1iwa.5loouZP4NTqBF9uG1"
}'
token string required
Exemplo: "ynCJpj5r$1iwa.5loouZP4NTqBF9uG1"
POST | GET /cdrsearch
curl --location 'https://uscall.uniontelecom.com.br/api/cdrsearch' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"token": "$1$ynCJpj5r$1iwa.5loouZP4NTqBF9uG1",
"dataini": "2026-01-01 00:00:00",
"datafin": "2026-01-31 23:59:59",
"origem": "2000",
"destino": "2001",
"bilheteunico": "2804578965475"
}'
Request
POST Body | GET params
Esta rota é utilizada para efetuar uma busca dos registros de chamadas do PBX.
token string required
Exemplo: "1ynCJpj5r$1iwa.5loouZP4NTqBF9uG1"
dataini string
Exemplo: "2026-01-01 00:00:00"
datafin string
Exemplo: "2026-01-31 23:59:59"
origem string
Exemplo: "2000"
destino string
Exemplo: "2001"
bilheteunico string
Exemplo: "2804578965475"
POST | GET /cdrura
curl --location 'https://uscall.uniontelecom.com.br/api/cdrura' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"token": "$1$ynCJpj5r$1iwa.5loouZP4NTqBF9uG1",
"dataini": "2026-01-01 00:00:00",
"datafin": "2026-01-31 23:59:59",
"idura": 1,
"idunico": "2804578965475"
}'
Request
POST Body | GET params
Esta rota é utilizada para consultar os registro de chamadas que entraram nas URAS de atendimento dinâmicas.
token string required
Exemplo: "1ynCJpj5r$1iwa.5loouZP4NTqBF9uG1"
dataini string
Exemplo: "2026-01-01 00:00:00"
datafin string
Exemplo: "2026-01-31 23:59:59"
idura number
Exemplo: 1
idunico string
Exemplo: "2804578965475"
POST | GET /cdrtariff
curl --location 'https://uscall.uniontelecom.com.br/api/cdrtariff' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"token": "$1$ynCJpj5r$1iwa.5loouZP4NTqBF9uG1",
"dataini": "2026-01-01 00:00:00",
"datafin": "2026-01-31 23:59:59"
}'
Request
POST Body | GET params
Esta rota é utilizada para listar os registros de chamadas efetuadas no PBX, para uso com tarifadores.
token string required
Exemplo: "1ynCJpj5r$1iwa.5loouZP4NTqBF9uG1"
dataini string
Exemplo: "2026-01-01 00:00:00"
datafin string
Exemplo: "2026-01-31 23:59:59"
POST | GET /audiodownload
curl --location 'https://uscall.uniontelecom.com.br/api/audiodownload' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"token": "$1$ynCJpj5r$1iwa.5loouZP4NTqBF9uG1",
"idunico": "2804578965475",
"formato": "mp3"
}'
Request
POST Body | GET params
Esta rota é utilizada para baixar uma gravação de chamada. O áudio é retornado codificado em base64 no campo arquivo_base_64.
token string required
Exemplo: "1ynCJpj5r$1iwa.5loouZP4NTqBF9uG1"
id string required
Exemplo: "2804578965475"
formato string
Exemplo: "mp3"
POST | GET /getagent
curl --location 'https://uscall.uniontelecom.com.br/api/getagent' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{"token":"$1$ynCJpj5r$1iwa.5loouZP4NTqBF9uG1"}'
Esta rota é utilizada para listar os atendentes de contact center cadastrados na empresa.
Request
POST Body | GET params
token string required
Exemplo: "ynCJpj5r$1iwa.5loouZP4NTqBF9uG1"
agente string
Exemplo: "601" range "601-610"
POST | GET /agentelogin
curl --location 'https://uscall.uniontelecom.com.br/api/agentlogin' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"token": "$1$ynCJpj5r$1iwa.5loouZP4NTqBF9uG1",
"agente": "agente@uniontelecom.com.br",
"ramal": "2000",
"senha": "81dc9bdb52d04dc20036dbd8313ed055",
"midia": true
}'
Esta rota é utilizada para iniciar a sessão de um atendente de contact center no sistema.
Request
POST Body | GET params
token string required
Exemplo: "ynCJpj5r$1iwa.5loouZP4NTqBF9uG1"
agente string
Exemplo: número do agente ou email cadastrado
ramal string
Exemplo: 2000
senha string
Exemplo: "81dc9bdb52d04dc20036dbd8313ed055"
midia boolean
Example: true
POST | GET /agentelogout
curl --location 'https://uscall.uniontelecom.com.br/api/agentelogout' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"token": "$1$ynCJpj5r$1iwa.5loouZP4NTqBF9uG1",
"agente": 602
}'
Esta rota é utilizada para logout de agentes.
Request
POST Body | GET params
token string required
Exemplo: "ynCJpj5r$1iwa.5loouZP4NTqBF9uG1"
agente string
Exemplo: número do agente
POST | GET /agentstatus
curl --location 'https://uscall.uniontelecom.com.br/api/agentstatus' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data '{
"token": "$1$ynCJpj5r$1iwa.5loouZP4NTqBF9uG1",
"agente": 601
}'
Esta rota é utilizada para consultar o status de trabalho dos atendentes de contact center, tais como chamadas em curso, pausas entre outros.
Request
POST Body | GET params
token string required
Exemplo: "ynCJpj5r$1iwa.5loouZP4NTqBF9uG1"
agente string
Exemplo: 600 ,"600-610"
POST | GET /getpauses
curl --location 'https://uscall.uniontelecom.com.br/api/getpauses' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"token": "$1$ynCJpj5r$1iwa.5loouZP4NTqBF9uG1"
}'
Esta rota é utilizada para consultar as pausas do contac center cadastradas no sistema.
Resquest
POST Body | GET params
token string required
Exemplo: "ynCJpj5r$1iwa.5loouZP4NTqBF9uG1"
POST | GET /startpause
curl --location 'https://uscall.uniontelecom.com.br/api/startpause' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"token": "$1$ynCJpj5r$1iwa.5loouZP4NTqBF9uG1",
"pauseid": 4,
"agente": 600
}'
Esta rota é utilizada para pausar um atendente de contact center.
Request
POST Body | GET params
token string required
Exemplo: "ynCJpj5r$1iwa.5loouZP4NTqBF9uG1"
agente string required
Exemplo: 600
pauseid int required
Exemplo: 4
POST | GET /endpause
curl --location 'https://uscall.uniontelecom.com.br/api/endpause' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"token": "$1$ynCJpj5r$1iwa.5loouZP4NTqBF9uG1",
"agente": 600
}'
Request
Esta rota é utilizada para encerrar uma pausa de um atendente de contact center.
POST Body | GET params
Request
POST Body | GET params
token string required
Exemplo: "ynCJpj5r$1iwa.5loouZP4NTqBF9uG1"
POST | GET /getqueue
curl --location 'https://uscall.uniontelecom.com.br/api/getqueue' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"token": "$1$ynCJpj5r$1iwa.5loouZP4NTqBF9uG1"
}'
Request
POST Body | GET params
Esta rota é utilizada para listar as filas de atendimento cadastradas no sistema.
token string required
Exemplo: "$1$ynCJpj5r$1iwa.5loouZP4NTqBF9uG1"
fila number
Exemplo: 1
POST | GET /queuestatus
curl --location 'https://uscall.uniontelecom.com.br/api/queuestatus' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"token": "$1$ynCJpj5r$1iwa.5loouZP4NTqBF9uG1"
}'
Request
POST Body | GET params
Esta rota é utilizada para listar as chamadas em espera nas filas de atendimento e dados de status.
token string required
Exemplo: "11ynCJpj5r$1iwa.5loouZP4NTqBF9uG1"
fila number
Exemplo: 900
POST | GET /ccentercdr
curl --location 'https://uscall.uniontelecom.com.br/api/ccentercdr' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"token": "$1$ynCJpj5r$1iwa.5loouZP4NTqBF9uG1",
"agente": [600, 601, 602],
"fila": [900, 901, "Ativo"],
"dataini": "2026-01-01 00:00:00",
"datafin": "2026-01-31 23:59:59"
}'
Request
POST Body | GET params
Esta rota é utilizada para consultar o relatório detalhado de contatos recebidos e efetuados nas operações de contact center.
token string required
Exemplo: "11ynCJpj5r$1iwa.5loouZP4NTqBF9uG1"
agente string/JSON required
Exemplo: [600, 601, 602]
fila string/JSON required
Exemplo: [900, 901, "Ativo"]
dataini string
Exemplo: "2026-01-01 00:00:00"
datafin string
Exemplo: "2026-01-31 23:59:59"
POST | GET /reportqueuesummary
curl --location 'https://uscall.uniontelecom.com.br/api/reportqueuesummary' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"token": "$1$ynCJpj5r$1iwa.5loouZP4NTqBF9uG1",
"fila": [900, 901, "Ativo"],
"dataini": "2026-01-01 00:00:00",
"datafin": "2026-01-31 23:59:59"
}'
Request
POST Body | GET params
Esta rota é utilizada para consultar um relatório sintético, com dados de chamadas gerais em filas de atendimento do sistema.
token string required
Exemplo: "$1ynCJpj5r$1iwa.5loouZP4NTqBF9uG1"
fila string/JSON
Exemplo: [900, 901, "Ativo"]
dataini string
Exemplo: "2026-01-01 00:00:00"
datafin string
Exemplo: "2026-01-31 23:59:59"
POST | GET /ccentermetrics
curl --location 'https://uscall.uniontelecom.com.br/api/ccentermetrics' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"token": "$1$ynCJpj5r$1iwa.5loouZP4NTqBF9uG1",
"report_name": "chamadas_atendidas",
"agente": [600, 601, 602],
"fila": [900, 901, "Ativo"],
"dataini": "2026-01-01 00:00:00",
"datafin": "2026-01-31 23:59:59"
}'
Request
POST Body | GET params
Esta rota é utilizada para consultar as métricas e estatísticas do contact center.
token string required
Exemplo: "1ynCJpj5r$1iwa.5loouZP4NTqBF9uG1"
report_name string required
Exemplo: "chamadas_atendidas"
agente string/JSON required
JSON com numeração dos atendentes de contact center, para filtrar os registros pelos atendentes informados. Consulte a rota getagent para consultar a numeração dos atendentes cadastrados.
Exemplo: [600, 601, 602]
fila string/JSON required
Exemplo: [900, 901, "Ativo"]
dataini string
Exemplo: "2026-01-01 00:00:00"
datafin string
Exemplo: "2026-01-31 23:59:59"
POST | GET /ccentersessions
curl --location 'https://uscall.uniontelecom.com.br/api/ccentersessions' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"token": "$1$ynCJpj5r$1iwa.5loouZP4NTqBF9uG1",
"report_type": 0,
"agente": [600, 601, 602],
"fila": [900, 901, "Ativo"],
"dataini": "2026-01-01 00:00:00",
"datafin": "2026-01-31 23:59:59"
}'
Request
POST Body | GET params
Esta rota é utilizada para consultar o relatório de presença/sessões dos atendentes do contact center.
token string required
Exemplo: "1ynCJpj5r$1iwa.5loouZP4NTqBF9uG1"
report_type number required
Exemplo: 0
agente string/JSON required
Exemplo: [600, 601, 602]
fila string/JSON required
Exemplo: [900, 901, "Ativo"]
dataini string
Exemplo: "2026-01-01 00:00:00"
datafin string
Exemplo: "2026-01-31 23:59:59"
POST | GET /ccenterpauses
curl --location 'https://uscall.uniontelecom.com.br/api/ccenterpauses' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"token": "$1$ynCJpj5r$1iwa.5loouZP4NTqBF9uG1",
"report_type": 0,
"agente": [600, 601, 602],
"fila": [900, 901, "Ativo"],
"dataini": "2026-01-01 00:00:00",
"datafin": "2026-01-31 23:59:59"
}'
POST Body | GET params
Esta rota é utilizada para consultar o relatório de pausas dos atendentes do contact center.
token string required
Token de autenticação da empresa.
Exemplo: "1ynCJpj5r$1iwa.5loouZP4NTqBF9uG1"
report_type number required
Exemplo: 0
agente string/JSON required
Exemplo: [600, 601, 602]
fila string/JSON required
Exemplo: [900, 901, "Ativo"]
dataini string
Exemplo: "2026-01-01 00:00:00"
datafin string
Buscar registros até esta data e horário. Formato TIMESTAMP YYYY-mm-dd H:i:s. Caso não informado, será usado data do dia às 23:59.
Exemplo: "2026-01-31 23:59:59"
POST | GET /ccenteragents
curl --location 'https://uscall.uniontelecom.com.br/api/ccenteragents' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"token": "$1$ynCJpj5r$1iwa.5loouZP4NTqBF9uG1",
"agente": [600, 601, 602],
"fila": [900, 901, "Ativo"],
"dataini": "2026-01-01 00:00:00",
"datafin": "2026-01-31 23:59:59"
}'
Request
POST Body | GET params
Esta rota é utilizada para consultar o relatório de produtividade dos atendentes do contact center.
token string required
Exemplo: "1ynCJpj5r$1iwa.5loouZP4NTqBF9uG1"
agente string/JSON required
Exemplo: [600, 601, 602]
fila string/JSON required
Exemplo: [900, 901, "Ativo"]
dataini string
Exemplo: "2026-01-01 00:00:00"
datafin string
Exemplo: "2026-01-31 23:59:59"
POST | GET /ccentersurvey
curl --location 'https://uscall.uniontelecom.com.br/api/ccentersurvey' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"token": "$1$ynCJpj5r$1iwa.5loouZP4NTqBF9uG1",
"dataini": "2026-01-01 00:00:00",
"datafin": "2026-01-31 23:59:59",
"agente": [600, 601, 602],
"fila": [900, 901, "Ativo"]
}'
Request
POST Body | GET params
Esta rota é utilizada para consultar o relatório detalhado de avaliações de pesquisas do contact center.
token string required
Exemplo: "1ynCJpj5r$1iwa.5loouZP4NTqBF9uG1"
dataini string
Exemplo: "2026-01-01 00:00:00"
datafin string
Exemplo: "2026-01-31 23:59:59"
agente string/JSON
Exemplo: [600, 601, 602]
fila string/JSON
Exemplo: [900, 901, "Ativo"]
POST | GET /ccenterschedules
curl --location 'https://uscall.uniontelecom.com.br/api/ccenterschedules' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"token": "$1$ynCJpj5r$1iwa.5loouZP4NTqBF9uG1",
"dataini": "2026-01-01 00:00:00",
"datafin": "2026-01-31 23:59:59",
"agente": [600, 601, 602]
}'
Request
POST Body | GET params
Esta rota é utilizada para consultar os agendamentos dos atendentes do contact center.
token string required
Exemplo: "1ynCJpj5r$1iwa.5loouZP4NTqBF9uG1"
dataini string
Exemplo: "2026-01-01 00:00:00"
datafin string
Exemplo: "2026-01-31 23:59:59"
agente string/JSON
Exemplo: [600, 601, 602]
POST | GET /ccenterattendforms
curl --location 'https://uscall.uniontelecom.com.br/api/ccenterattendforms' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"token": "$1$ynCJpj5r$1iwa.5loouZP4NTqBF9uG1",
"agente": [600, 601, 602],
"fila": [900, 901, "Ativo"],
"dataini": "2026-01-01 00:00:00",
"datafin": "2026-01-31 23:59:59"
}'
Request
POST Body | GET params
Esta rota é utilizada para consultar o relatório detalhado de contatos das operações do contact center, com formulários de atendimentos e qualificações.
token string required
Exemplo: "1ynCJpj5r$1iwa.5loouZP4NTqBF9uG1"
agente string/JSON
Exemplo: [600, 601, 602]
fila string/JSON
Exemplo: [900, 901, "Ativo"]
dataini string
Exemplo: "2026-01-01 00:00:00"
datafin string
Exemplo: "2026-01-31 23:59:59"
POST | GET /ccentermetricsreports
curl --location 'https://uscall.uniontelecom.com.br/api/ccentermetricsreports' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"token": "$1$ynCJpj5r$1iwa.5loouZP4NTqBF9uG1"
}'
Request
POST Body | GET params
Esta rota é utilizada para consultar os tipos de relatórios disponíveis para uso na rota ccentermetrics.
token string required
Exemplo: "1ynCJpj5r$1iwa.5loouZP4NTqBF9uG1"
POST | GET /chat/chat_history
curl --location 'https://uscall.uniontelecom.com.br/api/chat/chat_history' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"token": "$1$ynCJpj5r$1iwa.5loouZP4NTqBF9uG1",
"chat": "abc123def456",
"agente": 600,
"data_start": "2026-01-01 00:00:00",
"data_end": "2026-01-31 23:59:59"
}'
Request
POST Body | GET params
Esta rota é utilizada para consultar o histórico de um chat, no serviço omnichannel.
token string required
Exemplo: "1ynCJpj5r$1iwa.5loouZP4NTqBF9uG1"
chat string
Exemplo: "abc123def456"
agente number
Exemplo: 600
data_start string
Exemplo: "2026-01-01 00:00:00"
data_end string
Exemplo: "2026-01-31 23:59:59"
POST | GET /chat/chat_new
curl --location 'https://uscall.uniontelecom.com.br/api/chat/chat_new' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"token": "$1$ynCJpj5r$1iwa.5loouZP4NTqBF9uG1",
"agente": 600,
"numero": "11968936973",
"midia": 1,
"template_message": "boas_vindas"
}'
Request
POST Body | GET params
Esta rota é utilizada para iniciar um novo contato por chat, e direcionar para um atendente do serviço omnichannel.
token string required
Exemplo: "1ynCJpj5r$1iwa.5loouZP4NTqBF9uG1"
agente number required
Exemplo: 600
numero number required
Exemplo: "11968936973"
midia number
Exemplo: 1
template_message string required
Exemplo: "boas_vindas"
POST | GET /chat/chats_midias
curl --location 'https://uscall.uniontelecom.com.br/api/chat/chats_midias' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"token": "$1$ynCJpj5r$1iwa.5loouZP4NTqBF9uG1",
"agente": 600
}'
Request
POST Body | GET params
Esta rota é utilizada para listar os canais de mídias do serviço omnichannel.
token string required
Exemplo: "1ynCJpj5r$1iwa.5loouZP4NTqBF9uG1"
agente number
Exemplo: 600
Parâmetros obrigatórios:
POST | GET /chat/chats_templates
curl --location 'https://uscall.uniontelecom.com.br/api/chat/chats_templates' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"token": "$1$ynCJpj5r$1iwa.5loouZP4NTqBF9uG1",
"id_media": 1
}'
Request
POST Body | GET params
Esta rota é utilizada listar os modelos de mensagens em canais de mídias do tipo WhatsApp Oficial do serviço omnichannel.
token string required
Exemplo: "1ynCJpj5r$1iwa.5loouZP4NTqBF9uG1"
id_media number required
Exemplo: 1
POST | GET /chat/chat_new_chatbot
curl --location 'https://uscall.uniontelecom.com.br/api/chat/chat_new_chatbot' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"token": "$1$ynCJpj5r$1iwa.5loouZP4NTqBF9uG1",
"midia": 75,
"chatbot": 62,
"numero": 11999999999,
"template_message": "avaliacao_0km",
"parameters": {
"header": [
{
"type": "text",
"text": "Teruhiko"
}
],
"body": [
{
"type": "text",
"text": "Teruhiko"
},
{
"type": "text",
"text": "https://search.google.com/local/writereview?placeid=ChIJY3B9GUP_zpQRnodJszC4FaE"
}
]
}
}'
Request
POST Body | GET params
Esta rota é utilizada para iniciar um novo contato por chat, e direcionar para um chatbot do serviço omnichannel.
token string required
Exemplo: "1ynCJpj5r$1iwa.5loouZP4NTqBF9uG1"
chatbot int required
Exemplo: 1
numero int required
Exemplo: "11968936973"
midia int required
Exemplo: 1
template_message mixed required
Exemplo: "boas_vindas"
parameters array[json]
POST | GET /chat/users_id
curl --location 'https://uscall.uniontelecom.com.br/api/chat/users_id' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"token": "$1$ynCJpj5r$1iwa.5loouZP4NTqBF9uG1"
}'
Request
POST Body | GET params
Esta rota é utilizada listar agentes do serviço omnichannel.
token string required
Exemplo: "1ynCJpj5r$1iwa.5loouZP4NTqBF9uG1"
agente number
Exemplo: 600
POST | GET /chat/chat_templates_wpp
curl --location 'https://uscall.uniontelecom.com.br/api/chat/chat_templates_wpp' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"token": "$1$ynCJpj5r$1iwa.5loouZP4NTqBF9uG1",
"midia": 1,
"template": "boas_vindas"
}'
Request
POST Body | GET params
Esta rota é utilizada listar os templates criados na midia
token string required
Exemplo: "1ynCJpj5r$1iwa.5loouZP4NTqBF9uG1"
midia number required
Exemplo: 1
template string
Exemplo: boas_vindas
POST | GET /chat/chat_template_save
curl --location 'https://uscall.uniontelecom.com.br/api/chat/chat_template_save' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"token": "$1$ynCJpj5r$1iwa.5loouZP4NTqBF9uG1",
"midia": 1,
"name": "inicio_conversa",
"language": "pt_BR",
"category": "MARKETING",
"template_type": "default",
"components": [
{ "type": "HEADER", "format": "TEXT", "text": "olá, tudo bem?" },
{ "type": "BODY", "text": "pode falar?" },
{ "type": "FOOTER", "text": "estamos a disposição" },
{ "type": "BUTTONS",
"buttons": [
{ "type": "QUICK_REPLY", "text": "Sim quero falar" },
{ "type": "URL", "text": "Clique aqui", "url": "https://www.example.com/promo" },
{ "type": "PHONE_NUMBER", "text": "Ligue agora", "phone_number": "+5511987654321" }
]}
]
}'
Request
POST Body | GET params
Esta rota é utilizada listar os templates criados na midia
token string required
Exemplo: "1ynCJpj5r$1iwa.5loouZP4NTqBF9uG1"
midia number required
Exemplo: 1
name string required
Exemplo: "boas_vindas"
category string required
Exemplo: "MARKETING"
template_type string required
Exemplo: "default"
language array[json] required
Exemplo: "pt_BR"
components array[json] required
Exemplo: "default"