{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"9a7198aa-f61e-416f-f8b5-7bc4c0b94c14","name":"TVox WebAPI - DEMO","description":"The Web API plans to provide TVox management functionality using HTTPS POST requests.\r\nRequests must be made to the TVox IP as defined in the Guide and must have the following endpoint: https://IP_TVOX/tvox/webapi/.<br>\r\n<i>You also can use websocket protocol on url wss://IP_TVOX/tvox/webapiws/.</i>\r\n\r\nThe requests and responses follow the [JSON-RPC 2.0](http://en.wikipedia.org/wiki/JSON-RPC#Version_2.0) protocol.\r\n\r\n><b>IMPORTANT</b>: In order to properly handle requests, a login phase is necessary. This, if success, will return a <b>JSESSIONID</b> cookie that has to be reused on subsequent requests to mantain the session in which you are authenticated.<br><br>\r\nExample:\r\n<pre>Set-Cookie: JSESSIONID=ii91xj9dougv183ykz9sc2tie; path=/tvox;</pre>\r\n\r\nThe provided functions are documented in WebAPI interface, available at https://IP_TVOX/tvox/webapi/doc/apidocs.\r\n\r\n----\r\n\r\nFor an example that retrieve version info from API, you have to set post request string like this:\r\n<pre>\r\n{\r\n\t\"jsonrpc\": \"2.0\",\r\n\t\"method\": \"getVersion\",\r\n\t\"params\":[],\r\n\t\"id\": 1\r\n}\r\n</pre>\r\n\r\nAnswer will be:\r\n<pre>\r\n{\r\n\t\"jsonrpc\": \"2.0\",\r\n\t\"result\": [{{tvox_webapi_version}},{{tvox_webapi_version}}],\r\n\t\"id\":1\r\n}\r\n</pre>\r\n\r\n\r\nAnother example, the login act:\r\n<pre>\r\n{\r\n    \"jsonrpc\":\"2.0\",\r\n    \"method\":\"login\",\r\n    \"id\":1,\r\n    \"params\":[{{tvox_webapi_version}},{{login_user_username}},{{login_user_password}}]\r\n}\r\n</pre>\r\n                                        \r\nIf login fails, answer will be:\r\n<pre>\r\n{\r\n    \"jsonrpc\" : \"2.0\",\r\n    \"id\" : 1,\r\n    \"result\" : {\r\n        \"username\" : null,\r\n        \"status\" : \"RETRY\",\r\n        \"surname\" : null,\r\n        \"name\" : null,\r\n        \"anonymous\" : false\r\n    }\r\n}\r\n</pre>\r\n\r\nOtherwise the success answer will be:\r\n<pre>\r\n{\r\n    \"jsonrpc\" : \"2.0\",\r\n    \"id\" : 1,\r\n    \"result\" : {\r\n        \"username\" : null,\r\n        \"status\" : \"SUCCESS\",\r\n        \"surname\" : null,\r\n        \"name\" : null,\r\n        \"anonymous\" : false\r\n    }\r\n}\r\n</pre>\r\n\r\n----\r\n\r\nThe correct mode of use should be as follows:\r\n1. Get the TVox WebAPI version from the server (<code>getVersion</code>); this request does not need authentication.\r\n2. Login to TVox WebAPI (<code>login</code>) passing as parameter the previously obtained version.\r\n3. If login is successful, store the returned sessionId.\r\n4. Perform a new request setting a cookie with key *JSESSIONID* and the stored sessionId as value.\r\n                                        \r\n><b>IMPORTANT</b>: the url is case insensitive, while the parameters retrieve through RPC have to be case sensitive.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"805183","team":3387708,"collectionId":"9a7198aa-f61e-416f-f8b5-7bc4c0b94c14","publishedId":"RVfvFXDA","public":true,"publicUrl":"https://documenter-api.postman.tech/view/805183/RVfvFXDA","privateUrl":"https://go.postman.co/documentation/805183-9a7198aa-f61e-416f-f8b5-7bc4c0b94c14","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"009ee0"},"documentationLayout":"classic-double-column","version":"8.11.6","publishDate":"2018-02-14T13:04:14.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[{"name":"TVox WebAPI - DEMO","id":"d7d8ec98-1264-1e60-d9f7-95d5470c230f","owner":"805183","values":[{"key":"tvox_ip","value":"127.0.0.1","enabled":true},{"key":"tvox_webapi_version","value":"\"10.21.0\"","enabled":true},{"key":"login_admin_username","value":"\"admin\"","enabled":true},{"key":"login_admin_password","value":"\"admin\"","enabled":true},{"key":"login_user_username","value":"\"mrossi\"","enabled":true},{"key":"login_user_password","value":"\"mrossi\"","enabled":true},{"key":"caller_username","value":"\"mrossi\"","enabled":true},{"key":"caller_email","value":"\"mrossi@telenia.it\"","enabled":true},{"key":"number_to_call","value":"\"600\"","enabled":true},{"key":"access_code","value":"\"\"","enabled":true},{"key":"job_label","value":"\"\"","enabled":true},{"key":"record_call","value":"false","enabled":true},{"key":"rec_on_connect","value":"true","enabled":true},{"key":"rec_file_name","value":"null","enabled":true},{"key":"rec_external_data","value":"null","enabled":true},{"key":"return_call_id","value":"true","enabled":true},{"key":"service_code","value":"\"\"","enabled":true},{"key":"pd_service_code","value":"\"serv_pd\"","enabled":true}],"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/f58103761ebe0200af06260f63332b0478967ff2c1787dd2f4281d7ab64d68a4","favicon":""},"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":"TVox WebAPI - DEMO","value":"805183-d7d8ec98-1264-1e60-d9f7-95d5470c230f"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/RVfvFXDA"}