{"info":{"_postman_id":"3ac0124f-1eff-4472-b631-d69b53057296","name":"TeleVoIPs API","description":"

An API for current TeleVoIPs customers to retrieve information about their users, extensions, and run reports.

Authentication

In order to access this API you will need to request your API key from TeleVoips. Once you have an API key you can supply it with all of your requests. There are certain requests that require different authorization methods.

Location

The base url for the TeleVoIPs API is: https://api.televoips.com

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Authentication","slug":"authentication"},{"content":"Location","slug":"location"}],"owner":"3155589","collectionId":"3ac0124f-1eff-4472-b631-d69b53057296","publishedId":"T1DtfbSY","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-04-11T02:17:51.000Z"},"item":[{"name":"Reports","item":[{"name":"Call Detail Records","item":[{"name":"Request CDR report","id":"501505e9-ca02-4d09-bd3f-9ba8c26788a9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.televoips.com/reports/cdrs","description":"

Overview

You can use the /reports/cds endpoint to trigger the compilation of raw Call Detail Records from your telephony servers.

Once requested, the status will indicate 202 while the csv format file is compiled. It may take several minutes before the status code indicates 201 and the file indicated in the url property is ready for download.
You may poll this endpoint until the status indicates 201 in order to determine when to initiate the file download.
The data compiled in the generated file is from the previous day's records. Once the file is generated for a particular day, this file will not be recreated for the same day.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"[replace_with_your_api_key]"}]},"isInherited":true,"source":{"_postman_id":"3ac0124f-1eff-4472-b631-d69b53057296","id":"3ac0124f-1eff-4472-b631-d69b53057296","name":"TeleVoIPs API","type":"collection"}},"urlObject":{"path":["reports","cdrs"],"host":["https://api.televoips.com"],"query":[],"variable":[]}},"response":[{"id":"0d75147d-a716-4f2e-a5bc-aea75cfeeb51","name":"CDR export complete","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"[replace_with_your_api_key]","type":"text"}],"url":"https://api.televoips.com/reports/cdrs"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"12cd2374dc\",\n \"url\": \"https://api.televoips.com/reports/cdrs/12cd2374dc/cdrs_[yyyy-mm-dd].csv\",\n \"status\": \"complete\"\n}"},{"id":"66eb0e2a-3329-4ecc-a7cf-79ddfcbc3dce","name":"CDR export processing","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"[replace_with_your_api_key]","type":"text"}],"url":"https://api.televoips.com/reports/cdrs"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"12cd2374dc\",\n \"url\": \"https://api.televoips.com/reports/cdrs/12cd2374dc/cdrs_[yyyy-mm-dd].csv\",\n \"status\": \"processing\"\n}"},{"id":"b1f51ef6-124e-4028-b5da-82f03987af4a","name":"CDR report no api key","originalRequest":{"method":"GET","header":[],"url":"https://api.televoips.com/reports/cdrs"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"'Access Denied'"},{"id":"dbbe24dd-cc07-441d-8aee-08da18e2d316","name":"CDR report error","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"[replace_with_your_api_key]","type":"text"}],"url":"https://api.televoips.com/reports/cdrs"},"status":"Error","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"'There was a problem processing your request.'"},{"id":"ff0c5f6b-6d45-44a3-9a5f-88db1df2bcf7","name":"CDR export requested","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"[replace_with_your_api_key]","type":"text"}],"url":"https://api.televoips.com/reports/cdrs"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"12cd2374dc\",\n \"url\": \"https://api.televoips.com/reports/cdrs/12cd2374dc/cdrs_[yyyy-mm-dd].csv\",\n \"status\": \"requested\"\n}"}],"_postman_id":"501505e9-ca02-4d09-bd3f-9ba8c26788a9"},{"name":"Download CDR report file","id":"c6cffe73-9914-4618-8112-2f29265eb804","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.televoips.com/reports/cdrs/12cd2374dc/cdrs_[yyyy-mm-dd].csv","description":"

Overview

You can use the /reports/cdrs/12cd2374dc/cdrs_[yyyy-mm-dd].csv endpoint to download a Call Detail Report once the /report/cdrs endpoint indicates a status of 201.

The data compiled in this file is from the previous day's records. Once the file is generated for a particular day, this file will not be recreated for the same day.

CDR csv file fields

id - A float with the unique channel identifier.
calldate - A string that contains the date and time of the phone call.
clid - An escaped string containing the caller ID.
src - A string with the source phone number/extension.
dst - A string with the destination phone number/extension.
dcontext - A string that provides additional information as to where the call is going.
channel - A string with the channel used.
dstchannel - A string with the destination channel when appropriate.
lastapp - A string with the last application if appropriate.
lastdata - A string with the last application data.
duration - An integer that is the total time, in system, of a call in seconds.
billsec - An integer that indicates the length of the call based on billing time.
disposition - A string the indicates whether the call was answered.
amaflags - not used
accountcode - not used
uniqueid - A float with the unique channel identifier.
did - An integer representation of the phone number for incoming calls.
recordingfile - A string containing the location of a voice mail recording for a missed call.
cunm - A string with the caller ID number.
cnam - A string with the caller ID name.
outbound_cnum - A string with the outbound caller ID of the extension.
outbound_cnam - not used
dst_cnam - not used

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"[replace_with_your_api_key]"}]},"isInherited":true,"source":{"_postman_id":"3ac0124f-1eff-4472-b631-d69b53057296","id":"3ac0124f-1eff-4472-b631-d69b53057296","name":"TeleVoIPs API","type":"collection"}},"urlObject":{"path":["reports","cdrs","12cd2374dc","cdrs_[yyyy-mm-dd].csv"],"host":["https://api.televoips.com"],"query":[],"variable":[]}},"response":[{"id":"427152b7-1241-4e82-b733-0d085645cbe6","name":"Download file no api key","originalRequest":{"method":"GET","header":[],"url":"https://api.televoips.com/reports/cdrs/12cd2374dc/cdrs_[yyyy-mm-dd].csv"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"43"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"},{"id":"843d72c6-fd94-4fd1-831f-8fddfbb2a809","name":"Download CDR report file","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"[replace_with_your_api_key]","type":"text"}],"url":"https://api.televoips.com/reports/cdrs/12cd2374dc/cdrs_[yyyy-mm-dd].csv"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/csv"},{"key":"Content-Length","value":"123"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"[csv data]\r\n"},{"id":"cad66d4d-b8b2-4f76-bd29-b9491a4325cc","name":"Download file error","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"[replace_with_your_api_key]","type":"text"}],"url":"https://api.televoips.com/reports/cdrs/12cd2374dc/cdrs_[yyyy-mm-dd].csv"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"46"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"}],"_postman_id":"c6cffe73-9914-4618-8112-2f29265eb804"}],"id":"5e818b85-081f-4691-b7ca-0e40b952cb8c","_postman_id":"5e818b85-081f-4691-b7ca-0e40b952cb8c","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"[replace_with_your_api_key]"}]},"isInherited":true,"source":{"_postman_id":"3ac0124f-1eff-4472-b631-d69b53057296","id":"3ac0124f-1eff-4472-b631-d69b53057296","name":"TeleVoIPs API","type":"collection"}}}],"id":"8db8553c-1aaf-47e8-b08b-b3a3ffcab8d4","description":"

