{"swagger":"2.0","info":{"version":"2015-11-01","title":"Call Control API","description":"API for blocking phone calls with Call Control. Data is from crowdsourced community blacklist from 12+ million users and government agencies (FTC, FCC, IRS) Try with api_key 'demo', hit explore above, and then try phone numbers 18008472911,13157244022,17275567300,18008276655,12061231234.","contact":{"name":"Call Control","url":"https://www.callcontrol.com/documentation","email":"info@kedlin.com"}},"host":"api.callcontrol.com","schemes":["https"],"paths":{"/api/2015-11-01/Complaints/{phoneNumber}":{"get":{"tags":["Complaints"],"summary":"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.","description":"This is the main funciton to get data out of the call control reporting system
\r\n Try with api_key 'demo' and phone numbers 18008472911, 13157244022, 17275567300, 18008276655, and 12061231234 (last one not spam)","operationId":"Complaints_Complaints","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"phoneNumber","in":"path","description":"phone number to search","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Complaints"}}},"deprecated":false}},"/api/2015-11-01/Enterprise/ShouldBlock/{phoneNumber}/{userPhoneNumber}":{"get":{"tags":["EnterpriseApi"],"summary":"Enterprise GET: ShouldBlock\r\nSimple Enteprise which returns a call block proceed decision.","description":"This returns information required to perform basic call blocking behaviors\r\n Try with api_key 'demo' and phone numbers 18008472911, 13157244022, 17275567300, 18008276655, and 12061231234 (last one not spam)","operationId":"EnterpriseApi_ShouldBlock","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"phoneNumber","in":"path","description":"phone number to search","required":true,"type":"string"},{"name":"userPhoneNumber","in":"path","description":"(OPTIONAL) phone number of user to look up block rules","required":true,"type":"string"}],"responses":{"400":{"description":"Bad request (invalid phone number)"},"200":{"description":"true(block) false (no block)","schema":{"enum":["allow","voiceMail","block"],"type":"string"}}},"deprecated":false}},"/api/2015-11-01/Enterprise/GetUser/{phoneNumber}":{"get":{"tags":["EnterpriseApi"],"summary":"Enterprise GET: GetUser\r\nReturns the current information from the user; try 12066194123 as demo","description":"","operationId":"EnterpriseApi_GetUser","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"phoneNumber","in":"path","required":true,"type":"string"}],"responses":{"400":{"description":"Bad request (invalid phone number)"},"200":{"description":"User Object","schema":{"$ref":"#/definitions/CallControlUser"}}},"deprecated":false}},"/api/2015-11-01/Enterprise/UpsertUser":{"post":{"tags":["EnterpriseApi"],"summary":"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)","operationId":"EnterpriseApi_UpsertUser","consumes":["application/json","text/json"],"produces":["application/json","text/json"],"parameters":[{"name":"user","in":"body","description":"[FromBody] User \r\n This returns information required to perform basic call blocking behaviors. The demo key will return ok, but will not save the data.
","required":true,"schema":{"$ref":"#/definitions/CallControlUser"}}],"responses":{"200":{"description":"Ok","schema":{"type":"object"}},"400":{"description":"Bad request (eg. invalid phone nubmer)"}},"deprecated":false}},"/api/2015-11-01/Reputation/{phoneNumber}":{"get":{"tags":["Reputation"],"summary":"Reputation:\r\nPremium service which returns a reputation informaiton of a phone number via API.","description":"This returns information required to perform basic call blocking behaviors
\r\n Try with api_key 'demo' and phone numbers 18008472911, 13157244022, 17275567300, 18008276655, and 12061231234 (last one not spam)","operationId":"Reputation_Reputation","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"phoneNumber","in":"path","description":"phone number to search","required":true,"type":"string"}],"responses":{"400":{"description":"Bad request (invalid phone number)"},"200":{"description":"Reputation information","schema":{"$ref":"#/definitions/Reputation"}}},"deprecated":false}},"/api/2015-11-01/Report":{"post":{"tags":["Reputation"],"summary":"Report: report spam calls received to better tune our algorithms based upon spam calls you receive","description":"This returns information required to perform basic call blocking behaviors
\r\n Try with api_key 'demo' and phone numbers 18008472911, 13157244022, 17275567300, 18008276655, and 12061231234 (last one not spam)","operationId":"Reputation_Report","consumes":["application/json","text/json"],"produces":["application/json","text/json"],"parameters":[{"name":"callReport","in":"body","description":"[FromBody] Call Report\r\n PhoneNumber, \r\n Caller name(optional), \r\n Call category(optional), \r\n Comment or tags(free text) (optional), \r\n Unwanted call - yes/no(optional),","required":true,"schema":{"$ref":"#/definitions/CallReport"}}],"responses":{"400":{"description":"Bad request (eg. invalid phone nubmer)"}},"deprecated":false}}},"definitions":{"Complaints":{"description":"Free service (with registration) which serves Government Do Not Call data via API \r\nSearch via phone number returns available data, reported name, total complaints","type":"object","properties":{"ReportedCallerName":{"description":"Reported Caller Name","maxLength":255,"minLength":0,"type":"string"},"TotalNumberOfComplaints":{"format":"int32","type":"integer"},"ComplaintsByEntity":{"type":"object","additionalProperties":{"format":"int32","type":"integer"}},"LastComplaintDate":{"format":"date-time","type":"string"},"Tags":{"type":"array","items":{"type":"string"}}}},"CallControlUser":{"type":"object","properties":{"PhoneNumber":{"type":"string"},"PhoneNumbeRegion":{"type":"string"},"WhiteList":{"type":"array","items":{"type":"string"}},"BlackList":{"type":"array","items":{"type":"string"}},"QuietHourList":{"type":"array","items":{"$ref":"#/definitions/QuietHour"}},"UseCommunityBlacklist":{"type":"boolean"},"BreakThroughQhWithMultipleCalls":{"type":"boolean"},"WhiteListBreaksQh":{"type":"boolean"},"BlockBehavior":{"enum":["allow","voiceMail","block"],"type":"string"},"Email":{"type":"string"},"Age":{"format":"int32","type":"integer"},"Gender":{"type":"string"},"Salutation":{"type":"string"},"FirstName":{"type":"string"},"MiddleName":{"type":"string"},"LastName":{"type":"string"},"Suffix":{"type":"string"}}},"QuietHour":{"type":"object","properties":{"DayOfWeekList":{"type":"array","items":{"enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"],"type":"string"}},"StartHourLocal":{"format":"int32","type":"integer"},"StartMinLocal":{"format":"int32","type":"integer"},"DurationMin":{"format":"int32","type":"integer"},"TimeZoneName":{"type":"string"}}},"Reputation":{"type":"object","properties":{"CallType":{"type":"string","readOnly":true},"Confidence":{"format":"int32","type":"integer"},"IsSpam":{"type":"boolean"},"LastComplaintDate":{"format":"date-time","type":"string"},"ReportedCallerName":{"type":"string"},"Tags":{"type":"array","items":{"type":"string"}}}},"CallReport":{"description":"Call Report\r\nPhoneNumber, \r\nCaller name(optional), \r\nCall category(optional), \r\nComment or tags(free text) (optional), \r\nUnwanted call - yes/no(optional),","type":"object","properties":{"PhoneNumber":{"type":"string"},"ReportedCallerName":{"type":"string"},"ReportedCallerId":{"type":"string"},"CallerType":{"enum":["Unknown","Telemarketing","Collection_Agency","Political","Surveyor","Prank_Call","Fund_Raiser","Other_Commercial","Scam","VOIP","Business","Reminder_Notification_Call","Junk_Fax","Fax_Machine","Spam_Text","RoboCall","NotSpam","Callback"],"type":"string"},"Comment":{"type":"string"},"UnwantedCall":{"type":"boolean"},"CallTime":{"format":"date-time","type":"string"},"Reporter":{"type":"string"},"IpAddress":{"type":"string"},"Latitude":{"format":"double","type":"number"},"Longitude":{"format":"double","type":"number"}}}},"securityDefinitions":{"apiKey":{"type":"apiKey","description":"API Key Authentication","name":"apiKey","in":"header"}}}