[{"phone_number":"+1-7187309219","expires_at":"2022-10-29 00:00:00 UTC","status":"created"},{"phone_number":"+1-(358)-213-1634","status":"created"},{"phone_number":"+1-4151113333","expires_at":"2022-10-30 00:00:00 UTC","status":"updated"},{"phone_number":"+1-4151115555","status":"updated"},{"phone_number":"+1-7187309219","expires_at":"2022-10-27 00:00:00 UTC","error":"expires_at cannot be past date/time","status":"failed"},{"phone_number":"sssssss","error":"phone_number is invalid","status":"failed"},{"phone_number":"911","expires_at":"2023-02-05 00:00:00 UTC","error":"emergency phone number is not allowed","status":"failed"}]
Code: 200
Remove numbers from the DNC list
Parameter
Required
Data Type
Definition
phone_numbers
TRUE
Array String
An array containing phone numbers that should be removed from the DNC list.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-25 UTC."],[[["\u003cp\u003eThe DNC (Do Not Call) list allows blocking of direct, manual outbound calls as well as scheduled and outbound calls via the Apps API.\u003c/p\u003e\n"],["\u003cp\u003eThe CCAI Platform Apps API provides endpoints to add phone numbers to the DNC list, which requires an array of contacts with \u003ccode\u003ephone_number\u003c/code\u003e and optional \u003ccode\u003eexpires_at\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003ePhone numbers can be removed from the DNC list using the \u003ccode\u003e/dnc/remove\u003c/code\u003e endpoint, providing an array of phone numbers to be removed.\u003c/p\u003e\n"],["\u003cp\u003eYou can check if a specific phone number is currently on the DNC list using the \u003ccode\u003e/dnc/check\u003c/code\u003e endpoint, which returns whether a number is on the list.\u003c/p\u003e\n"],["\u003cp\u003eWhen adding contacts, if a contact is added with an invalid number, an emergency number, or an expiration date in the past, the request will fail and return an appropriate error.\u003c/p\u003e\n"]]],[],null,["# Company do not call (DNC) list endpoints\n\nThe company DNC (do not call) list lets you block direct, manual outbound\ncalls as well as outbound and scheduled calls created by the Apps API.\n\nContact Center AI Platform (CCAI Platform) Apps API provides the following three endpoints for DNC:\n\n- [Add phone numbers to DNC list](#add-phone-number).\n\n- [Remove phone numbers from DNC list](#remove-phone-number).\n\n- [Check whether a phone number is in the DNC list](#check-phone-number).\n\nAdd phone numbers to the DNC list\n---------------------------------\n\n***Endpoint:*** \n\n Method: POST\n Type: RAW\n URL: https://{subdomain}.{domain}/apps/api/v1/outbound_dialer/dnc\n\n***Headers:***\n\n***Body:*** \n\n {\n \"contacts\": [\n {\n \"phone_number\": \"+1-7187309219\",\n \"expires_at\": \"2022-10-29 00:00:00 UTC\"\n },\n {\n \"phone_number\": \"+1-(358)-213-1634\"\n }\n ]\n }\n\n### Example request and responses\n\nThe following sections provide example requests to the endpoint.\n\n#### Add some contacts to the DNC list\n\nThis example shows the adding of contacts to the DNC list.\n\n##### Request\n\n***Headers:***\n\n***Body:*** \n\n {\n \"contacts\": [\n {\n \"phone_number\": \"+1-7187309219\",\n \"expires_at\": \"2022-10-29 00:00:00 UTC\"\n },\n {\n \"phone_number\": \"+1-(358)-213-1634\"\n },\n {\n \"phone_number\": \"+1-4151113333\",\n \"expires_at\": \"2022-10-30 00:00:00 UTC\"\n },\n {\n \"phone_number\": \"+1-4151115555\"\n },\n {\n \"phone_number\": \"+1-7187309219\",\n \"expires_at\": \"2022-10-27 00:00:00 UTC\"\n },\n {\n \"phone_number\": \"sssssss\"\n },\n {\n \"phone_number\": \"911\",\n \"expires_at\": \"2023-02-05 00:00:00 UTC\"\n }\n ]\n }\n\n##### Response\n\n [\n {\n \"phone_number\": \"+1-7187309219\",\n \"expires_at\": \"2022-10-29 00:00:00 UTC\",\n \"status\": \"created\"\n },\n {\n \"phone_number\": \"+1-(358)-213-1634\",\n \"status\": \"created\"\n },\n {\n \"phone_number\": \"+1-4151113333\",\n \"expires_at\": \"2022-10-30 00:00:00 UTC\",\n \"status\": \"updated\"\n },\n {\n \"phone_number\": \"+1-4151115555\",\n \"status\": \"updated\"\n },\n {\n \"phone_number\": \"+1-7187309219\",\n \"expires_at\": \"2022-10-27 00:00:00 UTC\",\n \"error\": \"expires_at cannot be past date/time\",\n \"status\": \"failed\"\n },\n {\n \"phone_number\": \"sssssss\",\n \"error\": \"phone_number is invalid\",\n \"status\": \"failed\"\n },\n {\n \"phone_number\": \"911\",\n \"expires_at\": \"2023-02-05 00:00:00 UTC\",\n \"error\": \"emergency phone number is not allowed\",\n \"status\": \"failed\"\n }\n ]\n\n`Code: 200`\n\nRemove numbers from the DNC list\n--------------------------------\n\n***Endpoint:*** \n\n Method: POST\n Type: RAW\n URL: https://{subdomain}.{domain}/apps/api/v1/outbound_dialer/dnc/remove\n\n***Headers:***\n\n***Body:*** \n\n {\n \"phone_numbers\": [\n \"1-415-111-1111\"\n ]\n }\n\n### Example request and responses\n\nThe following sections provide example requests to the endpoint.\n\n#### Remove a list of phone numbers\n\nThis example shows how to remove phone numbers from the list.\n\n##### Request\n\n***Headers:***\n\n***Body:*** \n\n {\n \"phone_numbers\": [\n \"1-415-111-1111\",\n \"1-415-222-2222\",\n \"1-415-333-333-3333\"\n ]\n }\n\n##### Response: Success\n\n {}\n\n***Status Code:*** 200\n\nCheck whether a phone number is on the DNC list\n-----------------------------------------------\n\n***Endpoint:*** \n\n Method: GET\n Type: \n URL: URL: https://{subdomain}.{domain}/apps/api/v1/outbound_dialer/dnc/check?phone_number={phone_number}\n\n***Headers:***\n\nNone\n\n***Body:***\n\nNone\n\n### Example request and responses\n\nThe following sections provide example requests to the endpoint.\n\n#### Check if number is in the DNC list\n\nThis example showes how to check if a phone number is in the DNC list.\n\n##### Request\n\n GET https://{subdomain}.{domain}/apps/api/v1/outbound_dialer/dnc/check?phone_number={PHONE_NUMBER}\n\n##### Response\n\n {\n \"phone_number\": \"1-415-111-1111\",\n \"expired_at\": \"2023-08-05 22:02:36.362009 +0000\"\n \"do_not_call\": true\n }\n\n`Code: 200`"]]