회사 전화 연락 금지 (DNC) 목록 엔드포인트

회사 DNC (수신 거부) 목록을 사용하면 직접 수동 발신 전화는 물론 Apps API로 생성된 발신 전화 및 예약 전화를 차단할 수 있습니다.

Contact Center AI Platform (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

수신 거부 목록에서 번호 삭제

매개변수 필수 데이터 유형 정의
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 목록에 있는지 확인

이 예시에서는 전화번호가 수신 거부 목록에 있는지 확인하는 방법을 보여줍니다.

요청
키 값
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