{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"a578a9e2-0188-4b34-9033-4a2bc5b6f11c","name":"API Velip V2 - Manual","description":"## Exemplos em diversas linguagens\n\nNo menu superior deste manual, você pode selecionar a linguagem de \nprogramação de sua preferência para visualizar os exemplos. Também é \npossível copiar todos os exemplos para o seu POSTMAN.\n\n\n\nNos capítulos de cada API, você também poderá visualizar diversos \nexemplos mais utilizados. Caso não encontre o que procura, por favor, \nsolicite através do email [suporte@velip.com.br](https://mailto:suporte@velip.com.br).\n\n\n\n## Usos\n\n1. **Torpedo de voz** - Envio de mensagens de voz (torpedo de voz) por telefone em envios individuais ou em lote, com áudios gerados por TTS (Text to Speech) ou pré-gravados. As ligações podem ser atendidas por robôs de atendimento em fluxos conversacionais (IA-NLP) por voz ou teclado (DTMF).\n \n2. **Interconectar 2 destinos por telefone** mantendo a privacidade dos números.\n \n3. **Envio de SMS** individuais ou em lote\n \n4. **Gerar áudio**s por TTS ou por gravação.\n \n\n

Possibilidades

\n\nCom a VELIP, você pode:\n\n\n\nApós os envios, você poderá:\n\n\n\n

REST

\n\nAPIs REST normalmente utilizam POST. A função a ser ativada é dada pela URL acionada.\n\n**Encoding: utf-8**\n\nOs parâmetros devem ser enviados no corpo da requisição em JSON e em alguns casos por parâmetros na URL. \nOs retornos serão em JSON conforme detalhado em cada API\n\n

Firewall

\n\nO IP de nosso ponto de presença para você encaminhar uma requisição é **35.241.2.50 porta 443** ou se usar **IPV6: 2600:1901:0:8e18::** \n(https) que corresponde ao [https://vox.velip.com.br](https://vox.velip.com.br)\n\nSe utilizar Call Backs (retorno do status ao final da ligação) eles são encaminhados pelos seguintes IPs :\n\n**35.232.103.91**\n\n**35.184.30.236**\n\n**Portas: 443** (HTTPS - TLS >=1.2 )\n\n

Acesso HTTPS - Ponto de presença

\n\nPara utilização, é necessário uma conta ativa na Velip: [https://www.velip.com.br](https://www.velip.com.br)\n\n**URL: vox.velip.com.br**\n\n**Protocolo: https**\n\n**Ponto de presença URI:**\n\n[https://vox.velip.com.br/api/v2/](https://vox.velip.com.br/api/v2/)\n\nExemplo para API MakeTTSCall:\n\n[https://vox.velip.com.br/api/v2/MakeTTSCall](https://vox.velip.com.br/api/v2/MakeTTSCall)\n\n

Headers

\n\nAs requisições devem conter no cabeçalho:\n\n_**Content-Type: application/json**_\n\n**Authorization : Bearer YOURS_TOKEN**\n\n

Autenticação

\n\nAs APIs VELIP utilizam TOKENs de autenticação que podem ser permanentes, gerados na área logado do painel de controle ou temporários, gerados pela API GetUserID.\n\nIncluir no headers da requisição: \n_**Authorization : Bearer YOURS_TOKEN**_\n\nALTERNATIVAMENTE informe o token : \na) No header 'Authorization: {token}' \nb) Incluir no JSON \"tsid\":\"{token}\" - Use apenas se o seu sistema/webhook não aceitar headers\n\n**1\\. GERAR TOKEN permanente**\n\nNa área logada do painel de controle no menu : API - CONFiGURA - TOKENS poderá gerar os tokens a serem utilizados para autenticação das APIs.\n\n\n\n**IMPORTANTE: Uma vez gerado o TOKEN não será mais exibido na tela em futuras consultas. Deverá armazena-lo em local seguro. Poderá desativar um TOKEN em qualquer momento ou gerar um novo nesse mesma tela. É possível gerar vários TOKENS para cada aplicação ou server, etc.**2.\n\n**GERAR TOKEN provisório**\n\nPara casos de **uso diretamente em app ou rotinas no cliente final** (JavaScript por ex) é possível utilizar um TOKEN que tem validade de 60 minutos e é gerado pela API GetUserID. No entanto, é recomendado que as autorizações sejam sempre feitas do tipo \"server side\".\n\n- Gere o token (tsid) na API GetUserID **no seu servidor**. Para gerar nessa API é necessário utilizar um TOKEN PERMANENTE ou autenticação por IP. Uma vez gerado, é valido por 60 minutos no mesmo IP.\n \n- Utilize o token (tsid) nas sua requisições enviando por umas das modalidades: \n a) Header incluir 'Authorization: Bearer {token}' \n b) Header incluir 'Authorization: {token}' \n c) Incluir no JSON \"tsid\":\"{token}\"\n \n\n

Retorno da requisição

\n\nSerá retornado o HTTP code e JSON quando o retorno não for uma mídia.\n\nHTTP Codes:\n\n\n\nO retorno em **JSON** contém sempre duas informações básicas e para cada API pode conter outras relativo ao processo solicitado. \nAs básicas são: \n**status** é um informe do status ou erro. Se **OK**, a requisição foi aceita e a ligação programada. Se diferente de OK, será informado o texto do erro.\n\n**status_code** é uma identificação numérica do status da solicitação. Quando OK, no status será 0 (zero) e outras conforme tabela a seguir.\n\n| statu | status_code | Details |\n| --- | --- | --- |\n| OK | 0 | Requisição aceita |\n| Session ID is not valid | 100 | Se enviado token tsid e for inválido |\n| Session ID is not valid | 100 | Se enviado token tsid e for inválido |\n| Session ID expired | 101 | Se enviado token tsid e for expirado |\n| Inactive account | 110 | Conta inativa |\n| IP not authorized | 120 | Se autenticação por IP e o IP for não autorizado |\n| Account not exist | 121 | Conta não existente na plataforma |\n| Inactive user | 122 | Usuário inativo |\n| Non existent user | 123 | Usuário inexistente |\n| No user or password | 130 | Usuário ou senha não informados |\n| IP trials exceeded | 131 | Tentativas de login erradas excedeu o limite. Bloqueio de 30 min |\n| Logins trials exceeded | 132 | Erro de usuário excedeu o limite. Bloqueio de 10 min |\n| Username or password invalid | 140 | Usuário ou senha inválido |\n| IP blocked | 199 | IP bloqueado |\n\n**Outros status e códigos específicos de cada API estão listados no capítulo de cada uma.**\n\n# **Retornos de Status: Webhook (Callbacks)**\n\nO nosso sistema está habilitado para um webook, enviar automaticamente um callback para uma URL pré-definida por você, comunicando o status e os detalhes específicos após a conclusão de cada envio de torpedo de voz ou SMS. Este recurso é essencial para serviços como o nosso que são assíncronos, onde as informações completas de status são disponibilizadas somente após a finalização do envio.\n\n**Contexto de Uso:** Por exemplo, considere o envio de um torpedo de voz. O sistema realiza \numa ligação para um número de destino, aguarda a resposta, transmite a \nmensagem e então, encerra a chamada. Devido à natureza assíncrona deste \nserviço, os detalhes completos do status da entrega são disponibilizados apenas após o término da ligação, não no momento da requisição inicial.\n\n_**Na requisição da API:**_ \nNo momento da requisição da API, será retornado apenas uma confirmação \ndo recebimento da requisição, sem detalhes adicionais sobre o envio. \nEste retorno inicial não reflete o status de entrega devido à \nassincronicidade do serviço.\n\n**Na requisição da API:** Para garantir que você receba prontamente todas as informações de status:\n\n1. Acesse o painel de controle web.\n \n2. Navegue até o menu “Integrações”.\n \n3. Prossiga para “Configurações”.\n \n4. E selecione “URLs para Retorno”.\n \n\nVocê poderá configurar as URLs que receberão os callbacks e demais configurações, como se deseja receber em Json, XML ou parâmetros, se será encaminhado por POST ou GET e suas credenciais se for necessária uma autenticação em seu ponto de presença. \nApós a conclusão de cada envio de torpedo de voz ou SMS um método POST ou GET será acionado, enviando dados no formato JSON, XML ou parâmetros, na URL configurada. \nPara SMS, eventos de entrega ao destino serão enviados quando ocorrerem ( Em até 48 horas).\n\n_**MENSAGENS DE VOZ - DADOS ENCAMINHADOS PARA A URL PROGRAMADA (Json, XML ou parâmentros do tipo**_ **x-www-form-urlencoded**_**)**_\n\n**cd_id => Identificação do envio**\n\n**cd_date => Data do envio (YYYY-MM-DD)**\n\n**cd_time => Hora que iniciou a discagem (HH:MM:SS)**\n\n**cd_time_start => Hora que o destino atendeu (HH:MM:SS)**\n\n**cd_time_end => Hora que o destino desligou (HH:MM:SS)**\n\n**cd_time_sec => Tempo em segundos da chamada**\n\n**cd_called_status => OK , NA, EK, CK, BK, IK ( Atendeu, Não atendeu , Num.Incorreto,Bloqueio,Bloqueio não pertube,Num.Inexistente)**\n\n**ctid => Identificação do cliente se fornecida quando da requisição (Alfa de até 15 caracteres)**\n\n**cd_price => Valor da chamada por minuto**\n\n**cd_value => Valor da chamada total**\n\n**saldo => Saldo da conta**\n\n**cd_name => Nome do destino, exemplo São Paulo - Fixo**\n\n**cd_route => Código do destino a ser utilizado em sistema de cobrança , exemplo 5511**\n\n**cd_dest => Número discado**\n\n**cd_resp1 => Resultado do dígito teclado da primeira pergunta em envios com DTMF**\n\n**cd_resp2 => Resultado do dígito teclado da segunda pergunta em envios com DTMF** \n... até **cd_resp12** \n**cdc_id=> ID do destino quando campanha** \n**cdc_nome => Nome do destino quando campanha****cdc_cod_cli => cod_cli do destino quando campanha**cdc_extra1=> extra1 do destino quando campanha**... até cdc_extra8**\n\n_**Exemplo de um Json do Callback de mensagem de voz:**_\n\n``` json\n{\n \"cd_id\": \"c_109059\",\n \"cd_date\": \"2023-09-27\",\n \"cd_time\": \"18:55:03\",\n \"cd_time_start\": \"18:55:04\",\n \"cd_time_end\": \"18:56:40\",\n \"cd_time_sec\": 96,\n \"cd_time_sec2\": \"84\",\n \"cd_price\": null,\n \"cd_value\": 0.4200,\n \"cd_name\": null,\n \"cd_route\": \"GERAL\",\n \"cd_called_status\": \"OK\",\n \"cd_called_status2\": \"OK\",\n \"ctid\": \"\",\n \"cpid\": \"-1\",\n \"cp_id\": \"0\",\n \"cd_resp1\": \"\",\n \"cd_resp2\": \"\",\n \"cd_resp3\": \"\",\n \"cd_resp4\": \"\",\n \"cd_resp5\": \"\",\n \"cd_resp6\": \"\",\n \"cd_resp7\": \"\",\n \"cd_resp8\": \"\",\n \"cd_resp9\": \"\",\n \"cd_resp10\": \"\",\n \"cd_resp11\": \"\",\n \"cd_resp12\": \"\",\n \"dest\": \"5511992068854\",\n \"cd_dest2\": \"551133574600\",\n \"cdc_id\": null,\n \"cdc_nome\": null,\n \"cdc_extra1\": null,\n \"cdc_extra2\": null,\n \"cdc_extra3\": null,\n \"cdc_extra4\": null,\n \"cdc_extra5\": null,\n \"cdc_extra6\": null,\n \"cdc_extra7\": null,\n \"cdc_extra8\": null,\n \"cdc_cod_cli\": null,\n \"saldo\": 500.752\n}\n\n ```\n\n_**SMS - DADOS ENCAMINHADOS PARA A URL PROGRAMADA (Json XML ou parâmentros)**_\n\n**command => Identificação do tipo de menssagem de texto (sms)**\n\n**cdls_id => Identificação do envio**\n\n**ctid => Identificação do cliente se fornecida quando da requisição (Alfa de até 15 caracteres)**\n\n**dest => Número do celular**\n\n**reqtime => Data e hora da requisição do SMS (YYYY-MM-DD HH:MM:SS)**\n\n**delivstatus=> Status da entrega ao destino (ver lista no capítulo MakeSMS)**\n\n_**Exemplo de um Json do Callback de SMS:**_\n\n{\"command\":\"sms\",\"cdls_id\":\"654321\",\"ctid\":\"\",\"dest\":\"555119988776655\",\"reqtime\":\"2023-03-05 12:45:16\",\"delivstatus\":\"SENT_SUCCESS\"}\n\n# Relatórios\n\nNo painel de controle web, é possível visualizar e gerar diversos relatórios em tempo real, referentes aos envios ou ações executadas via API. Além disso, é possível consultar registros das solicitações feitas e acompanhar o status dos callbacks enviados.\n\n

APIs e exemplos

\n\nNesse documento, você poderá verificar detalhes de cada API e **escolher exemplos na linguagem de programação preferida** (escolha no menu superior). \nTambém poderá abrir em sua conta **POSTMAN** para fazer testes online.\n\n**APIs mais utilizadas - Envio de torpedo de voz - Individual ou em lote:**\n\n**Individual use: MakeTTSCall ->** Dispara uma ligação individual para um destino ou opcionalmente para dois destinos, unindo as duas ligações. \nPode ser envio imediato ou com dia e hora programada.\n\n**Em lote use: CreateCampaign ->** Permite a criação de uma campanha para o envio de um lote de destinos (recomendado até 500 mil destinos). Pode ser inteiramente programado pelos parâmetros das APIs ou clonando de uma campanha anterior.\n\n**Nos exemplos a seguir, serão indicadas a autenticação recomendada padrão por TOKEN.**","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"13042715","team":1318216,"collectionId":"a578a9e2-0188-4b34-9033-4a2bc5b6f11c","publishedId":"TWDfDYuD","public":true,"publicUrl":"https://api.velip.com.br","privateUrl":"https://go.postman.co/documentation/13042715-a578a9e2-0188-4b34-9033-4a2bc5b6f11c","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"8fc74a"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.10.1","publishDate":"2023-04-09T13:42:32.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[{"name":"Manual Velip","id":"92748870-a255-4827-b2a9-cb6fdbbf28bd","owner":"13042715","values":[{"key":"VOX","value":"https://vox.velip.com.br","enabled":true,"type":"default"},{"key":"token","value":"YOUR_TOKEN","enabled":true,"type":"default"}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/848683f84b1b3b533ee3aa24f3c10e40958f9db35642b414b7a4b2efea99035a","favicon":"https://res.cloudinary.com/postman/image/upload/v1681036381/team/ljphhlcvjpcwmlibfcgh.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"Manual Velip","value":"13042715-92748870-a255-4827-b2a9-cb6fdbbf28bd"}],"canonicalUrl":"https://api.velip.com.br/view/metadata/TWDfDYuD"}