{"info":{"_postman_id":"f2ef70f6-3b49-4a7e-a717-7a099fe93f49","name":"CommPeak Billing API","description":"<html><head></head><body><p>REST-style API that uses JSON for serialization.</p>\n<p><strong>Making a request</strong></p>\n<ul>\n<li><p>All URLs start with <a href=\"https://api.commpeak.com/\">https://api.commpeak.com/</a></p>\n</li>\n<li><p>SSL only</p>\n</li>\n<li><p>API Key can be acquired at <a href=\"https://my.commpeak.com/api_keys\">https://my.commpeak.com/api_keys</a></p>\n</li>\n</ul>\n</body></html>","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"14447886","collectionId":"f2ef70f6-3b49-4a7e-a717-7a099fe93f49","publishedId":"TzsWt9kK","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2021-08-10T14:46:57.000Z"},"item":[{"name":"Customer","item":[{"name":"Customer Details","id":"3e167a3d-d7fa-453c-9ca1-9987d633d1f2","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"accept":true}},"request":{"method":"GET","header":[{"key":"Authorization","value":"Token api_key","type":"text"},{"key":"Accept","value":"application/vnd.commpeak.com; version=1,application/json","type":"text"}],"url":"https://api.commpeak.com/customer","description":"<ul>\n<li><code>GET /customer</code> will return customer details and current balance.</li>\n</ul>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Token api_key"}]},"isInherited":true,"source":{"_postman_id":"f2ef70f6-3b49-4a7e-a717-7a099fe93f49","id":"f2ef70f6-3b49-4a7e-a717-7a099fe93f49","name":"CommPeak Billing API","type":"collection"}},"urlObject":{"path":["customer"],"host":["https://api.commpeak.com"],"query":[],"variable":[]}},"response":[{"id":"f56c88f7-eb98-4ecb-85e3-64fbbd01d358","name":"Customer - Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Token api_key","type":"text"},{"key":"Accept","value":"application/vnd.commpeak.com; version=1,application/json","type":"text"}],"url":"https://api.commpeak.comcustomer"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n    \"customer\": {\n        \"email\": \"customer@email.com\",\n        \"balance\": 69.64622,\n        \"sms_balance\": 99.63218,\n        \"temporary_credit\": 0\n    }\n}"},{"id":"6ae4b0c2-c4a3-41ad-bc6e-acc0166184e8","name":"Customer - Invalid Token","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Token api_key","type":"text"},{"key":"Accept","value":"application/vnd.commpeak.com; version=1,application/json","type":"text"}],"url":"https://api.commpeak.comcustomer"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"plain","header":[{"key":"Content-Type","value":"text/plain; charset=utf-8"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"HTTP Token: Access denied.\n"}],"_postman_id":"3e167a3d-d7fa-453c-9ca1-9987d633d1f2"}],"id":"a38cd049-b4ae-4586-bcb3-e52c0e9997de","_postman_id":"a38cd049-b4ae-4586-bcb3-e52c0e9997de","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Token api_key"}]},"isInherited":true,"source":{"_postman_id":"f2ef70f6-3b49-4a7e-a717-7a099fe93f49","id":"f2ef70f6-3b49-4a7e-a717-7a099fe93f49","name":"CommPeak Billing API","type":"collection"}}},{"name":"Voice Rates","item":[{"name":"Show Voice Rates","id":"1dced051-9523-4c6c-8cdf-0ef4af6b2001","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"accept":true}},"request":{"method":"GET","header":[{"key":"Authorization","value":"Token api_key","type":"text"},{"key":"Accept","value":"application/vnd.commpeak.com; version=1,application/json","type":"text"}],"url":"https://api.commpeak.com/rates/:tech_prefix","description":"<ul>\n<li><p><code>GET /rates/current</code> will return the currently applicable rates for 'tech. prefix' 021001. </p>\n</li>\n<li><p>You can replace <code>current</code> with the desired 'tech. prefix' from the list available to you. For example, <code>GET /rates/021002</code> will return rates that are currently applicable for 'tech. prefix' 021002.</p>\n</li>\n</ul>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Token api_key"}]},"isInherited":true,"source":{"_postman_id":"f2ef70f6-3b49-4a7e-a717-7a099fe93f49","id":"f2ef70f6-3b49-4a7e-a717-7a099fe93f49","name":"CommPeak Billing API","type":"collection"}},"urlObject":{"path":["rates",":tech_prefix"],"host":["https://api.commpeak.com"],"query":[],"variable":[{"description":{"content":"<p>Call Plan Tech Prefix to show rates for. Use \"current\" to show default.</p>\n","type":"text/plain"},"type":"any","value":"current","key":"tech_prefix"}]}},"response":[{"id":"bdac04b3-0a0f-43b7-835b-93a434de0ad7","name":"Current rates","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Token api_key","type":"text"},{"key":"Accept","value":"application/vnd.commpeak.com; version=1,application/json","type":"text"}],"url":"https://api.commpeak.comrates/current"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n    \"rates\": [\n        {\n            \"prefix\": \"353\",\n            \"destination\": \"Ireland - Fixed\",\n            \"price\": 0.0185\n        },\n        {\n            \"prefix\": \"35389\",\n            \"destination\": \"Ireland - Mobile\",\n            \"price\": 0.1617\n        }\n\t]\n}"}],"_postman_id":"1dced051-9523-4c6c-8cdf-0ef4af6b2001"},{"name":"Search rates by phone prefix","id":"237b8432-798b-4613-aab6-6b68eeac3451","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"accept":true}},"request":{"method":"GET","header":[{"key":"Authorization","value":"Token api_key","type":"text"},{"key":"Accept","value":"application/vnd.commpeak.com; version=1,application/json","type":"text"}],"url":"https://api.commpeak.com/rates/:tech_prefix/search?prefix=1212","description":"<ul>\n<li><code>GET /rates/current/search?prefix=COUNTRY_PREFIX</code> will return rates for specified prefix.</li>\n</ul>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Token api_key"}]},"isInherited":true,"source":{"_postman_id":"f2ef70f6-3b49-4a7e-a717-7a099fe93f49","id":"f2ef70f6-3b49-4a7e-a717-7a099fe93f49","name":"CommPeak Billing API","type":"collection"}},"urlObject":{"path":["rates",":tech_prefix","search"],"host":["https://api.commpeak.com"],"query":[{"description":{"content":"<p>Phone number prefix to search by</p>\n","type":"text/plain"},"key":"prefix","value":"1212"}],"variable":[{"description":{"content":"<p>Call Plan Tech Prefix to show rates for. Use \"current\" to show default.</p>\n","type":"text/plain"},"type":"any","value":"current","key":"tech_prefix"}]}},"response":[{"id":"a4a31e6e-f172-4494-862d-651698f684c8","name":"Search current rates by prefix","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Token api_key","type":"text"},{"key":"Accept","value":"application/vnd.commpeak.com; version=1,application/json","type":"text"}],"url":{"raw":"https://api.commpeak.comrates/current/search?prefix=35389","host":["https://api.commpeak.comrates"],"path":["current","search"],"query":[{"key":"prefix","value":"35389","description":"Phone Prefix to search for"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n    \"rates\": [\n        {\n            \"prefix\": \"35389\",\n            \"destination\": \"Ireland - Mobile\",\n            \"price\": 0.1617\n        },\n        {\n            \"prefix\": \"3538994\",\n            \"destination\": \"Ireland - Mobile - Lycatel\",\n            \"price\": 0.1582\n        },\n        {\n            \"prefix\": \"3538995\",\n            \"destination\": \"Ireland - Mobile - Lycatel\",\n            \"price\": 0.1582\n        }\n    ]\n}"}],"_postman_id":"237b8432-798b-4613-aab6-6b68eeac3451"},{"name":"Download current rates","id":"67110392-03d6-43db-8333-2cbe5257b03a","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"accept":true}},"request":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.commpeak.com; version=1,text/csv","type":"text"},{"key":"Authorization","value":"Token api_key","type":"text"}],"url":"https://api.commpeak.com/rates/:tech_prefix/download","description":"<ul>\n<li><code>GET /rates/current/download</code> will download current rates (XLS or CSV).</li>\n</ul>\n<p>To set the desired format, specify it in the ACCEPT header:</p>\n<ul>\n<li><code>text/csv</code> for CSV format, or</li>\n<li><code>application/vnd.ms-excel</code> for XLS format.</li>\n</ul>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Token api_key"}]},"isInherited":true,"source":{"_postman_id":"f2ef70f6-3b49-4a7e-a717-7a099fe93f49","id":"f2ef70f6-3b49-4a7e-a717-7a099fe93f49","name":"CommPeak Billing API","type":"collection"}},"urlObject":{"path":["rates",":tech_prefix","download"],"host":["https://api.commpeak.com"],"query":[],"variable":[{"description":{"content":"<p>Call Plan Tech Prefix to show rates for. Use \"current\" to show default.</p>\n","type":"text/plain"},"type":"any","value":"current","key":"tech_prefix"}]}},"response":[{"id":"0aff8b77-8ca8-4eb7-974f-3b8359daf9df","name":"Download current rates as XLS","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Token api_key","type":"text"},{"key":"Accept","value":"application/vnd.commpeak.com; version=1,application/vnd.ms-excel","type":"text"},{"key":"Content-Type","value":"text/csv","type":"text","disabled":true}],"url":"https://api.commpeak.comrates/current/download"},"status":"OK","code":200,"_postman_previewlanguage":"raw","header":[{"key":"Content-Type","value":"application/vnd.ms-excel"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Disposition","value":"attachment; filename=\"filename.xls\"; filename*=UTF-8''filename.xls"}],"cookie":[],"responseTime":null,"body":"This request returns a file in .xls format."},{"id":"1f505745-e1c0-4902-ab62-e81b31eec95e","name":"Download current rates as CSV","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Token api_key","type":"text"},{"key":"Accept","value":"application/vnd.commpeak.com; version=1,text/csv","type":"text"},{"key":"Content-Type","value":"text/csv","type":"text","disabled":true}],"url":"https://api.commpeak.comrates/current/download"},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":[{"key":"Content-Type","value":"text/csv"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Disposition","value":"attachment; filename=\"filename.csv\"; filename*=UTF-8''filename.csv"}],"cookie":[],"responseTime":null,"body":"Destination,Prefix,Price,Billing Increments\nAfghanistan - Fixed,93,0.75,1/1"}],"_postman_id":"67110392-03d6-43db-8333-2cbe5257b03a"}],"id":"64ae1ad4-fd16-49cb-ae42-e68d274d5436","_postman_id":"64ae1ad4-fd16-49cb-ae42-e68d274d5436","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Token api_key"}]},"isInherited":true,"source":{"_postman_id":"f2ef70f6-3b49-4a7e-a717-7a099fe93f49","id":"f2ef70f6-3b49-4a7e-a717-7a099fe93f49","name":"CommPeak Billing API","type":"collection"}}},{"name":"SMS Rates","item":[{"name":"Show SMS Rates","id":"1bdc150d-f593-4f30-bdb1-c4d1be0587b8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.commpeak.com/rates/sms?username&id","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Token api_key"}]},"isInherited":true,"source":{"_postman_id":"f2ef70f6-3b49-4a7e-a717-7a099fe93f49","id":"f2ef70f6-3b49-4a7e-a717-7a099fe93f49","name":"CommPeak Billing API","type":"collection"}},"urlObject":{"path":["rates","sms"],"host":["https://api.commpeak.com"],"query":[{"description":{"content":"<p>SMS Channel Username</p>\n","type":"text/plain"},"key":"username","value":null},{"description":{"content":"<p>SMS Channel ID</p>\n","type":"text/plain"},"key":"id","value":null}],"variable":[]}},"response":[{"id":"6b403fe0-3bc6-4f5f-aa04-81cc53197404","name":"Show Rates","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.commpeak.comrates/sms?username=test","host":["https://api.commpeak.comrates"],"path":["sms"],"query":[{"key":"username","value":"test"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\n    {\n        \"rate\": 0.05,\n        \"mcc\": 10,\n        \"mnc\": 210\n    },\n    {\n        \"rate\": 0.05,\n        \"mcc\": 9,\n        \"mnc\": 210\n    }\n]"}],"_postman_id":"1bdc150d-f593-4f30-bdb1-c4d1be0587b8"}],"id":"d2f9ed0b-ba6a-4178-bdeb-860c5c3b6f40","_postman_id":"d2f9ed0b-ba6a-4178-bdeb-860c5c3b6f40","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Token api_key"}]},"isInherited":true,"source":{"_postman_id":"f2ef70f6-3b49-4a7e-a717-7a099fe93f49","id":"f2ef70f6-3b49-4a7e-a717-7a099fe93f49","name":"CommPeak Billing API","type":"collection"}}},{"name":"Speech-to-Text","item":[{"name":"Recognize","id":"74ee6f99-32ef-4326-b867-57e5386e3c77","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Recognition-Token","value":"","description":"<p>Customer's Speech Recognition Token</p>\n","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"languages","value":"en","description":"<p>2 letter language code to recognize</p>\n","type":"text","uuid":"5b07adcf-bfa8-457f-bae9-8fc279d86f01"},{"key":"recording","description":"<p>audio file to recognize</p>\n","type":"file","uuid":"1b1f8e18-76fa-4e72-bf65-9255e6b89f67","value":null},{"key":"remote_identifier","value":"my_id_1","description":"<p>custom ID to identify recognition task for customer</p>\n","type":"text","uuid":"b3dd29aa-5376-452b-a40f-e2ab7fcc4927"},{"key":"parse_channel","value":"0","description":"<p>0 - to recognize all channels, 1-2 specify which channel to recognize</p>\n","type":"text","uuid":"8741e497-6ed0-4df8-962d-dad65eeac3c6"},{"key":"webhook_url","value":"https://example.com/webhook","description":"<p>webhook to notify on task completion, (task_id, remote_identifier will be applied as GET parameters to URL)</p>\n","type":"text","uuid":"774fd31b-1762-4049-8fd0-584597b187f1"},{"key":"task_type","value":"transcribe","description":"<p>possible options - transcribe (default), translate, transcribe_and_translate</p>\n","type":"text","uuid":"7e44e269-29da-4a13-be26-68f63533d4da"}]},"url":"https://api.commpeak.com/speech/recognize.json","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Token api_key"}]},"isInherited":true,"source":{"_postman_id":"f2ef70f6-3b49-4a7e-a717-7a099fe93f49","id":"f2ef70f6-3b49-4a7e-a717-7a099fe93f49","name":"CommPeak Billing API","type":"collection"}},"urlObject":{"path":["speech","recognize.json"],"host":["https://api.commpeak.com"],"query":[],"variable":[]}},"response":[{"id":"3fd0ef45-348a-435b-b858-148d079cef26","name":"Recognize","originalRequest":{"method":"POST","header":[{"key":"X-Recognition-Token","value":"","description":"Customer's Speech Recognition Token","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"languages","value":"en","description":"2 letter language code to recognize","type":"text","uuid":"5b07adcf-bfa8-457f-bae9-8fc279d86f01"},{"key":"recording","description":"audio file to recognize","type":"file","uuid":"1b1f8e18-76fa-4e72-bf65-9255e6b89f67","value":null},{"key":"remote_identifier","value":"my_id_1","description":"custom ID to identify recognition task for customer","type":"text","uuid":"b3dd29aa-5376-452b-a40f-e2ab7fcc4927"},{"key":"parse_channel","value":"0","description":"0 - to recognize all channels, 1-2 specify which channel to recognize","type":"text","uuid":"8741e497-6ed0-4df8-962d-dad65eeac3c6"},{"key":"task_type","value":"transcribe_and_translate","description":"possible options - transcribe (default), translate, transcribe_and_translate","type":"text","uuid":"9341b77d-fd18-4e64-b2ab-f4de68ae3bf7"}]},"url":"{{baseUrl}}/speech/recognize.json"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n    \"task\": {\n        \"id\": 32421\n    }\n}"}],"_postman_id":"74ee6f99-32ef-4326-b867-57e5386e3c77"},{"name":"Get Result","id":"5deaa6e8-c0aa-41a5-8aa9-79779eb5e180","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Recognition-Token","value":"","description":"<p>Customer's Speech Recognition Token</p>\n","type":"text"}],"url":"https://api.commpeak.com/speech/result/:task_id.json","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Token api_key"}]},"isInherited":true,"source":{"_postman_id":"f2ef70f6-3b49-4a7e-a717-7a099fe93f49","id":"f2ef70f6-3b49-4a7e-a717-7a099fe93f49","name":"CommPeak Billing API","type":"collection"}},"urlObject":{"path":["speech","result",":task_id.json"],"host":["https://api.commpeak.com"],"query":[],"variable":[{"description":{"content":"<p>Speech Recognition Task ID</p>\n","type":"text/plain"},"type":"any","value":"","key":"task_id"}]}},"response":[{"id":"be54cf10-a0fa-42b1-8788-ecbe55801d3b","name":"Result","originalRequest":{"method":"GET","header":[]},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n    \"id\": 123,\n    \"duration\": 18,\n    \"languages\": [\n        \"es\"\n    ],\n    \"task_type\": \"transcribe_and_translate\",\n    \"remote_identifier\": \"test123\",\n    \"result\": {\n        \"remote_identifier\": \"test123\",\n        \"created_at\": \"2025-05-25 07:32:26\",\n        \"language\": \"en\",\n        \"plain_body\": \"hola\",\n        \"phrases\": [\n            {\n                \"start_at\": 0,\n                \"end_at\": 0,\n                \"phrase\": \"hola\",\n                \"channel\": 1\n            }\n        ],\n        \"translation_plain_body\": \"hello\",\n        \"translation_phrases\": [\n            {\n                \"start_at\": 0,\n                \"end_at\": 0,\n                \"phrase\": \"hello\",\n                \"channel\": 1\n            }\n\n        ],\n        \"sentiment\": 0,\n        \"sentiment_description\": \"Recording too short\",\n        \"summary\": \"Recording too short\",\n        \"entities\": {},\n        \"entities_list\": [],\n        \"metadata\": {}\n    }\n}"}],"_postman_id":"5deaa6e8-c0aa-41a5-8aa9-79779eb5e180"}],"id":"a8238264-8dcf-4649-9f64-afdd0f3be6e3","_postman_id":"a8238264-8dcf-4649-9f64-afdd0f3be6e3","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Token api_key"}]},"isInherited":true,"source":{"_postman_id":"f2ef70f6-3b49-4a7e-a717-7a099fe93f49","id":"f2ef70f6-3b49-4a7e-a717-7a099fe93f49","name":"CommPeak Billing API","type":"collection"}}}],"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Token api_key"}]}},"event":[{"listen":"prerequest","script":{"id":"94460f08-37eb-459f-b977-2a798bc9225f","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"a0d0c7b5-dd30-4b40-9ddc-179e9ce4b73a","type":"text/javascript","exec":[""]}}],"variable":[{"key":"API Token","value":"Token api_key"},{"key":"BaseURL","value":"https://api.commpeak.com"}]}