{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"023d17ad-66f9-41ca-b576-cc71fb619feb","name":"HitrateAPI 1.4.4","description":"Directly control and create new objects in your Hitrate dialer instance using our APIs.  \nAutomate workflows or extract order or customer data directly to your other platforms with our simple to use APIs.\n\n# Authentication\n\nEach request needs to be made with a bearer token.  \nTokens can be generated by either admins or users with \"manage token\" permission in each dialer. The tokens inherit the permissions from the user they belong to. One token per user per dialer.\n\n# Permissions\n\nAn API token is tied to a user and inherits all the permission the user has. In the case a permission is lacking the API response will consist of a JSON body with the message key which states which permissions are missing.\n\nSecondly if a user belongs to a office that is limited, they will only be able to see objects in the API that belongs to their own office. When a limited user creates things in the dailer or new objects through the API, they all iinherit the user's office automatically. Users who aren't limited need to assign new items to an office. Some things aren't explicitly tied to an office, they inherit their office assignment through contactlist, campaign, or the customer.\n\n# Error Codes\n\n**200 – success**  \nRequest made correctly  \n**400 - bad request**  \nYour request body has some form of syntax error in it  \n**401- unauthenticated**  \nMissing token or request is outside the scope for your token.  \nTokens match your permissions as a user in each dialer instance, if this is the error contact your dialer admin.  \n**404 – page not found**  \nURL is wrong or API is deprecated, refer to the documentation.\n\n**413 - request entity too large**\n\nThe dialer has a request limit on 10MB payloads, if larger split up the requests.\n\n**500 – server error**  \nServer is offline or errors with the request, such as missing mandatory field.\n\n# URL structure\n\nEach dialer has its own instance, meaning a unique url. To access your specific dialer you need to change the start of the request to match whichever dialer the API should be directed towards, followed with \":3007\".  \nExample: the dialer \"**demodailer**\" requests would start with \"[https://demodailer.hitrate.tech:3007\"](https://demodailer.alphaone.se:3007).\n\nFor the examples we'll be using the \"QA\" dialer,\n\n# New in 1.4.4\n\n- Download calls as mp3\n    \n- New concept: clients. Easier manage and track campaigns & products based on which client owns a campaign/product.\n    \n- APIs for managing clients\n    \n- New call result, recurring order, which allows agents to easier track customers that need to be called again before an order is signed.\n    \n- Update order status/cancel/verify in same endpoint\n    \n- Cancel orders\n    \n- Blocklist blocking numbers for a set duration of time\n    \n- Deletion of blocklists\n    \n- Delete number on blocklist\n    \n- Searching for sms sent between customer and dailer\n    \n- Exporting sms history as PDF\n    \n\n## Changes and fixes\n\n- Sms templates can be tied to offices. Affects GET/POST/PUT\n    \n- GET /api/customer GDPR deleted customers will return Not found instead of a customer with data deleted.\n    \n- GET /api/customer now includes all calls that belong to the customer.\n    \n- GET /api/users and GET /api/user/:id now includes which role the users has.\n    \n- GET /api/sms_templates/sms_tokens updated to reflect the new sms string replacements.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"33476464","team":6086962,"collectionId":"023d17ad-66f9-41ca-b576-cc71fb619feb","publishedId":"2sAXjKbCur","public":true,"publicUrl":"https://documenter-api.postman.tech/view/33476464/2sAXjKbCur","privateUrl":"https://go.postman.co/documentation/33476464-023d17ad-66f9-41ca-b576-cc71fb619feb","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"00603A"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":"https://content.pstmn.io/1514be1c-6207-4286-b85e-846db0c2dacd/SGl0cmF0ZV9sb2dvX3doaXRlX3RyYW5zcGFyZW50X2NsZWFuLnBuZw==","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":"https://content.pstmn.io/3620fd01-9731-4433-91bc-de1b0ed966d1/SGl0cmF0ZV9sb2dvX2dyZWVuX3RyYW5zcGFyZW50X2NsZWFuLnBuZw==","colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"00603A"}}]}},"version":"8.10.1","publishDate":"2024-08-30T14:07:13.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":"https://content.pstmn.io/3620fd01-9731-4433-91bc-de1b0ed966d1/SGl0cmF0ZV9sb2dvX2dyZWVuX3RyYW5zcGFyZW50X2NsZWFuLnBuZw==","logoDark":"https://content.pstmn.io/1514be1c-6207-4286-b85e-846db0c2dacd/SGl0cmF0ZV9sb2dvX3doaXRlX3RyYW5zcGFyZW50X2NsZWFuLnBuZw=="}},"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/af65d2ef7cd6b499476728ae340429394ef856fa32421cdb3390e5c6456eed41","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"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/2sAXjKbCur"}