{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","params":[],"results":{"codes":[]},"settings":""},"next":{"description":"","pages":[]},"title":"Blocked Calls","type":"basic","slug":"account-blocked-calls","excerpt":"","body":"The Blocked Calls API allows users block incoming calls from specific phone numbers. If only a part of a telephone number is provided, calls with callers ID matching the pattern will be blocked.\n\nFor example, pattern \"+1212\" will block all calls from NY 212 area code.\n\n## Supported Services\n* [List Blocked Calls](doc:list-account-blocked-calls)\n* [Get Blocked Call](doc:get-account-blocked-call) \n* [Create Blocked Call](doc:create-account-blocked-call)\n* [Delete Blocked Call](doc:delete-account-blocked-call) \n\n## Full Object\nThe Blocked Calls Full Object is used to represent a blocked call object. It consists of the properties listed below:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"`id`\",\n    \"0-1\": \"Integer\",\n    \"0-2\": \"The Blocked Call ID\",\n    \"1-0\": \"`voip_id`\",\n    \"1-1\": \"Integer\",\n    \"1-2\": \"API account ID\",\n    \"2-0\": \"`start_date`\",\n    \"2-1\": \"Integer\",\n    \"2-2\": \"Timestamp in UNIX format\",\n    \"3-0\": \"`type`\",\n    \"3-1\": \"String\",\n    \"3-2\": \"`incoming` or `outgoing`\",\n    \"4-0\": \"`pattern_type`\",\n    \"4-1\": \"String\",\n    \"4-2\": \"`equals` or `starts_with`\",\n    \"5-0\": \"`pattern`\",\n    \"5-1\": \"String\",\n    \"5-2\": \"Required field.\\nStarts with '+', followed by digits\\nUp to 14 characters\",\n    \"6-0\": \"`notes`\",\n    \"6-1\": \"String\",\n    \"6-2\": \"Up to 80 characters\"\n  },\n  \"cols\": 3,\n  \"rows\": 7\n}\n[/block]\nHere is an example:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"id\\\": 905063,\\n    \\\"voip_id\\\": 1000000,\\n    \\\"start_date\\\": 1586203274,\\n    \\\"type\\\": \\\"incoming\\\",\\n    \\\"pattern_type\\\": \\\"equals\\\",\\n    \\\"pattern\\\": \\\"+15551230000\\\",\\n    \\\"notes\\\": \\\"\\\"\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]","updates":[],"order":0,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5ede53cb8eb5b5003437003b","createdAt":"2020-06-08T15:05:47.378Z","user":"56f99ab84d2b4f3400edb636","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Account Blocked Calls","slug":"blocked-calls","order":5,"from_sync":false,"reference":false,"_id":"5ede526e75bc22005d0adecc","createdAt":"2020-06-08T14:59:58.358Z","version":"57624356653c2d2200fec79c","project":"55c8cff571d7580d0063a5e5","__v":0},"version":{"version":"4","version_clean":"4.0.0","codename":"","is_stable":true,"is_beta":true,"is_hidden":false,"is_deprecated":false,"categories":["57624356653c2d2200fec79d","57624356653c2d2200fec79e","57624356653c2d2200fec79f","57624356653c2d2200fec7a0","57624356653c2d2200fec7a1","57624356653c2d2200fec7a2","57624356653c2d2200fec7a3","57624356653c2d2200fec7a4","57624356653c2d2200fec7a5","57624356653c2d2200fec7a6","57624356653c2d2200fec7a7","57624356653c2d2200fec7a8","57624356653c2d2200fec7a9","57624356653c2d2200fec7aa","5779ca1b99b40b0e005abb3a","5779d198aea88b0e00f63277","5797d3ab17ced017003c4be4","57ac170ef1cdae0e0053cdfc","57dbfc723ed3450e00dc9e6d","5804d12d16161c0f0077df9b","5841064b652e5b0f0015a7c8","588b5e5f2966b2230009cbf9","58a68ebf3239fa0f00857619","58c23c8b4922930f0050ac91","58fd1460809fc30f00f2ee07","5934eaf5328680002d77de6a","594bf91601cfe6000f40f4c5","595c4ed696b447001ba0cf6d","596524495cee50001575f5be","5970d4f1313162004dd303b5","59780fac24dbd1001a1fa057","59a8cfd3ead78a002d63cafe","59e0323d93da1f001c9ec170","5b0c16f2be9fcb0003e28222","5ba8fd1a4c8c220003a08f0f","5ede526e75bc22005d0adecc"],"_id":"57624356653c2d2200fec79c","createdAt":"2016-06-16T06:12:38.244Z","releaseDate":"2016-06-16T06:12:38.244Z","__v":23,"project":"55c8cff571d7580d0063a5e5"},"project":"55c8cff571d7580d0063a5e5","__v":0,"parentDoc":null}
The Blocked Calls API allows users block incoming calls from specific phone numbers. If only a part of a telephone number is provided, calls with callers ID matching the pattern will be blocked. For example, pattern "+1212" will block all calls from NY 212 area code. ## Supported Services * [List Blocked Calls](doc:list-account-blocked-calls) * [Get Blocked Call](doc:get-account-blocked-call) * [Create Blocked Call](doc:create-account-blocked-call) * [Delete Blocked Call](doc:delete-account-blocked-call) ## Full Object The Blocked Calls Full Object is used to represent a blocked call object. It consists of the properties listed below: [block:parameters] { "data": { "h-0": "Property", "h-1": "Type", "h-2": "Description", "0-0": "`id`", "0-1": "Integer", "0-2": "The Blocked Call ID", "1-0": "`voip_id`", "1-1": "Integer", "1-2": "API account ID", "2-0": "`start_date`", "2-1": "Integer", "2-2": "Timestamp in UNIX format", "3-0": "`type`", "3-1": "String", "3-2": "`incoming` or `outgoing`", "4-0": "`pattern_type`", "4-1": "String", "4-2": "`equals` or `starts_with`", "5-0": "`pattern`", "5-1": "String", "5-2": "Required field.\nStarts with '+', followed by digits\nUp to 14 characters", "6-0": "`notes`", "6-1": "String", "6-2": "Up to 80 characters" }, "cols": 3, "rows": 7 } [/block] Here is an example: [block:code] { "codes": [ { "code": "{\n \"id\": 905063,\n \"voip_id\": 1000000,\n \"start_date\": 1586203274,\n \"type\": \"incoming\",\n \"pattern_type\": \"equals\",\n \"pattern\": \"+15551230000\",\n \"notes\": \"\"\n}", "language": "json" } ] } [/block]