נקודות קצה של משתמשי קצה

נקודות הקצה של ה-API של משתמשי הקצה מספקות גישה לאובייקטים של משתמשי הקצה. נוצר אובייקט של משתמש קצה לכל משתמש קצה בפלטפורמת Contact Center AI (פלטפורמת CCAI).

אלה נקודות הקצה של Call API:

עדכון משתמש קצה

נקודת הקצה הזו מאפשרת לעדכן את הפרטים של משתמש קצה, כולל:

  • כתובת אימייל

  • name

  • מספר טלפון

{
    "identifier": "string",
    "email": "string",
    "name": "string",
    "phone": "string"
}

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

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

כותרות:

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

Body:

{
    "identifier": "abc123",
    "email": "joe@mydomain.com",
    "name": "Joe Smith",
    "phone": "+16171231234"
}

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

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

מזהה ומזהה ייחודי של משתמש קצה

בדוגמה הזו מוצג איך לעדכן משתמש קצה באמצעות המזהה.

בקשה

כותרות:

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

Body:

{
    "identifier": "string",
    "email": "string",
    "name": "string",
    "phone": "string"
}
תשובה
{
    "id": "integer",
    "identifier": "string"
}

קוד הסטטוס: 200

קבלת משתמש קצה

נקודת הקצה הזו מאפשרת לאחזר משתמש קצה באמצעות id או identifier.

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

Method: GET
Type:
URL: https://{subdomain}.{domain}/apps/api/v1/end_users

כותרות:

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

שאילתה:

מפתח ערך תיאור
id מספר שלם מזהה פנימי של משתמש הקצה
מזהה מחרוזת מזהה חיצוני של משתמש הקצה

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

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

קבלת נתונים לפי מזהה

בדוגמה הזו מוצג איך לאחזר משתמש קצה באמצעות המזהה שלו.

בקשה

כותרות:

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

שאילתה:

מפתח ערך תיאור
id מספר שלם מזהה פנימי של משתמש הקצה
תשובה
{
    "id": "integer",
    "identifier": "string"
}

קוד הסטטוס: 200

קבלת נתונים לפי מזהה

בדוגמה הזו מוצג איך לאחזר משתמש קצה באמצעות מזהה.

בקשה

כותרות:

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

שאילתה:

מפתח ערך תיאור
מזהה מחרוזת מזהה חיצוני של משתמש הקצה
תשובה
{
    "id": "integer",
    "identifier": "string"
}

קוד הסטטוס: 200