Overview

Trigger and download reports for information regarding you TeleVoips account.

\n","event":[{"listen":"prerequest","script":{"id":"1769ac51-1079-4209-a676-e9e7a2c02dee","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"be61fcc1-7536-43c1-aaab-4206af684365","type":"text/javascript","exec":[""]}}],"_postman_id":"8db8553c-1aaf-47e8-b08b-b3a3ffcab8d4","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"[replace_with_your_api_key]"}]},"isInherited":true,"source":{"_postman_id":"3ac0124f-1eff-4472-b631-d69b53057296","id":"3ac0124f-1eff-4472-b631-d69b53057296","name":"TeleVoIPs API","type":"collection"}}},{"name":"Messaging","item":[{"name":"Get Messages","id":"d2ba8118-db69-4281-804f-abe785c8b460","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.televoips.com/messages?start=yyyy-mm-dd HH:mm:ss&end=yyyy-mm-dd HH:mm:ss","description":"

Overview

You can use the GET /messages endpoint to receive a json list of messages. This list will only include the last 90 days of messages unless a start and/or end time is specified.

A date and time or simply date can be supplied. If a date is desired use yyyy-mm-dd instead.

\n","type":"text/plain"},"key":"start","value":"yyyy-mm-dd HH:mm:ss"},{"description":{"content":"

