公司谢绝来电 (DNC) 列表端点

借助公司 DNC（请勿致电）名单，您可以阻止直接手动拨出的出站电话，以及通过 Apps API 创建的出站电话和预定电话。

Contact Center AI 平台 (CCAI Platform) Apps API 为 DNC 提供以下三个端点：

将手机号码添加到 DNC 列表中

参数 必需 数据类型 定义
contacts TRUE 数组联系人 联系人数组。每个联系人都有一个 `phone_number` 属性和一个可选的 `expires_at` 属性

端点：

Method: POST
Type: RAW
URL: https://{subdomain}.{domain}/apps/api/v1/outbound_dialer/dnc

标头：

键 值 说明
Content-Type application/json

正文：

{
    "contacts": [
        {
            "phone_number": "+1-7187309219",
            "expires_at": "2022-10-29 00:00:00 UTC"
        },
        {
            "phone_number": "+1-(358)-213-1634"
        }
    ]
}

请求和响应示例

以下部分提供了向端点发送的请求示例。

将一些联系人添加到 DNC 列表中

此示例展示了如何将联系人添加到 DNC 列表。

请求

标头：

键 值 说明
Content-Type application/json

正文：

{
    "contacts": [
        {
            "phone_number": "+1-7187309219",
            "expires_at": "2022-10-29 00:00:00 UTC"
        },
        {
            "phone_number": "+1-(358)-213-1634"
        },
        {
            "phone_number": "+1-4151113333",
            "expires_at": "2022-10-30 00:00:00 UTC"
        },
        {
            "phone_number": "+1-4151115555"
        },
        {
            "phone_number": "+1-7187309219",
            "expires_at": "2022-10-27 00:00:00 UTC"
        },
        {
            "phone_number": "sssssss"
        },
        {
            "phone_number": "911",
            "expires_at": "2023-02-05 00:00:00 UTC"
        }
    ]
}
响应
[
    {
        "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

从 DNC 列表中移除号码

参数 必需 数据类型 定义
phone_numbers TRUE 数组字符串 一个数组，包含应从 DNC 列表中移除的手机号码。

端点：

Method: POST
Type: RAW
URL: https://{subdomain}.{domain}/apps/api/v1/outbound_dialer/dnc/remove

标头：

键 值 说明
Content-Type application/json

正文：

{
    "phone_numbers": [
        "1-415-111-1111"
    ]
}

请求和响应示例

以下部分提供了向端点发送的请求示例。

移除手机号码列表

此示例展示了如何从列表中移除手机号码。

请求

标头：

键 值 说明
Content-Type application/json

正文：

{
    "phone_numbers": [
        "1-415-111-1111",
        "1-415-222-2222",
        "1-415-333-333-3333"
    ]
}
响应：成功
{}

状态代码： 200

检查手机号码是否在 DNC 列表中

参数 必需 数据类型 定义
phone_number TRUE 字符串 要检查的手机号码是否在 DNC 列表中

端点：

Method: GET
Type: 
URL: URL: https://{subdomain}.{domain}/apps/api/v1/outbound_dialer/dnc/check?phone_number={phone_number}

标头：

无

正文：

无

请求和响应示例

以下部分提供了向端点发送的请求示例。

检查号码是否在 DNC 列表中

此示例展示了如何检查手机号码是否在 DNC 列表中。

请求
键 值
phone_number {PHONE_NUMBER}（号码）最终用户的手机号码。 
GET https://{subdomain}.{domain}/apps/api/v1/outbound_dialer/dnc/check?phone_number={PHONE_NUMBER}
响应
{
"phone_number": "1-415-111-1111",
"expired_at": "2023-08-05 22:02:36.362009 +0000"
"do_not_call": true
}

Code: 200