‫Google משתמשת בטכנולוגיית AI כדי לתרגם תוכן לשפה המועדפת עליך. בתרגומים כאלו עשויות להיות שגיאות.

אימות באמצע הסשן באמצעות API

בדף הזה מוסבר איך להשתמש בנקודות קצה ל-API של שיחות וצ'אטים לצורך אימות באמצע הסשן בערוצי ה-SDK.

המשתמשים יכולים להתחיל סשן תמיכה, כמו צ'אט תמיכה, בלי לאמת את הזהות שלהם. כשצריך לאמת את משתמש הקצה, אפשר להתחיל תהליך אימות. אחרי אימות מוצלח, אתם יכולים לעדכן את המזהה end_user כדי לקשר את הסשן למשתמש הקצה המאומת.

URI ואימות

מזהה ה-URI הבסיסי של נקודת הקצה החדשה הזו משתנה בהתאם לcomm_type.

ל-comm_type call:

פרסום https://<subdomain>.<domain>/apps/api/v1/calls/:call_id/end_user

ל-chat comm_type:

פרסום https://<subdomain>.<domain>/apps/api/v1/chats/:chat_id/end_user

פעולות API

בקטעים הבאים מפורטים פרטים על פעולות ה-API.

פרמטרים

גוף הבקשה ל-API צריך לכלול את השדות הבאים:

מזהה	שם השדה	סוג	חובה?	תיאור	ערכים לדוגמה
0	`identifier`	String	כן	מזהה חיצוני ייחודי שסופק.
1	`name`	String	לא	השם הגנרי או המזהה שמשויך לאינטראקציה. עוזר לחפש לקוחות.	`John Doe`
2	`email`	String	לא	כתובת האימייל הכללית שמשויכת לאינטראקציה. עוזר לחפש לקוחות.	`john@doe.com`
3	`phone`	String	לא	מספר הטלפון הכללי שקשור לאינטראקציה. עוזר לחפש לקוחות.	`123-456-7890`

דוגמאות ל-API

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

דוגמה לתגובה על הצלחה

202 Accepted

{
 "message": "accepted"
}

דוגמאות לתגובות במקרה של כישלון

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

תגובות שגיאה

‫400 בקשה שגויה – בבקשה חסר שדה המזהה הנדרש.

{
  "message": "param is missing or the value is empty: identifier"
}

‫401 אין הרשאה – האימות נכשל.

{
  "message": "Not Found"
}

שגיאת 404 – לא קיימת שיחה או צ'אט עם המזהה שצוין.

הסשן לא פעיל

400 {"message": "Call is already ended"}
400 {"message": "Chat is already ended"}

בקשה לא נתמכת במערכת לניהול קשרי לקוחות (CRM)

‫400 Bad Request – הגדרת ה-CRM של המכונה לא תומכת בנתיב העדכון הזה.

{
  "message": "Unsupported CRM request"
}

בקשה כפולה

400 {"message": "Duplicate request: Please wait for the interval to expire"}

דוגמה לבקשת API

בקטע הבא יש דוגמאות לבקשות API לסוגי התקשורת "שיחה" ו"צ'אט".

סוג תקשורת של שיחה

POST https://<subdomain>.<domain>/apps/api/v1/calls/:call_id/end_user
Content-Type: application/json
-u apiuser:APIUSER_TOKEN

{
    "identifier": "unique_external_id",
    "name": "John Doe",
    "email": "johndoe@example.com",
    "phone": "123-456-7890"
}

סוג התקשורת בצ'אט

POST https://<subdomain>.<domain>/apps/api/v1/chats/:chat_id/end_user
Content-Type: application/json
-u apiuser:APIUSER_TOKEN

{
    "identifier": "unique_external_id",
    "name": "Jane Smith",
    "email": "janesmith@example.com",
    "phone": "098-765-4321"
}

מאמרי העזרה של ה-API של Apps

לנקודות קצה נוספות של Apps API, ראו פרסום של Apps API.

אימות באמצע הסשן באמצעות API קל לארגן דפים בעזרת אוספים אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.