נקודות קצה של רשימת 'אל תתקשרו' (DNC) של החברה

רשימת ה-DNC (אל תתקשרו) של החברה מאפשרת לחסום שיחות יוצאות ישירות וידניות, וגם שיחות יוצאות ושיחות מתוזמנות שנוצרו על ידי Apps API.

ממשק ה-API של אפליקציות Contact Center AI Platform ‏ (CCAI Platform) מספק את שלוש נקודות הקצה הבאות ל-DNC:

הוספת מספרי טלפון לרשימת DNC

פרמטר חובה סוג הנתונים הגדרה
אנשי קשר TRUE Array contacts מערך של אנשי קשר. לכל איש קשר יש מאפיין phone_number ומאפיין אופציונלי expires_at

נקודת קצה (endpoint):

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

כותרות:

מפתח ערך תיאור
סוג התוכן application/json

Body:

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

דוגמה לבקשה ולתשובות

בקטעים הבאים מופיעות דוגמאות לבקשות לנקודת הקצה.

הוספת אנשי קשר לרשימת DNC

בדוגמה הזו אפשר לראות איך מוסיפים אנשי קשר לרשימת ה-DNC.

בקשה

כותרות:

מפתח ערך תיאור
סוג התוכן application/json

Body:

{
    "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

הסרת מספרים מרשימת ה-DNC

פרמטר חובה סוג הנתונים הגדרה
phone_numbers TRUE Array String מערך שמכיל מספרי טלפון שצריך להסיר מרשימת ה-DNC.

נקודת קצה (endpoint):

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

כותרות:

מפתח ערך תיאור
סוג התוכן application/json

Body:

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

דוגמה לבקשה ולתשובות

בקטעים הבאים מופיעות דוגמאות לבקשות לנקודת הקצה.

הסרת רשימה של מספרי טלפון

בדוגמה הזו מוסבר איך להסיר מספרי טלפון מהרשימה.

בקשה

כותרות:

מפתח ערך תיאור
סוג התוכן application/json

Body:

{
    "phone_numbers": [
        "1-415-111-1111",
        "1-415-222-2222",
        "1-415-333-333-3333"
    ]
}
תשובה: הצלחה
{}

קוד הסטטוס: 200

איך בודקים אם מספר טלפון מופיע ברשימת ה-DNC

פרמטר חובה סוג הנתונים הגדרה
phone_number TRUE String מספר הטלפון שרוצים לבדוק אם הוא מופיע ברשימת ה-DNC

נקודת קצה (endpoint):

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

כותרות:

ללא

Body:

ללא

דוגמה לבקשה ולתשובות

בקטעים הבאים מופיעות דוגמאות לבקשות לנקודת הקצה.

בדיקה אם המספר מופיע ברשימת ה-DNC

בדוגמה הזו מוסבר איך לבדוק אם מספר טלפון נמצא ברשימת ה-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