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

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

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

URI ואימות

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

ל-call comm_type:

POST https://<subdomain>.<domain>//apps/api/v1/calls/:call_id/end_user

ל-chat comm_type:

POST https://<subdomain>.<domain>//apps/api/v1/chats/:chat_id/end_user

פעולות 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: comm_type"}
400 {"message": "param is missing or the value is empty: identifier"}
הפניה לסוג תקשורת שאינו שיחה או צ'אט
404 {"message": "Not Found"}
הסשן לא פעיל
400 {"message": "Call is already ended"}
400 {"message": "Chat is already ended"}
בקשה לא נתמכת במערכת לניהול קשרי לקוחות (CRM)
400 {"message": "Unsupported CRM request"}
בקשה כפולה
400 {"message": "Duplicate request: Please wait for the interval to expire"}

דוגמה לבקשת API

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

POST https://<subdomain>.<domain>/apps/api/v1/calls/:call_id/end_user
Content-Type: application/json
Authorization: Bearer <your_access_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
Authorization: Bearer <your_access_token>

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

תיעוד Apps API

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