{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"4b5502a7-edae-490e-8ca9-904ad123c345","name":"Tegsoft’s REST APIs","description":"Tegsoft tries to be a strong bridge between the software world and the communication world. We are supplying detailed APIs for allowing many programming languages such as .NET, Java, Php, Python, Javascript to interact with communication services like Voice, SMS, Whatsapp, Webchat.\n\nMany programmers are willing to use JSON-based REST services so we are happy to share our native JSON REST APIs which is documented in this article.\n\nIf you need REST XML or SOAP APIs please use the link below to access the related article. [https://documenter.getpostman.com/view/5270594/RzthSC1e](https://documenter.getpostman.com/view/5270594/RzthSC1e)\n\nTegsoft provides many REST APIs for managing calls process, sending text messages, managing customer information and much more, to integrate with CRM / ERP / E-Shopping etc. to answer the below requirements.\n\n- Receives the call and shows on the agent's screen with using programming skills(Screen-popup)\n    \n- Introduces customer information to Tegsoft's infrastructure\n    \n- Receives the calls as different groups such as recognize/unrecognize or in a group or not\n    \n- Stores the communication history and shows these informations if the customer needs.\n    \n- Shows customer's informations on the agent's screen\n    \n- Shows information of the customer waiting in the queue\n    \n- Monitors the call on the status panel with name\n    \n- Starts a call by using Tegsoft infrastructure from programming infrastructure with clicking call button\n    \n- Starts a group call by using Tegsoft infrastructure from programming infrastructure with clicking call button\n    \n- Tegsoft API infrastructures should be used to see the basic requirements mentioned above.\n    \n\nFor additional documentation please check link [https://docs.tegsoft.com](https://docs.tegsoft.com)\n\n## What is REST API?\n\nAPI (Application Programming Interface), is the interface that enables the functions of an application to be accessed and used externally or remotely. The API allows the application on a server to be accessed from different platforms and to return a response.\n\nREST is an architecture that works over the HTTP protocol that provides communication between client and server.\n\nREST API enables applications to communicate by carrying data in many formats, especially XML, JSON, HTML, TEXT, between client and server.\n\nREST API services use different HTTP methods in data transmission. These are GET, POST, PUT, DELETE methods. GET is used for reading, POST is for inserting a new record, PUT is for updating a record, and DELETE is for deleting a record. The HTTP method information, together with the URL called for the HTTP request, is selected as one of the 4 methods and the server determines how the request will affect the recording accordingly.\n\n**GET** = Read\n\n**POST** = Create\n\n**PUT** = Update\n\n**DELETE** = Delete\n\n<img src=\"https://tegsoft.com/uploads/support/rest-api-model.png\" alt=\"alt\">\n\nP.S. Please mind SOAP services are published via link [https://documenter.getpostman.com/view/5270594/RzthSC1e](https://documenter.getpostman.com/view/5270594/RzthSC1e)","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"5270594","team":85723,"collectionId":"4b5502a7-edae-490e-8ca9-904ad123c345","publishedId":"UV5RnfwV","public":true,"publicUrl":"https://apidocs.tegsoft.com","privateUrl":"https://go.postman.co/documentation/5270594-4b5502a7-edae-490e-8ca9-904ad123c345","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.10.1","publishDate":"2021-10-11T16:30:30.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[{"name":"Sample","id":"9cc3d043-a2c3-425a-8977-5540f4827d04","owner":"5270594","values":[{"key":"PROTOCOL","value":"https","enabled":true},{"key":"TEGSOFT_SERVER","value":"sample.tegsoftcloud.com","enabled":true},{"key":"TOKEN","value":"{TOKEN}","enabled":true},{"key":"USERCODE","value":"test.sample","enabled":true},{"key":"PASSWORD","value":"{PASSWORD}","enabled":true},{"key":"CLEARPASSWORD","value":"{Clear_Password}","enabled":true},{"key":"LOCALE","value":"en","enabled":true},{"key":"UID","value":"{UID}","enabled":true},{"key":"INTERFACE","value":"{INTERFACE}","enabled":true},{"key":"DID","value":"{DID}","enabled":true},{"key":"REASON","value":"{Reason}","enabled":true},{"key":"CHATID","value":"92793c4d-2c90-4283-864a-6107d202a206","enabled":true},{"key":"RESULTID","value":"{{RESULTID}}","enabled":true},{"key":"CONTID","value":"{CONTID}","enabled":true},{"key":"FIRSTNAME","value":"{Firstname}","enabled":true},{"key":"LASTNAME","value":"{Lastname}","enabled":true},{"key":"EMAIL","value":"{E-mail}","enabled":true},{"key":"PHONE","value":"{Phone}","enabled":true,"type":"default"},{"key":"SKILLID","value":"{SKILLID}","enabled":true},{"key":"SUBJECT","value":"Sales","enabled":true},{"key":"CAMPAIGNID","value":"{CAMPAINGID}","enabled":true},{"key":"CALLID","value":"{CALLID}","enabled":true},{"key":"GROUPID","value":"{GROUPID}","enabled":true,"type":"default"},{"key":"LICENSEKEY","value":"947cb0cdfd4085d641a2262d8f02e56e6a7a5c100f2df4a3dbb95436ffd941fa664ecf1cea4f8327831b51f5d28e28e14aecd5d0644983374f3f339c65510c45a089009edd78963136bb1a6bee10588823dbe3fffa2de00e6f24276268907d91db8538ee84b5a39419efec7202c7ab8d4460579a9db0b702","enabled":true,"type":"default"},{"key":"LICENSENAME","value":"TegsoftCC_SpeechAnalyticsGW","enabled":true,"type":"default"},{"key":"LICENSENAMES","value":"TegsoftCC_SpeechAnalyticsGW,TegsoftCP_UC","enabled":true,"type":"default"},{"key":"UNITUID","value":"{UNITUID}","enabled":true,"type":"default"},{"key":"USERROLE","value":"{USERROLE}","enabled":true,"type":"default"},{"key":"TRUNKID","value":"{TRUNKID}","enabled":true,"type":"default"},{"key":"TRUNKNAME","value":"{TRUNKNAME}","enabled":true,"type":"default"},{"key":"ROUTEID","value":"{{ROUTEID}}","enabled":true,"type":"default"},{"key":"ROUTENAME","value":"{{ROUTENAME}}","enabled":true,"type":"default"},{"key":"CONTEXTID","value":"{{CONTEXTID}}","enabled":true,"type":"default"},{"key":"PROFILENAME","value":"{{PROFILENAME}}","enabled":true,"type":"default"},{"key":"POPUPID","value":"{{POPUPID}}","enabled":true,"type":"default"},{"key":"CTINAME","value":"{{CTINAME}}","enabled":true,"type":"default"},{"key":"RESULT","value":"{{RESULT}}","enabled":true,"type":"default"},{"key":"MOHID","value":"{{MOHID}}","enabled":true,"type":"default"},{"key":"NAME","value":"{{NAME}}","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/4b1d010e6974d2a6d9b776a3fa08983ebd1a527ebd7fc7ba8f3a59225e9a256f","favicon":"https://tegsoft.com/favicon.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":"Sample","value":"5270594-9cc3d043-a2c3-425a-8977-5540f4827d04"}],"canonicalUrl":"https://apidocs.tegsoft.com/view/metadata/UV5RnfwV"}