A date and time or simply date can be supplied. If a date is desired use yyyy-mm-dd instead.

\n","type":"text/plain"},"key":"end","value":"yyyy-mm-dd HH:mm:ss"}],"variable":[]}},"response":[{"id":"137f9d5a-7db3-4b5b-ae18-7140567241cc","name":"Get Messages Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"[replace_with_your_api_key]","disabled":true}],"url":{"raw":"https://api.televoips.com/messages?start=yyyy-mm-dd HH:mm:ss&end=yyyy-mm-dd HH:mm:ss","host":["https://api.televoips.com"],"path":["messages"],"query":[{"key":"start","value":"yyyy-mm-dd HH:mm:ss","description":"A date and time or simply date can be supplied. If a date is desired use yyyy-mm-dd instead."},{"key":"end","value":"yyyy-mm-dd HH:mm:ss","description":"A date and time or simply date can be supplied. If a date is desired use yyyy-mm-dd instead."}]}},"code":401,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"efdfba66-1975-4608-9482-f77671558973","name":"Get Messages Complete","originalRequest":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"[replace_with_your_api_key]"}],"url":{"raw":"https://api.televoips.com/messages?start=yyyy-mm-dd HH:mm:ss&end=yyyy-mm-dd HH:mm:ss","host":["https://api.televoips.com"],"path":["messages"],"query":[{"key":"start","value":"yyyy-mm-dd HH:mm:ss","description":"A date and time or simply date can be supplied. If a date is desired use yyyy-mm-dd instead."},{"key":"end","value":"yyyy-mm-dd HH:mm:ss","description":"A date and time or simply date can be supplied. If a date is desired use yyyy-mm-dd instead."}]}},"code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Content-Length","value":"123","description":"","type":"text"},{"key":"Connection","value":"keep-alive","description":"","type":"text"},{"key":"Content-Encoding","value":"gzip","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"b3762a34-1b75-4d8a-b5ac-c4b258bd0c46\",\n \"user_id\": null,\n \"number_id\": \"15125\",\n \"direction\": \"inbound\",\n \"to\": \"13214567890\",\n \"from\": \"19876543210\",\n \"content\": \"Test\",\n \"time\": \"2020-09-28 14:56:14\",\n \"read\": \"1\",\n \"Media\": []\n }\n]"}],"_postman_id":"d2ba8118-db69-4281-804f-abe785c8b460"},{"name":"Get Message","id":"ecaad08b-8e82-41a5-9454-3f4d49b8a9a7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.televoips.com/messages/123456789abcdefghijk","description":"

Overview

You can use the GET /messages/[message_id] endpoint to retrieve a single message by supplying the message id in the URL.

The phone number owned under your account you want the message to come from.

\n","key":"from","type":"text","value":"13214567890"},{"description":"

The phone number you want the message sent to.

\n","key":"to","type":"text","value":"19876543210"},{"description":"

The message you are sending.

\n","key":"content","type":"text","value":"Test"}]},"url":"https://api.televoips.com/messages","description":"

Overview

You can use the POST /messages endpoint to send a SMS message. Your organization must be authorized for texting in order to use this endpoint. The number used in the from field must be a number you own and it must be enabled for texting as well.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"[replace_with_your_api_key]"}]},"isInherited":true,"source":{"_postman_id":"7103a740-86ca-41e7-9161-65b3d402070b","id":"7103a740-86ca-41e7-9161-65b3d402070b","name":"Messaging","type":"folder"}},"urlObject":{"path":["messages"],"host":["https://api.televoips.com"],"query":[],"variable":[]}},"response":[{"id":"137d37bb-0ebc-4a32-9389-ff0e28b1c6fc","name":"Send Message Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"[replace_with_your_api_key]","disabled":true}],"body":{"mode":"formdata","formdata":[{"description":"The phone number owned under your account you want the message to come from.","key":"from","type":"text","value":"13214567890"},{"description":"The phone number you want the message sent to.","key":"to","type":"text","value":"19876543210"},{"description":"The message you are sending.","key":"content","type":"text","value":"Test"}]},"url":"https://api.televoips.com/messages"},"code":401,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"4299cd36-7cd9-410f-9259-207ec1123c7c","name":"Send Message Unauthorized Number","originalRequest":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"[replace_with_your_api_key]"}],"body":{"mode":"formdata","formdata":[{"description":"The phone number owned under your account you want the message to come from.","key":"from","type":"text","value":"[a phone number not owned by your organization]"},{"description":"The phone number you want the message sent to.","key":"to","type":"text","value":"19876543210"},{"description":"The message you are sending.","key":"content","type":"text","value":"Test"}]},"url":"https://api.televoips.com/messages"},"code":400,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unable to send message\"\n}"},{"id":"edd9290f-7023-4e35-a773-a3bd1f4f992c","name":"Send Message Complete","originalRequest":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"[replace_with_your_api_key]"}],"body":{"mode":"formdata","formdata":[{"key":"from","type":"text","value":"13214567890","description":"The phone number owned under your account you want the message to come from."},{"key":"to","type":"text","value":"19876543210","description":"The phone number you want the message sent to."},{"key":"content","type":"text","value":"Test","description":"The message you are sending."}]},"url":"https://api.televoips.com/messages"},"code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Content-Encoding","value":"gzip","description":"","type":"text"},{"key":"Content-Length","value":"123","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"uuid\": \"8331946p24i5a159sdbs56s4d644\"\n}"}],"_postman_id":"5f952e7c-07a7-4c6e-908a-45ee4e46b993"},{"name":"Unsubscribe","id":"86596239-39e1-4623-a525-be34f8af5298","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"description":"

The phone number that requested to block your number.

\n","key":"from","type":"text","value":"13214567890"},{"description":"

The phone number owned under your account you want to block from sending to the from number.

\n","key":"to","type":"text","value":"19876543210"}]},"url":"https://api.televoips.com/unsubscribe","description":"

Overview

You can use the POST /unsubscribe endpoint to update the list of phone numbers that have unsubscribed from one of your current phone numbers. Your organization must be authorized for texting in order to use this endpoint. The number used in the to field must be a number you own and it must be enabled for texting as well. Please note any number that has unsubscribed from any one number in your account will not be able to receive messages from any other number in your account.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"[replace_with_your_api_key]"}]},"isInherited":true,"source":{"_postman_id":"7103a740-86ca-41e7-9161-65b3d402070b","id":"7103a740-86ca-41e7-9161-65b3d402070b","name":"Messaging","type":"folder"}},"urlObject":{"path":["unsubscribe"],"host":["https://api.televoips.com"],"query":[],"variable":[]}},"response":[{"id":"79b9dad3-1b17-4fdd-b75d-bcbef549ccfd","name":"Unsubscribe Complete","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"[replace_with_your_api_key]","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"from","type":"text","value":"13214567890","description":"The phone number that requested to block your number."},{"key":"to","type":"text","value":"19876543210","description":"The phone number owned under your account you want to block from sending to the from number."}]},"url":"https://api.televoips.com/messages"},"code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Content-Encoding","value":"gzip","description":"","type":"text"},{"key":"Content-Length","value":"123","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":""},{"id":"6e5329c7-2f22-4fee-b023-153a0d4a975f","name":"Unsubscribe Unauthorized Number","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"[replace_with_your_api_key]","type":"text"}],"body":{"mode":"formdata","formdata":[{"description":"The phone number that requested to block your number.","key":"from","type":"text","value":"13214567890"},{"description":"The phone number owned under your account you want to block from sending to the from number.","key":"to","type":"text","value":"[a phone number not owned by your organization]"}]},"url":"https://api.televoips.com/messages"},"code":400,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"message\": \"You do not own the number you are trying to unsubscribe from\"\n}"},{"id":"e63f6856-c76e-4ffb-b302-4db92c4d1855","name":"Unsubscribe Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"[replace_with_your_api_key]","type":"text","disabled":true}],"body":{"mode":"formdata","formdata":[{"description":"The phone number that requested to block your number.","key":"from","type":"text","value":"13214567890"},{"description":"The phone number owned under your account you want to block from sending to the from number.","key":"to","type":"text","value":"19876543210"}]},"url":"https://api.televoips.com/messages"},"code":401,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"}],"_postman_id":"86596239-39e1-4623-a525-be34f8af5298"}],"id":"7103a740-86ca-41e7-9161-65b3d402070b","description":"

Send and receive a list of SMS messages from your account.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"[replace_with_your_api_key]"}]},"isInherited":false},"event":[{"listen":"prerequest","script":{"id":"3535a935-f6d4-4bcf-b54d-3048f1549d9c","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"eea82574-b894-4fc3-8bd5-dd3b066303b2","type":"text/javascript","exec":[""]}}],"_postman_id":"7103a740-86ca-41e7-9161-65b3d402070b"},{"name":"Webhooks","item":[{"name":"Messaging","item":[{"name":"Incoming Message","id":"611a4a5c-dbdc-41de-9f84-6821ac8e3cdf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\t\"type\" : \"message-received\",\r\n\t\"id\" : \"070468k1476ty5292yp2b2w2fuq2\",\r\n\t\"time\" : \"2021-08-24 12:20:17\",\r\n\t\"to\" : [\"12345678901\"],\r\n\t\"from\" : \"12345678900\",\r\n\t\"text\" : \"Test\",\r\n\t\"media\" : [\r\n\t\t\"https://mms.televoips.com/070468k1476ty5292yp2b2w2fuq2.jpg\"\r\n\t],\r\n\t\"direction\" : \"inbound\",\r\n\t\"segmentCount\" : 1\r\n}","options":{"raw":{"language":"json"}}},"url":"https://yoursubdomain.yourdomain.com/your/endpoint/here","description":"

Overview

The Incoming Message webhook expects a POST endpoint to send a json message body to. It also expects a 200 response if successful otherwise the webhook endpoint will be retried.

\n","urlObject":{"protocol":"https","path":["your","endpoint","here"],"host":["yoursubdomain","yourdomain","com"],"query":[],"variable":[]}},"response":[{"id":"e6cf04ff-7748-4513-8dc7-f8b446f97bd0","name":"Incoming Message Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\t\"type\" : \"message-received\",\r\n\t\"id\" : \"070468k1476ty5292yp2b2w2fuq2\",\r\n\t\"time\" : \"2021-08-24 12:20:17\",\r\n\t\"to\" : [\"12345678901\"],\r\n\t\"from\" : \"12345678900\",\r\n\t\"text\" : \"Test\",\r\n\t\"media\" : [\r\n\t\t\"https://mms.televoips.com/070468k1476ty5292yp2b2w2fuq2.jpg\"\r\n\t],\r\n\t\"direction\" : \"inbound\",\r\n\t\"segmentCount\" : 1\r\n}","options":{"raw":{"language":"json"}}},"url":"https://yoursubdomain.yourdomain.com/your/endpoint/here"},"code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"outcome\" : \"success\"\r\n}"}],"_postman_id":"611a4a5c-dbdc-41de-9f84-6821ac8e3cdf"},{"name":"Outgoing Message Delivered","id":"fd72db0e-33e9-4ed8-bcf1-dd99eabaf1f8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\t\"type\" : \"message-delivered\",\r\n\t\"id\" : \"292yp2b2w2fuq20y570468k1476t\",\r\n\t\"time\" : \"2021-08-24 12:20:17\",\r\n\t\"to\" : [\"12345678900\"],\r\n\t\"from\" : \"12345678901\",\r\n\t\"text\" : \"\",\r\n\t\"media\" : [],\r\n\t\"direction\" : \"outbound\",\r\n\t\"segmentCount\" : 1\r\n}","options":{"raw":{"language":"json"}}},"url":"https://yoursubdomain.yourdomain.com/your/endpoint/here","description":"

