Graças as APIs desenvolvidas pela VTCall é possível integrar os mais diversos tipos de aplicativos e sistemas utilizando as mais variadas linguagens de programação disponíveis.
Por motivo de segurança, todas as requisições devem conter o cabeçalho access-token para que sejam aceitas.
- access-token: Chave de identificação de permissão de acesso a plataforma.Sua chave de token é obtida em >Ajustes >Avançadas >Segurança (Token)
- start_date: Início do período de consulta. Deve estar obrigatoriamente no formato YYYY-MM-DD e ser inferior ou igual ao término do período de consulta (end_date) * Utilizando T após a data seguido do horário, o sistema retorna ligações 2 minutos antes e 2 minutos após. Ex: 2016-09-16T08-15-00, retorna entre: 8:13 e 8:17. IMPORTANTE: O campo end_date deve estar em branco (exemplo: 2016-09-16 ou 2016-09-16T08-00-01).
- end_date: Término do período de consulta. Deve estar obrigatoriamente no formato YYYY-MM-DD e ser superior ou igual ao início do período de consulta (start_date) (exemplo: 2016-01-16).
- origem: Numero que foi originado pela ligação (exemplo: 100).
- destino: Numero que foi o destino da ligação (exemplo 200).
- page: Número da página do relatório consultado. Deve ser um número inteiro maior que 0. Quando não fornecido, o seu valor será de 1 (exemplo: 1).
- per: Número de registros a serem exibidos por página. Quando não fornecido, o seu valor será de 10 (exemplo:10).
- ( * ) Caso necessário fazer uma consulta mais especifica, exemplo YYYY-MM-DDThh-mm (exemplo: 2023-01-16T08-20), essa consulta buscar todos do mesmo dia respeitando a hora e os minutos, é necessário manter o parâmetro end_date, em branco.
¶ Realizando pesquisa através do linkedid
Parâmetro (query)
- linkedid: O linkedid é o id da chamada, onde cada conjunto de ligações possuem o mesmo numero
- 200 - Success: A consulta aos relatórios foi executada com sucesso.
- 400 - Bad Request: Parâmetros incorretos ou não encontrados. Veja a mensagem de erro para mais detalhes.
- 401 - Unauthorized: O token da API está incorreto ou ausente. Veja a mensagem de erro para mais detalhes.
- 500 - Internal Server Error: Erro interno inesperado na API. Tente novamente em alguns minutos e se persistir contate o suporte.
Ao efetuar a consulta, o API retorna as seguintes informações:
- time: Data e hora da ligação.
- origem: Número que originou a chamada, podendo ser um ramal ou número externo.
- destino: Número que recebeu a chamada, podendo ser um ramal ou número externo
- tempo_ligacao: O tempo total da ligação em horas (Formato: hh:mm:ss).
- linkedid: Identificador da ligação.
- from_did: Linha a qual entrou a chamada.
- status: Status da ligação, como ATENDIDA, ABANDONADA, OCUPADO.
- audio: Link completo da ligação. Normalmente nas primeiras 24hs a gravação se encontra na extensão wav. Após esse período é provável que seja alterada em definitivo para mp3.
Para melhorar performance, o API permite a utilização de paginação, onde no final do retorno da consulta, sistema retorna:
- next: Link para a página seguinte.
- prev: Link para a página anterior.
- first: Link para a primeira página.
- last: Link para a última página do relatório.
GET http://www4.vtcall.com.br/API/ligacoes?page=2&start_date=2016-08-10&end_date=2016-08-11&per=2
access_token: 7sd6g8f7sdg78fsdg7fsdggfdgfg4564
RESPOSTA:
Status: 200 Sucess
Location: http://www4.vtcall.com.br/API/ligacoes?page=2&start_date=2016-08-10&end_date=2016-08-11&per=2
{
"data": [
{
"time": "11/08/2016 19:55:06",
"origem": "21983756993",
"destino": "104 - Fabio Renato",
"tempo_ligacao": "00:05:48",
"linkedid": "1501259442.144",
"from_did": "3308",
"status": "ATENDIDA",
"audio": "http://www4.vtcall.com.br/API/ligacoes/caminho/arquivo.wav"
},
{
"time": "11/08/2016 18:26:40",
"origem": "2125046002",
"destino": "104 - Fabio Renato",
"tempo_ligacao": "00:03:24",
"linkedid": "1501259442.144",
"from_did": "3308",
"status": "ATENDIDA",
"audio": "http://www4.vtcall.com.br/API/ligacoes/caminho/arquivo.mp3"
}
],
"links": {
"next": "http://www4.vtcall.com.br/API/ligacoes?page=2&start_date=2016-08-10&end_date=2016-08-11&per=2",
"prev": null,
"first": "http://www4.vtcall.com.br/API/ligacoes?page=2&start_date=2016-08-10&end_date=2016-08-11&per=2",
"last": "http://www4.vtcall.com.br/API/ligacoes?page=2&start_date=2016-08-10&end_date=2016-08-11&per=2"
}
}