Endpoint daftar jangan hubungi (DNC) perusahaan

Daftar DNC (jangan hubungi) perusahaan memungkinkan Anda memblokir panggilan keluar manual langsung serta panggilan keluar dan terjadwal yang dibuat oleh Apps API.

Contact Center AI Platform (CCAI Platform) Apps API menyediakan tiga endpoint berikut untuk DNC:

Menambahkan nomor telepon ke daftar DNC

Parameter Wajib Jenis Data Definisi
kontak TRUE Kontak array Array kontak. Setiap kontak memiliki atribut `phone_number` dan atribut `expires_at` opsional

Endpoint:

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

Header:

Kunci Nilai Deskripsi
Content-Type application/json

Isi:

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

Contoh permintaan dan respons

Bagian berikut memberikan contoh permintaan ke endpoint.

Menambahkan beberapa kontak ke daftar DNC

Contoh ini menunjukkan penambahan kontak ke daftar DNC.

Permintaan

Header:

Kunci Nilai Deskripsi
Content-Type application/json

Isi:

{
    "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"
        }
    ]
}
Respons
[
    {
        "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

Menghapus nomor dari daftar DNC

Parameter Wajib Jenis Data Definisi
phone_numbers TRUE String Array Array yang berisi nomor telepon yang harus dihapus dari daftar DNC.

Endpoint:

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

Header:

Kunci Nilai Deskripsi
Content-Type application/json

Isi:

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

Contoh permintaan dan respons

Bagian berikut memberikan contoh permintaan ke endpoint.

Menghapus daftar nomor telepon

Contoh ini menunjukkan cara menghapus nomor telepon dari daftar.

Permintaan

Header:

Kunci Nilai Deskripsi
Content-Type application/json

Isi:

{
    "phone_numbers": [
        "1-415-111-1111",
        "1-415-222-2222",
        "1-415-333-333-3333"
    ]
}
Respons: Berhasil
{}

Kode Status: 200

Memeriksa apakah nomor telepon ada dalam daftar DNC

Parameter Wajib Jenis Data Definisi
phone_number TRUE String Nomor telepon yang akan diperiksa apakah ada dalam daftar DNC

Endpoint:

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

Header:

Tidak ada

Isi:

Tidak ada

Contoh permintaan dan respons

Bagian berikut memberikan contoh permintaan ke endpoint.

Memeriksa apakah nomor ada dalam daftar DNC

Contoh ini menunjukkan cara memeriksa apakah nomor telepon ada dalam daftar DNC.

Permintaan
Kunci Nilai
phone_number {PHONE_NUMBER} (Nomor) Nomor telepon pengguna akhir. 
GET https://{subdomain}.{domain}/apps/api/v1/outbound_dialer/dnc/check?phone_number={PHONE_NUMBER}
Respons
{
"phone_number": "1-415-111-1111",
"expired_at": "2023-08-05 22:02:36.362009 +0000"
"do_not_call": true
}

Code: 200