Overview

The Outgoing Message Delivered webhook expects a POST endpoint to send a json message body to. It also expects a 200 response if successful otherwise the webhook endpoint will be retried.

\n","urlObject":{"protocol":"https","path":["your","endpoint","here"],"host":["yoursubdomain","yourdomain","com"],"query":[],"variable":[]}},"response":[{"id":"3114eba2-11ac-47c1-88e3-e11c4d45b23d","name":"Outgoing Message Delivered Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\t\"type\" : \"message-delivered\",\r\n\t\"id\" : \"292yp2b2w2fuq20y570468k1476t\",\r\n\t\"time\" : \"2021-08-24 12:20:17\",\r\n\t\"to\" : [\"12345678900\"],\r\n\t\"from\" : \"12345678901\",\r\n\t\"text\" : \"Test back\",\r\n\t\"media\" : [],\r\n\t\"direction\" : \"outbound\",\r\n\t\"segmentCount\" : 1\r\n}","options":{"raw":{"language":"json"}}},"url":"https://yoursubdomain.yourdomain.com/your/endpoint/here"},"code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"outcome\" : \"success\"\r\n}"}],"_postman_id":"fd72db0e-33e9-4ed8-bcf1-dd99eabaf1f8"},{"name":"Outgoing Message Failed","id":"5da60ff0-86ba-4f85-a599-574a4c852b93","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\t\"type\" : \"message-failed\",\r\n\t\"id\" : \"292yp2b2w2fuq20y570468k1476t\",\r\n\t\"time\" : \"2021-08-24 12:20:17\",\r\n\t\"to\" : [\"12345678900\"],\r\n\t\"from\" : \"12345678901\",\r\n\t\"text\" : \"\",\r\n\t\"media\" : [],\r\n\t\"direction\" : \"outbound\",\r\n\t\"segmentCount\" : 1,\r\n\t\"errorCode\" : 4432,\r\n\t\"description\" : \"forbidden to country\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://yoursubdomain.yourdomain.com/your/endpoint/here","description":"

Overview

The Outgoing Message Failed webhook expects a POST endpoint to send a json message body to. It also expects a 200 response if successful otherwise the webhook endpoint will be retried.

Overview

Messaging webhooks expect a POST endpoint to send a json body to. They also expect a 200 response. If anything other than a 200 response is received the webhook will retry the endpoint with the event message for 1 hour or 20 retries, whichever comes first, before terminating the event.

Authentication

Webhooks support both Basic authentication as well as API Key authentication. The credentials supplied during webhook creation will be used during the request. This includes username and password for Basic or api key header and api key value for API Key.

Event Types

There are 3 different messaging event types. The type will be in the json body of the request. The types are:

message-received
message-delivered
message-failed

\n","_postman_id":"528fb943-da0d-45fb-a725-1be3eda42886","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"705e6c62-83b9-4a56-a216-18e8d23cc4fb","id":"705e6c62-83b9-4a56-a216-18e8d23cc4fb","name":"Webhooks","type":"folder"}}},{"name":"Call Detail Records","item":[{"name":"Call Detail Record","id":"952a9c32-b7b8-4d1b-b02e-ae21f3e88f0c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"[\r\n {\r\n \"calldate\": \"2021-08-25 10:04:14\",\r\n \"clid\": \"\\\"Test\\\" <1234567890>\",\r\n \"src\": \"1234567890\",\r\n \"dst\": \"201\",\r\n \"dcontext\": \"ext-local\",\r\n \"channel\": \"PJSIP/CHANNEL-0001a2b3\",\r\n \"dstchannel\": \"PJSIP/201-0001c2d3\",\r\n \"lastapp\": \"Dial\",\r\n \"lastdata\": \"PJSIP/2001/sip:201@123.456.789.012:10000;transport=TCP,30\",\r\n \"duration\": \"30\",\r\n \"billsec\": \"0\",\r\n \"disposition\": \"NO ANSWER\",\r\n \"amaflags\": \"3\",\r\n \"accountcode\": \"\",\r\n \"uniqueid\": \"1629900254.9521335\",\r\n \"userfield\": \"\",\r\n \"did\": \"3525932093\",\r\n \"recordingfile\": \"external-201-1234567890-20210825-100414-1629900254.9521335.wav\",\r\n \"cnum\": \"1234567890\",\r\n \"cnam\": \"Test\",\r\n \"outbound_cnum\": \"\",\r\n \"outbound_cnam\": \"\",\r\n \"dst_cnam\": \"\"\r\n }\r\n]","options":{"raw":{"language":"json"}}},"url":"https://yoursubdomain.yourdomain.com/your/endpoint/here","description":"

The Call Detail Record webhook expects a POST endpoint to send a json message body to. It also expects a 200 response if successful otherwise the webhook endpoint will be retried.

\n","urlObject":{"protocol":"https","path":["your","endpoint","here"],"host":["yoursubdomain","yourdomain","com"],"query":[],"variable":[]}},"response":[{"id":"613ca7af-7955-40f8-8146-64725118a041","name":"Call Detail Record Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"[\r\n {\r\n \"calldate\": \"2021-08-25 10:04:14\",\r\n \"clid\": \"\\\"Test\\\" <1234567890>\",\r\n \"src\": \"1234567890\",\r\n \"dst\": \"201\",\r\n \"dcontext\": \"ext-local\",\r\n \"channel\": \"PJSIP/CHANNEL-0001a2b3\",\r\n \"dstchannel\": \"PJSIP/201-0001c2d3\",\r\n \"lastapp\": \"Dial\",\r\n \"lastdata\": \"PJSIP/2001/sip:201@123.456.789.012:10000;transport=TCP,30\",\r\n \"duration\": \"30\",\r\n \"billsec\": \"0\",\r\n \"disposition\": \"NO ANSWER\",\r\n \"amaflags\": \"3\",\r\n \"accountcode\": \"\",\r\n \"uniqueid\": \"1629900254.9521335\",\r\n \"userfield\": \"\",\r\n \"did\": \"3525932093\",\r\n \"recordingfile\": \"external-201-1234567890-20210825-100414-1629900254.9521335.wav\",\r\n \"cnum\": \"1234567890\",\r\n \"cnam\": \"Test\",\r\n \"outbound_cnum\": \"\",\r\n \"outbound_cnam\": \"\",\r\n \"dst_cnam\": \"\"\r\n }\r\n]","options":{"raw":{"language":"json"}}},"url":"https://yoursubdomain.yourdomain.com/your/endpoint/here"},"code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"outcome\": \"success\"\n}"}],"_postman_id":"952a9c32-b7b8-4d1b-b02e-ae21f3e88f0c"}],"id":"1fe99e1e-02f3-4665-9d8a-435257dbaa24","description":"

