Points de terminaison de la liste "Ne pas appeler" de l'entreprise

La liste d'exclusion d'appels de l'entreprise vous permet de bloquer les appels directs, manuels et sortants, ainsi que les appels sortants et planifiés créés par l'API Apps.

L'API CCAI Platform Apps fournit les trois points de terminaison suivants pour la liste "Ne pas déranger" :

Ajouter des numéros de téléphone à la liste "Ne pas appeler"

Paramètre Obligatoire Type de données Définition
contacts TRUE Tableau des contacts Tableau de contacts. Chaque contact possède un attribut `phone_number` et un attribut `expires_at` facultatif.

Point de terminaison :

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

En-têtes

Clé Valeur Description
Content-Type application/json

Corps :

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

Exemple de requête et de réponses

Les sections suivantes fournissent des exemples de requêtes au point de terminaison.

Ajouter des contacts à la liste "Ne pas déranger"

Cet exemple montre comment ajouter des contacts à la liste "Ne pas appeler".

Requête

En-têtes

Clé Valeur Description
Content-Type application/json

Corps :

{
    "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"
        }
    ]
}
Réponse
[
    {
        "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

Supprimer des numéros de la liste "Ne pas appeler"

Paramètre Obligatoire Type de données Définition
phone_numbers TRUE Chaîne de tableau Tableau contenant les numéros de téléphone à supprimer de la liste "Ne pas appeler".

Point de terminaison :

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

En-têtes

Clé Valeur Description
Content-Type application/json

Corps :

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

Exemple de requête et de réponses

Les sections suivantes fournissent des exemples de requêtes au point de terminaison.

Supprimer une liste de numéros de téléphone

Cet exemple montre comment supprimer des numéros de téléphone de la liste.

Requête

En-têtes

Clé Valeur Description
Content-Type application/json

Corps :

{
    "phone_numbers": [
        "1-415-111-1111",
        "1-415-222-2222",
        "1-415-333-333-3333"
    ]
}
Réponse : réussite
{}

Code d'état : 200

Vérifier si un numéro de téléphone figure sur la liste DNC

Paramètre Obligatoire Type de données Définition
phone_number TRUE Chaîne Numéro de téléphone à vérifier pour savoir s'il figure sur la liste "Ne pas appeler"

Point de terminaison :

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

En-têtes

Aucun

Corps :

Aucun

Exemple de requête et de réponses

Les sections suivantes fournissent des exemples de requêtes au point de terminaison.

Vérifier si un numéro figure sur la liste "Ne pas appeler"

Cet exemple montre comment vérifier si un numéro de téléphone figure sur la liste DNC.

Requête
Clé Valeur
phone_number {PHONE_NUMBER} (nombre) : numéro de téléphone de l'utilisateur final. 
GET https://{subdomain}.{domain}/apps/api/v1/outbound_dialer/dnc/check?phone_number={PHONE_NUMBER}
Réponse
{
"phone_number": "1-415-111-1111",
"expired_at": "2023-08-05 22:02:36.362009 +0000"
"do_not_call": true
}

Code: 200