Endpoint dell'elenco Non chiamare (DNC) dell'azienda

L'elenco DNC (Do Not Call) dell'azienda consente di bloccare le chiamate dirette e manuali in uscita, nonché le chiamate in uscita e pianificate create dall'API Apps.

L'API Contact Center AI Platform (CCAI Platform) Apps fornisce i seguenti tre endpoint per DNC:

Aggiungere numeri di telefono all'elenco DNC

Parametro Obbligatorio Tipo di dati Definizione
contatti VERO Array contatti Un array di contatti. Ogni contatto ha un attributo `phone_number` e un attributo `expires_at` facoltativo

Endpoint:

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

Intestazioni:

Chiave Valore Descrizione
Content-Type application/json

Corpo:

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

Esempio di richiesta e risposte

Le sezioni seguenti forniscono richieste di esempio all'endpoint.

Aggiungere alcuni contatti all'elenco DNC

Questo esempio mostra l'aggiunta di contatti all'elenco DNC.

Richiesta

Intestazioni:

Chiave Valore Descrizione
Content-Type application/json

Corpo:

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

Rimuovere i numeri dall'elenco DNC

Parametro Obbligatorio Tipo di dati Definizione
phone_numbers VERO Array String Un array contenente i numeri di telefono da rimuovere dall'elenco Non chiamare.

Endpoint:

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

Intestazioni:

Chiave Valore Descrizione
Content-Type application/json

Corpo:

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

Esempio di richiesta e risposte

Le sezioni seguenti forniscono richieste di esempio all'endpoint.

Rimuovere un elenco di numeri di telefono

Questo esempio mostra come rimuovere i numeri di telefono dall'elenco.

Richiesta

Intestazioni:

Chiave Valore Descrizione
Content-Type application/json

Corpo:

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

Codice di stato: 200

Controllare se un numero di telefono è presente nell'elenco DNC

Parametro Obbligatorio Tipo di dati Definizione
phone_number VERO Stringa Il numero di telefono da controllare per verificare se è presente nell'elenco DNC

Endpoint:

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

Intestazioni:

Nessuno

Corpo:

Nessuno

Esempio di richiesta e risposte

Le sezioni seguenti forniscono richieste di esempio all'endpoint.

Controllare se il numero è presente nell'elenco DNC

Questo esempio mostra come verificare se un numero di telefono è presente nell'elenco DNC.

Richiesta
Chiave Valore
phone_number {PHONE_NUMBER} (numero) Il numero di telefono dell'utente finale. 
GET https://{subdomain}.{domain}/apps/api/v1/outbound_dialer/dnc/check?phone_number={PHONE_NUMBER}
Risposta
{
"phone_number": "1-415-111-1111",
"expired_at": "2023-08-05 22:02:36.362009 +0000"
"do_not_call": true
}

Code: 200