Overview

Call Detail Records webhooks expect a POST endpoint to send a json body to. They also expect a 200 response. If anything other than a 200 response is received the webhook will retry the endpoint with the event message for 1 hour or 20 retries, whichever comes first, before terminating the event.

Authentication

\n","_postman_id":"1fe99e1e-02f3-4665-9d8a-435257dbaa24","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"705e6c62-83b9-4a56-a216-18e8d23cc4fb","id":"705e6c62-83b9-4a56-a216-18e8d23cc4fb","name":"Webhooks","type":"folder"}}}],"id":"705e6c62-83b9-4a56-a216-18e8d23cc4fb","description":"

These are example requests that will be made to your specified endpoint when an event occurs.

\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"8f03f816-af6f-40c3-9b11-3e9a93f8e3b9","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"dc9eabe5-2d9c-4727-885b-0885c2889061","type":"text/javascript","exec":[""]}}],"_postman_id":"705e6c62-83b9-4a56-a216-18e8d23cc4fb"}],"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"[replace_with_your_api_key]"}]}},"event":[{"listen":"prerequest","script":{"id":"388e85c7-2e80-45eb-8937-2d6ce04a66e3","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"31dd088a-c2ea-4453-ae83-2a74b2d4e126","type":"text/javascript","exec":[""]}}],"variable":[{"key":"base_url","value":"https://api.televoips.com"},{"key":"folder","value":"12cd2374dc"},{"key":"file","value":"cdrs_[yyyy-mm-dd].csv"},{"key":"api_header","value":"x-api-key"},{"key":"api_key","value":"[replace_with_your_api_key]"}]}