{ "uuid": "774b6dd9-3230-4061-92c6-36820119cf66", "lastMigration": 29, "name": "Call Control API", "endpointPrefix": "", "latency": 0, "port": 3000, "hostname": "", "routes": [ { "uuid": "effa852d-dc38-4962-8506-62fe4f59c057", "documentation": "Complaints: Free service (with registration), providing community and government complaint lookup by phone number for up to 2,000 queries per month. Details include number complaint rates from (FTC, FCC, IRS, Indiana Attorney General) and key entity tag extractions from complaints.", "method": "get", "endpoint": "api/2015-11-01/Complaints/:phoneNumber", "responses": [ { "uuid": "2a553a42-00e5-47ec-b82f-5c4c5a6275c0", "body": "{\n \"ComplaintsByEntity\": {},\n \"LastComplaintDate\": \"{{faker 'date.recent' 365}}\",\n \"ReportedCallerName\": \"\",\n \"Tags\": [\n \"\"\n ],\n \"TotalNumberOfComplaints\": {{faker 'number.int' max=99999}}\n}", "latency": 0, "statusCode": 200, "label": "OK", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "5c53e1bf-995d-4888-adbf-0ae64eed66ba", "documentation": "Enterprise GET: GetUser\r\nReturns the current information from the user; try 12066194123 as demo", "method": "get", "endpoint": "api/2015-11-01/Enterprise/GetUser/:phoneNumber", "responses": [ { "uuid": "bae52e1f-0a89-4149-8b0e-b5bd70c60db2", "body": "{\n \"Age\": {{faker 'number.int' max=99999}},\n \"BlackList\": [\n \"\"\n ],\n \"BlockBehavior\": \"{{oneOf (array 'allow' 'voiceMail' 'block')}}\",\n \"BreakThroughQhWithMultipleCalls\": {{faker 'datatype.boolean'}},\n \"Email\": \"\",\n \"FirstName\": \"\",\n \"Gender\": \"\",\n \"LastName\": \"\",\n \"MiddleName\": \"\",\n \"PhoneNumbeRegion\": \"\",\n \"PhoneNumber\": \"\",\n \"QuietHourList\": [\n {\n \"DayOfWeekList\": [\n \"{{oneOf (array 'Sunday' 'Monday' 'Tuesday' 'Wednesday' 'Thursday' 'Friday' 'Saturday')}}\"\n ],\n \"DurationMin\": {{faker 'number.int' max=99999}},\n \"StartHourLocal\": {{faker 'number.int' max=99999}},\n \"StartMinLocal\": {{faker 'number.int' max=99999}},\n \"TimeZoneName\": \"\"\n }\n ],\n \"Salutation\": \"\",\n \"Suffix\": \"\",\n \"UseCommunityBlacklist\": {{faker 'datatype.boolean'}},\n \"WhiteList\": [\n \"\"\n ],\n \"WhiteListBreaksQh\": {{faker 'datatype.boolean'}}\n}", "latency": 0, "statusCode": 200, "label": "User Object", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "19001c53-782d-4b53-a16b-591b942fa3ff", "body": "", "latency": 0, "statusCode": 400, "label": "Bad request (invalid phone number)", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "cc57f40d-57a6-47f6-b188-bc5dfd82709e", "documentation": "Enterprise GET: ShouldBlock\r\nSimple Enteprise which returns a call block proceed decision.", "method": "get", "endpoint": "api/2015-11-01/Enterprise/ShouldBlock/:phoneNumber/:userPhoneNumber", "responses": [ { "uuid": "24542878-5ba5-4e81-97f3-01f6e1c0f6a9", "body": "\"{{oneOf (array 'allow' 'voiceMail' 'block')}}\"", "latency": 0, "statusCode": 200, "label": "true(block) false (no block)", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "202106f5-0f2e-44c8-ae38-cee3a5dbae33", "body": "", "latency": 0, "statusCode": 400, "label": "Bad request (invalid phone number)", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "ad187334-c2a3-4bff-a7c2-a04ab0333a1f", "documentation": "UpsertUser: insert or update all properties from a user\r\nPhoneNumber\r\nWhiteList (list of phone numbers to whitelist)\r\nBlackList (list of phone numbers to blacklist)\r\nQuietHourList (list of quiet hour objects)\r\nUseCommunityBlacklist (enable / disable community blacklist) default true\r\nBreakThroughQhWithMultipleCalls (break through quiet hours with two calls in 3 minutes)\r\nWhiteListBreaksQh (break through quiet hours for whitelist)", "method": "post", "endpoint": "api/2015-11-01/Enterprise/UpsertUser", "responses": [ { "uuid": "3f588b80-4311-4013-9138-4d15eb43be83", "body": "{}", "latency": 0, "statusCode": 200, "label": "Ok", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "ef88b1c9-e50f-418e-bdba-0886fe31b183", "body": "", "latency": 0, "statusCode": 400, "label": "Bad request (eg. invalid phone nubmer)", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "35edb9e7-0ac2-48f3-8e34-14f29f8ea7d6", "documentation": "Report: report spam calls received to better tune our algorithms based upon spam calls you receive", "method": "post", "endpoint": "api/2015-11-01/Report", "responses": [ { "uuid": "dc2a330a-733d-4433-b71a-edfd5f98c29d", "body": "", "latency": 0, "statusCode": 400, "label": "Bad request (eg. invalid phone nubmer)", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "da28a600-7c04-4b52-9dd9-f4e44108eb6b", "documentation": "Reputation:\r\nPremium service which returns a reputation informaiton of a phone number via API.", "method": "get", "endpoint": "api/2015-11-01/Reputation/:phoneNumber", "responses": [ { "uuid": "9df42d7b-886e-418b-bf69-36178d3f7680", "body": "{\n \"CallType\": \"\",\n \"Confidence\": {{faker 'number.int' max=99999}},\n \"IsSpam\": {{faker 'datatype.boolean'}},\n \"LastComplaintDate\": \"{{faker 'date.recent' 365}}\",\n \"ReportedCallerName\": \"\",\n \"Tags\": [\n \"\"\n ]\n}", "latency": 0, "statusCode": 200, "label": "Reputation information", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "c932d200-65df-45c4-ab9f-b4a302f65442", "body": "", "latency": 0, "statusCode": 400, "label": "Bad request (invalid phone number)", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" } ], "proxyMode": false, "proxyHost": "", "proxyRemovePrefix": false, "tlsOptions": { "enabled": false, "type": "CERT", "pfxPath": "", "certPath": "", "keyPath": "", "caPath": "", "passphrase": "" }, "cors": true, "headers": [], "proxyReqHeaders": [{ "key": "", "value": "" }], "proxyResHeaders": [{ "key": "", "value": "" }], "data": [], "folders": [], "rootChildren": [ { "type": "route", "uuid": "effa852d-dc38-4962-8506-62fe4f59c057" }, { "type": "route", "uuid": "5c53e1bf-995d-4888-adbf-0ae64eed66ba" }, { "type": "route", "uuid": "cc57f40d-57a6-47f6-b188-bc5dfd82709e" }, { "type": "route", "uuid": "ad187334-c2a3-4bff-a7c2-a04ab0333a1f" }, { "type": "route", "uuid": "35edb9e7-0ac2-48f3-8e34-14f29f8ea7d6" }, { "type": "route", "uuid": "da28a600-7c04-4b52-9dd9-f4e44108eb6b" } ] }