{"info":{"_postman_id":"3523e311-c824-4cc0-9229-1ce05b7387ad","name":"IntouchConnections Base Broadcast Call API","description":"<html><head></head><body><p>BASE CALL REST API Collection.  This collection is the base Broadcast CALL API for voice dialer broadcasts.  All calls can be accesed via standard REST calls.  If there are any questions, please contact your account manager or <a href=\"mailto:support@intouchconnections.com\">support@intouchconnections.com</a></p>\n<p>Please note this API will run on port 6001.  If you have any customizations your account manager will provide you a custom end point you will use instead.</p>\n<h1 id=\"overview\">Overview</h1>\n<p>This API Requires a live account to access.  Functionality will allow for creating call campaigns via REST calls that can be scheduled for future dates.   In order to activate a campaign ALL 3 parts must be completed.</p>\n<ol>\n<li>You must create a CallBroadcast</li>\n<li>A successful CallBroadcast will return a broadcast ID, you will post audio and a CSV list to this broadcast.</li>\n<li>You must generate a test call</li>\n<li>After steps 1-3 are complete you can activate</li>\n</ol>\n<h1 id=\"authentication\">Authentication</h1>\n<p>Authentication uses BASIC auth, and your accounts whitelisted IP Address(s), custom calls can be added upon request for your account and addded to your API Endpoints via your account manager. </p>\n<p>example:  \"Authorization\": \"Basic bmVicmFza2E6d32132132121yMzQ1\",</p>\n<h1 id=\"error-codes\">Error Codes</h1>\n<p>Error codes will be returned with description.  Error codes are</p>\n<p>0 - SUCCESS\n2 - NOT VALID REQUEST\n3 - NOT 1 VALID # for CALL CAMPAIGN\n4 - INVALID START TIME\n5 - PREVIOUSLY DELETED CAMPAIGN</p>\n<h1 id=\"rate-limit\">Rate limit</h1>\n<p>Calls will go out up to 10CPS, Rate limits can be increased per account by requesting an increase with your project manager.</p>\n</body></html>","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Overview","slug":"overview"},{"content":"Authentication","slug":"authentication"},{"content":"Error Codes","slug":"error-codes"},{"content":"Rate limit","slug":"rate-limit"}],"owner":"4400122","collectionId":"3523e311-c824-4cc0-9229-1ce05b7387ad","publishedId":"S1a7V5kB","public":true,"customColor":{"top-bar":"E7E7E7","right-sidebar":"303030","highlight":"00A5DB"},"publishDate":"2019-07-01T01:16:49.000Z"},"item":[{"name":"https://api.intouchconnections.com:6001/broadcastCALL/create","id":"2de94c0d-a76c-46e3-8e9c-a81ebd22316b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"<username>"},{"key":"password","value":"<password>"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"startTime","type":"text","value":"02/18/2019 4:00PM"},{"key":"campaignName","type":"text","value":"TestCampagin"}]},"url":"https://api.intouchconnections.com:6001/broadcastCALL/create","description":"<p>Creating A broadcast.</p>\n<p>Createing a broadcast is a very powerful feature that requires 3 parts.  A broadcast will send to a csv list at a designated time CST the audio file you provide.   </p>\n","urlObject":{"protocol":"https","port":"6001","path":["broadcastCALL","create"],"host":["api","intouchconnections","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"2de94c0d-a76c-46e3-8e9c-a81ebd22316b"},{"name":"https://api.intouchconnections.com:6001/broadcastCALL/{{broadcastID}}/csv","id":"11406a58-92d7-4f97-9fd4-88b252841af6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"<username>"},{"key":"password","value":"<password>"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"phone,CustomIdentifier\n6305551234,Joe Smith\n6305551222,Tom Jones"},"url":"https://api.intouchconnections.com:6001/broadcastCALL/1/csv","description":"<p>Provide the csv to the broadcastId (The broadcast ID is returned in the create call).  Ensure the first column of you CSV is the 10 digit phone # of the recipient.</p>\n","urlObject":{"protocol":"https","port":"6001","path":["broadcastCALL","1","csv"],"host":["api","intouchconnections","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"11406a58-92d7-4f97-9fd4-88b252841af6"},{"name":"https://api.intouchconnections.com:6001/broadcastCALL/{{broadcastID}}/audio","id":"c74ad990-c3dc-4082-8a85-501b0420ca82","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"<username>"},{"key":"password","value":"<password>"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/x-www-form-urlencoded"}],"body":{"mode":"file","file":{"src":"/C:/test/hello.wav"}},"url":"https://api.intouchconnections.com:6001/broadcastCALL/1/audio","description":"<p>Provide the AUDIO(.wav/.mp3) the broadcastId (The broadcast ID is returned in the create call).</p>\n","urlObject":{"protocol":"https","port":"6001","path":["broadcastCALL","1","audio"],"host":["api","intouchconnections","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"c74ad990-c3dc-4082-8a85-501b0420ca82"},{"name":"https://api.intouchconnections.com:6001/broadcastCALL/{{broadcastID}}/test","id":"e3c82a37-c964-4b82-90d5-1c06129f993d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"<username>"},{"key":"password","value":"<password>"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"testPhone","value":"6305755555","type":"text"}]},"url":"https://api.intouchconnections.com:6001/broadcastCALL/1/test","description":"<p>Once CSV and AUdio have been upload, you must run a test call.  You cannot activate a broadcast until a testcall has been made.</p>\n","urlObject":{"protocol":"https","port":"6001","path":["broadcastCALL","1","test"],"host":["api","intouchconnections","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"e3c82a37-c964-4b82-90d5-1c06129f993d"},{"name":"https://api.intouchconnections.com:6001/broadcastCALL/{{broadcastId}}/activate","id":"9cc08d95-9f80-4e4f-8819-0aae7c6121f2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"<username>"},{"key":"password","value":"<password>"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[]},"url":"https://api.intouchconnections.com:6001/broadcastCALL/1/activate","description":"<p>Activate Broadcast.  Once activated this broadcast will be active at the time you have set.  If no valid date was sent it will be active immidiately.</p>\n","urlObject":{"protocol":"https","port":"6001","path":["broadcastCALL","1","activate"],"host":["api","intouchconnections","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"9cc08d95-9f80-4e4f-8819-0aae7c6121f2"},{"name":"https://api.intouchconnections.com:6001/broadcastCALL/{{broadcastId}}/detail","id":"d735dd36-eb20-4241-a927-bc0a7f8d19ab","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"<username>"},{"key":"password","value":"<password>"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"startTime","type":"text","value":"02/18/2019 4:00PM","disabled":true},{"key":"smsMessage","type":"text","value":"Hi there {{myField1}}, how are you today {{myField2}}","disabled":true}]},"url":"https://api.intouchconnections.com:6001/broadcastCALL/1/detail","description":"<p>This will return all items from a broadcast with CALL status.</p>\n","urlObject":{"protocol":"https","port":"6001","path":["broadcastCALL","1","detail"],"host":["api","intouchconnections","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"d735dd36-eb20-4241-a927-bc0a7f8d19ab"},{"name":"https://api.intouchconnections.com:6001/broadcastCALL/{{broadcastId}}/delete","id":"65d8932c-a95e-42d3-821c-a7918439900c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"<username>"},{"key":"password","value":"<password>"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"startTime","type":"text","value":"02/18/2019 4:00PM","disabled":true},{"key":"smsMessage","type":"text","value":"Hi there {{myField1}}, how are you today {{myField2}}","disabled":true}]},"url":"https://api.intouchconnections.com:6001/broadcastCALL/1/delete","description":"<p>This rest call is used to delete a broadcast.  Please note all broadcasts can only be deleted prior to sending.</p>\n","urlObject":{"protocol":"https","port":"6001","path":["broadcastCALL","1","delete"],"host":["api","intouchconnections","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"65d8932c-a95e-42d3-821c-a7918439900c"},{"name":"https://api.intouchconnections.com:5012/lacounty/broadcastCALL/1/audio","id":"95ebbae3-214a-48d3-b4bf-64ac81f997e2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"<username>"},{"key":"password","value":"<password>"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","type":"file","value":null,"warning":"This file resides outside the working directory. Collaborators might not have the same file path."}]},"url":"https://api.intouchconnections.com:5012/lacounty/broadcastCALL/1/audio","urlObject":{"protocol":"https","port":"5012","path":["lacounty","broadcastCALL","1","audio"],"host":["api","intouchconnections","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"95ebbae3-214a-48d3-b4bf-64ac81f997e2"},{"name":"18.213.70.155","id":"cf9604de-d89b-4e25-9945-e61b3a3a7c1b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"broadcastId","value":"1","type":"text"},{"key":"audioFile","value":"1.wav","type":"text"},{"key":"testMessageNumber","value":"6303378573","type":"text"}]},"url":"18.213.70.155/voipControl/api/apiTestBroadcast.php","description":"<p>POST TEST</p>\n","urlObject":{"path":["voipControl","api","apiTestBroadcast.php"],"host":["18","213","70","155"],"query":[{"disabled":true,"key":"broadcastId","value":"1"},{"disabled":true,"key":"audioFile","value":"1.wav"},{"disabled":true,"key":"testMessageNumber","value":"6303378573"}],"variable":[]}},"response":[],"_postman_id":"cf9604de-d89b-4e25-9945-e61b3a3a7c1b"}],"event":[{"listen":"prerequest","script":{"id":"360924fd-5988-4cf3-84bb-569f2daff1de","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"f0cb3ebb-a050-4461-b9bb-4e084b61c947","type":"text/javascript","exec":[""]}}]}