Tickets
תיבה משותפת, טפסים ואוטומציות לפניות לקוחות.
ה-API של הפניות מאפשר לתוכנה מחוץ ל-Xuda לעבוד עם מוקד: לפתוח פנייה, לרשום ולקרוא פניות, לענות, להעביר, להזיז פנייה בין שלבים ולסגור אותה, ולקרוא את הנושאים ואת הצוות. טפסים, תהליכי עבודה, סוכני AI, פתקים פנימיים וההגדרות נשארים בלוח הבקרה.
כל קריאה היא POST אל https://xuda.ai/cpi/<method> עם גוף JSON שנושא את מפתח ה-API של החשבון שלכם כ-api_key. קריאה פועלת על המוקד של החשבון שבבעלותו המפתח, תחת התוכנית של המוקד הזה, ולא יכולה לציין מוקד אחר. יוצרים את המפתח בלוח הבקרה תחת מפתחים, ושומרים אותו מחוץ לדפים ולקוד ציבורי.
התשובה היא { "code": ..., "data": ... }. code חיובי הוא הצלחה. דחייה היא קוד שלילי עם משפט ב-data.
name ו-details הם חובה. איש קשר נוצר או נעשה בו שימוש חוזר לפי email, הפנייה נפתחת עם המקור api, והתשובה היא תצוגה מצומצמת: מספר, מזהה, סטטוס, שלב, נושא הפנייה, תחום, מגיש הבקשה, המזהה של האחראי והחותמות הזמן. מזהים פנימיים ומצב האוטומציה לעולם לא מוחזרים.
email אופציונלי כשאינטגרציה או סוכן פותחים את הפנייה לעצמם: שולחים name בלבד, ולא נוצר איש קשר ושום דבר לא נשלח במייל למגיש הבקשה.
שדות אופציונליים נותנים לפנייה subject, phone, company, topic_id ו-subtopic_id מנושאי המוקד, reference_id משלכם, priority מ-1 (הגבוהה ביותר) עד 4, type (issue, bug, feature או task) ו-attachments.
כדי להעביר את הפנייה החדשה למישהו, מציינים אותו עם assignee_uid או assignee_email, אחד משניהם. הוא חייב להיות בצוות סביבת העבודה של המוקד, שהוא הבעלים שלה והחברים שהתקבלו בסביבת העבודה. אחראי שנדחה לא פותח שום פנייה.
למצוא ולקרוא פניות
ticket_api_list מפרטת פניות עם המסננים שיש בלוח הבקרה: status (open או closed), source, topic_id, type, assignee_uid, reference_id, search של טקסט חופשי על נושא הפנייה, הפרטים ומספר הפנייה, וטווח created_from ו-created_to. ממיינים עם sort (date_created_ts, last_activity_ts, status_ts או priority) ו-dir, ועוברים בין דפים עם limit (עד 500) וה-bookmark מהתשובה הקודמת.
ticket_api_get קוראת פנייה אחת לפי ticket_id, עם האינטראקציות הציבוריות שלה. פתקים פנימיים וטיוטות של AI לעולם לא מוחזרים.
ticket_api_topics מחזירה את הנושאים ותת הנושאים של המוקד, כך שהטופס שלכם יכול להציג את אותו בורר שהטופס המאוחסן מציג. ticket_api_team מחזירה את האנשים שאפשר להעביר אליהם פנייה, כל אחד עם uid, שם ואימייל.
ticket_api_replyתמיד מפרסמת תשובה ציבורית, אף פעם לא פתק פנימי. זה המוקד שעונה, אלא אם מעביריםas_requester: true, שמפרסם אותה כהודעה של מגיש הבקשה עצמו. במקרה כזה האחראי, או הבעלים של המוקד, מקבל התראה, וזה לא נספר כתגובה הראשונה של המוקד.ticket_api_set_stageמעבירה פנייה פתוחה ל-new,in_progress,waiting_customerאוresolved. פנייה סגורה נדחית אלא אם מעביריםreopen: true, שפותח אותה שוב בשלב הזה. ציון השלב שכבר יש לפנייה לא משנה דבר.ticket_api_assignנותנת פנייה לאדם בצוות לפיassignee_uidאוassignee_email. ציון האחראי הנוכחי לא משנה דבר. אם ליותר מחבר צוות אחד יש את האימייל הזה, הקריאה נדחית עם-409ומעבירים את ה-uid במקום.ticket_api_closeסוגרת את הפנייה. ה-reasonהאופציונלי מוצג ללקוח. תשובה של לקוח בתוך חלון הפתיחה מחדש מחזירה את הפנייה.
לקרוא את הרשימה של המוקד עצמו
get_support_tickets קוראת פניות חזרה לחשבון המחובר שבבעלותו המוקד, ואפשר להגביל אותה לפנייה אחת עם _id. זו צורה שונה מהתצוגה של ticket_api_*, שנבנתה לקורא מחוץ ל-Xuda.
תוכניות ומגבלות
התוכנית קובעת מה מפתח רשאי לעשות. קריאה (ticket_api_list, ticket_api_get, ticket_api_topics, ticket_api_team) דורשת גישת קריאה, וכתיבה (ticket_api_submit, ticket_api_reply, ticket_api_set_stage, ticket_api_assign, ticket_api_close) דורשת גישה מלאה. תוכנית בלעדיה עונה -402. לכל תוכנית יש גם מספר קריאות לדקה, ומעבר לו קריאה נענית ב--429 עד הדקה הבאה. ההיסטוריה עוקבת אחר חלון השמירה של התוכנית, ולכן אי אפשר לקרוא פנייה ישנה ממנו. בדף התוכניות יש את הנתונים.
פנייה חדשה נספרת במכסה של החודש, כמו מכל דרך פנייה אחרת.