Documentação pra Integrações (API) Versão 1.0.0

  1. Home
  2. API

Introdução

Graças as APIs desenvolvidas pela VTCALL é possível integrar os mais diversos tipos de aplicativos, sistemas em cima das mais variadas linguagens de programação disponíveis.

Autenticação

Por motivo de segurança, todas as requisições devem conter o cabeçalho access_token para que sejam aceitas.

O seguinte token é esperado em cada requisição: 

		access_token: Chave de identificação de permissão de acesso a plataforma. 
		Sua chave de token deve ser solicitado ao departamento de Suporte, suporte@vtnet.com.br

Consultar Ligação

Consulte o histórico de ligações, incluindo gravações quando disponível. A comunicação é via API dedicada para este fim.



Requisição de ligação

URL

GET http://api23.vtcall.app/API/ligacoes

Parâmetros
Parâmetro Descrição Exemplo Obrigatório
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. 2016-09-16 ou 2016-09-16T08-00-01 Sim
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). 2016-01-16 Não
origem Numero que foi originado pela ligação 100 Não
destino Numero que foi o destino da ligação 200 Não
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. 1 Não
per Número de registros a serem exibidos por página. Quando não fornecido, o seu valor será de 10. 10 Não

( * ) Caso necessário fazer uma consulta mais especifica, exemplo YYYY-MM-DDThh-mm (2016-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.

Respostas
Response code (HTTP status) Descrição
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.

Retorno da Consulta

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).
Status Status da ligação, como ATENDIDA, ABANDONADA, OCUPADO.
audio Link completo da ligação em formato wav ou 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 pra página anterior.
first: Link para a primeira página.
last: Link para última página do relatório.

Exemplo Retorno


GET http://api23.vtcall.app/API/ligacoes/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://api23.vtcall.app/API/ligacoes/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",
            "status": "ATENDIDA",
            "audio": "http://api23.vtcall.app/API/ligacoes/caminho/arquivo.wav"
        },
        {
            "time": "11/08/2016 18:26:40",
            "origem": "2125046002",
            "destino": "104 - Fabio Renato",
            "tempo_ligacao": "00:03:24",
            "status": "ATENDIDA",
            "audio": "http://api23.vtcall.app/API/ligacoes/caminho/arquivo.mp3"
        }
    ],
    "links": {
       "next": "http://api23.vtcall.app/API/ligacoes?page=2&start_date=2016-08-10&end_date=2016-08-11&per=2",
       "prev": null,
       "first": "http://api23.vtcall.app/API/ligacoes?page=2&start_date=2016-08-10&end_date=2016-08-11&per=2",
       "last": "http://api23.vtcall.app/API/ligacoes?page=2&start_date=2016-08-10&end_date=2016-08-11&per=2"
    }
}

Exemplo de Codigo



API Teste

Formulário para testar sua api e verificar o retorno. Conforme a sequencia de parametros. 

		Retorno do API Teste.

FAQ

Gostaria de integrar alguns recursos, mas as APIs de vocês não fazem.

​Estamos trabalhando incansavelmente para fornecer a nossos clientes as mais diversas apis de integração, caso preciso integrar algo que nossas APIs ainda não fazem, contate-nos no suporte@vtcall.com.br

A minha chave (key) extraviou, estou com medo de comprometer minha segurança

Não se preocupe, contate-nos no suporte@vtcall.com.br e solicite a geração de uma nova chave. Lembramos que no momento de geração de chave, o seu sistema integrado pela nossa API irá parar de funcionar, até você atualizar a chave.

Essas APIs são compatíveis com meu sistema?​​

As APIs utilizam o padrão REST e o formato JSON codificado em UTF-8 para receber e retornar os dados. Atualmente as novas tecnologias suportam este tipo de integração.






Licença

VTNET

A utilização destes API estão condicionadas a contratação de um plano VTCALL, em locação, aquisição ou utilização da plataforma na Nuvem. Qualquer outro meio de utilização a estes API tornam ilegais utilização, além de não funcionar.