会社の電話拒否（DNC）リストのエンドポイント

会社の DNC（電話禁止）リストを使用すると、Apps API で作成された手動の直接発信通話、発信通話、スケジュール設定された通話をブロックできます。

コンタクト センター AI プラットフォーム（CCAI プラットフォーム）Apps API は、DNC 用に次の 3 つのエンドポイントを提供します。

DNC リストに電話番号を追加する

パラメータ 必須 データ型 定義
連絡先 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