Endpunkte für die Liste der Unternehmen, die nicht angerufen werden möchten (Do Not Call, DNC)

Mit der DNC-Liste (Do Not Call) des Unternehmens können Sie direkte, manuelle ausgehende Anrufe sowie ausgehende und geplante Anrufe blockieren, die über die Apps API erstellt wurden.

Die CCAI Platform Apps API bietet die folgenden drei Endpunkte für DNC:

Telefonnummern der DNC-Liste hinzufügen

Parameter Erforderlich Datentyp Definition
Kontakte TRUE Kontakte in einem Array Ein Array von Kontakten. Jeder Kontakt hat ein Attribut „phone_number“ und optional ein Attribut „expires_at“.

Endpunkt

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

Header:

Schlüssel Wert Beschreibung
Content-Type application/json

Text:

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

Beispielanfrage und ‑antworten

In den folgenden Abschnitten finden Sie Beispielanfragen an den Endpunkt.

Einige Kontakte zur DNC-Liste hinzufügen

In diesem Beispiel wird gezeigt, wie Kontakte der DNC-Liste hinzugefügt werden.

Anfrage

Header:

Schlüssel Wert Beschreibung
Content-Type application/json

Text:

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

Nummern aus der DNC-Liste entfernen

Parameter Erforderlich Datentyp Definition
phone_numbers TRUE Array-String Ein Array mit Telefonnummern, die aus der DNC-Liste entfernt werden sollen.

Endpunkt

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

Header:

Schlüssel Wert Beschreibung
Content-Type application/json

Text:

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

Beispielanfrage und ‑antworten

In den folgenden Abschnitten finden Sie Beispielanfragen an den Endpunkt.

Liste von Telefonnummern entfernen

In diesem Beispiel wird gezeigt, wie Sie Telefonnummern aus der Liste entfernen.

Anfrage

Header:

Schlüssel Wert Beschreibung
Content-Type application/json

Text:

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

Statuscode:200

Prüfen, ob eine Telefonnummer auf der DNC-Liste steht

Parameter Erforderlich Datentyp Definition
phone_number TRUE String Die Telefonnummer, die geprüft werden soll, um festzustellen, ob sie in der DNC-Liste enthalten ist

Endpunkt

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

Header:

Keine

Text:

Keine

Beispielanfrage und ‑antworten

In den folgenden Abschnitten finden Sie Beispielanfragen an den Endpunkt.

Prüfen, ob die Nummer auf der DNC-Liste steht

In diesem Beispiel wird gezeigt, wie Sie prüfen, ob eine Telefonnummer in der DNC-Liste enthalten ist.

Anfrage
Schlüssel Wert
phone_number {PHONE_NUMBER} (Nummer): Die Telefonnummer des Endnutzers. 
GET https://{subdomain}.{domain}/apps/api/v1/outbound_dialer/dnc/check?phone_number={PHONE_NUMBER}
Antwort
{
"phone_number": "1-415-111-1111",
"expired_at": "2023-08-05 22:02:36.362009 +0000"
"do_not_call": true
}

Code: 200