{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"aff8c3de-7133-42e9-a08d-e0bc1e2e2527","name":"API Velip V2 - Manual EN","description":"The API Velip Voice allows the sending of voice messages (voice text messages) by telephone in individual or batch sending, with audio generated by TTS (Text to Speech) or pre-recorded. Calls can be answered by answering robots in conversational flows (AI-NLP) by voice or keyboard (DTMF).\n\n# Possibilities\n\nStartFragment\n\nWith VELIP you can:\n\n- Trigger Individual Phone Voice Messages\n \n- Trigger Batch Phone Voice Messaging\n \n- Trigger Voice messages answered by structured flow robots (voice or dtmf)\n \n- Trigger Voice messages answered by conversational robots (voice)\n \n- Join two destinations in a conversation while keeping the numbers private\n \n- Overflow any call to a call center via STFC or Voip\n \n- Overflow any call to a remote agent on our web frontend (cloud call center)\n \n- Send target base by JSON or csv file\n \n- Generate audios by various high quality TTS\n \n- Send pre-recorded audios\n \n- Trigger SMS in conjunction with voice torpedoes\n \n- Transcribe audios and generate audio responses for use in robots by voice. For example audio messages on whatsapp\n \n\nEndFragmentStartFragment\n\nAfter submissions you can:\n\n- Receive request status on request return\n \n- Webhook - Receive general data at the end of each call\n \n- Receive automatic consolidated reports via FTP, GC Storage, Amazon S3\n \n- Consult the data of calls and campaigns via APIs\n \n- Check all information in real time through the control web frontend\n \n- Issue custom reports\n \n\nEndFragment\n\n

REST

\n\nStartFragment\n\nREST APIs where you can POST or GET any API. The function to be activated is given by the triggered URL.\n\n**Encoding: utf-8**\n\nThe parameters can be sent in the body of the request in JSON or by parameters in the URL.\n\nReturns will be in JSON as detailed in each API\n\nEndFragment\n\n

Firewall

\n\nStartFragment\n\nThe IP to be released to forward a request is **35.241.2.50 port 443** or if using **IPV6:** **2600:1901:0:8e18::**\n\n(https) which corresponds to [https://vox.velip.com.br](https://vox.velip.com.br)\n\nIf you use Call Backs (return status at the end of the call) they are forwarded by the following IPs:\n\n**35.232.103.91**\n\n**35.184.30.236**\n\n** \nPorts: 443** (HTTPS - TLS >=1.2 ) \nEndFragment\n\n

Access HTTP

\n\nStartFragment\n\nTo use it, an active Velip account is required: [https://www.velip.com.br](https://www.velip.com.br)\n\n**URL: vox.velip.com.br**\n\n**Protocol: https**\n\n**Example URI for MakeTTSCall:** \n[https://vox.velip.com.br/api/v2/MakeTTSCall
](https://vox.velip.com.br/api/v2/MakeTTSCall)EndFragment\n\n

Headers

\n\nStartFragment\n\nRequests must contain the header: \n\n_**Content-Type: application/json**_\n\n**Authorization : Bearer YOURS_TOKEN \n**\n\nEndFragment\n\n

Authentication

\n\nStartFragment\n\nThe VELIP APIs use authentication TOKENs that can be permanent, generated in the login area of the control panel, or temporary, generated by the GetUserID API. \n\nInclude in the request headers: \n_Authorization : Bearer YOURS_TOKEN_\n\nALTERNATIVELY enter the token: \na) In the header 'Authorization: {token}' \nb)Add in JSON \"tsid\":\"{token}\" - Use only if your system/webhook does not accept headers\n\nEndFragment\n\nStartFragment\n\n**1\\. GENERATE permanent TOKEN** \n \nIn the logged-in area of the control panel in the menu: API - CONFiGURA - TOKENS you can generate the tokens to be used for authentication of the APIs.\n\n\n**IMPORTANT: Once the TOKEN has been generated, it will no longer be displayed on the screen in future queries. You must store it in a safe place. You can deactivate a TOKEN at any time or generate a new one on that same screen. It is possible to generate several TOKENS for each application or server, etc.** \n\nEndFragment\n\n \n** \n \n2\\. GENERATE provisional TOKEN** \n\nStartFragment\n\n \n\nFor use cases directly in the app or routines on the end client (JavaScript for example) it is possible to use a TOKEN that is valid for 60 minutes and is generated by the GetUserID API. However, it is recommended that the authorizations are always made of the \"server side\" type.\n\nGenerate the token (tsid) in the GetUserID API on your server. To generate this API, it is necessary to use a PERMANENT TOKEN or IP authentication. Once generated, it is valid for 60 minutes on the same IP. \nUse the token (tsid) in your requests by sending one of the methods:\n\na) Header add 'Authorization: Bearer {token}' \nb) Header add 'Authorization: {token}' \nc) Add in JSON \"tsid\":\"{token}\"\n\nEndFragment\n\n

Return

\n\nStartFragment\n\nHTTP code and JSON will be returned when the return is not a media.\n\nHTTP Codes:\n\n- 200 - OK\n \n- 400 - Intruded or incomplete parameters\n \n- 401 - Authentication failed\n \n\nThe return in JSON always contains two basic pieces of information and for each API it can contain others related to the requested process.\n\nThe basics are:\n\nstatus is a status or error report. If OK, the request was accepted and the call was programmed. If different from OK, the error text will be informed.\n\nstatus_code is a numeric ID of the status of the request. When the status is OK, it will correspond to 0 (zero) and other codes according to the following table.\n\nEndFragment\n\n| statu | status_code | Details |\n| --- | --- | --- |\n| OK | 0 | Requisition accepted |\n| Session ID is not valid | 100 | If sent tsid token and is invalid |\n| Session ID is not valid | 100 | If sent tsid token and is invalid |\n| Session ID expired | 101 | If sent tsid token and is expired |\n| IP not authorized | 120 | If IP authentication and the IP is unauthorized |\n| Account not exist | 121 | Account does not exist on the platform |\n| Inactive user | 122 | Inactive user |\n| Non existent user | 123 | Non existent user |\n| No user or password | 130 | Username or password not provided |\n| IP trials exceeded | 131 | Wrong login attempts exceeded the limit. 30 min block |\n| Logins trials exceeded | 132 | User error exceeded threshold. 10 min block |\n| Username or password invalid | 140 | Invalid username or password |\n| IP blocked | 199 | Blocked IP |\n\nStartFragment\n\nOther statuses and codes specific to each API are listed in the chapter for each one.\n\nEndFragment\n\n

APIs and examples

\n\nStartFragment\n\nIn this document you can check details of each API and **choose examples in your preferred programming language** (choose from the top menu).\n\nYou can also open your **POSTMAN** account to take online tests.\n\n**Most used APIs - Single or batch:**\n\n**Individual use: MakeTTSCall ->** Triggers an individual call to one destination or optionally to two destinations by joining the two calls.\n\nIt can be sent immediately or on a scheduled day and time.\n\n**Batch usage: CreateCampaign ->** Allows you to create a campaign for sending to a batch of destinations (recommended up to 500,000 destinations). It can be entirely programmed by API parameters or by cloning from a previous campaign.\n\n**In the following examples the standard BASIC AUTH recommended authentication will be indicated, but it is possible to use TOKEN with a 60 min time limit if you need to use it directly in an app.**\n\nEndFragmen","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"13042715","team":1318216,"collectionId":"aff8c3de-7133-42e9-a08d-e0bc1e2e2527","publishedId":"UzJSJDDs","public":true,"publicUrl":"https://documenter-api.postman.tech/view/13042715/UzJSJDDs","privateUrl":"https://go.postman.co/documentation/13042715-aff8c3de-7133-42e9-a08d-e0bc1e2e2527","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.10.0","publishDate":"2022-07-12T13:33:56.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[],"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"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/UzJSJDDs"}