הערה
הגישה לדף זה מחייבת הרשאה. באפשרותך לנסות להיכנס או לשנות מדריכי כתובות.
הגישה לדף זה מחייבת הרשאה. באפשרותך לנסות לשנות מדריכי כתובות.
Microsoft CIFramework מספק שיטות לשימוש ב- API של JavaScript לניהול לוח התקשורת (רכיב גרפי), הודעה, כרטיסיית יישום, הפעלות, רשומות וטפסים ביישום מונחה-הדגמים של Dynamics 365.
חשוב
- ממשקי ה- API נתמכים רק מספקי הערוצים הפעילים שהוגדרו בארגון שלך.
- יש להפעיל את המטפל באירועים CIFInitDone לפני קריאה לממשקי ה- API האחרים.
- מגבלת הזמן הקצוב לממשקי ה- API היא 100 שניות. אם ממשקי ה-API לא פועלים תוך 100 שניות, יש להפעיל אותם שוב עם פרמטרים או היקף שהשתנו.
ממשקי API לניהול לוחות תקשורת
לוח התקשורת הוא המקום שבו אתה כסוכן מקיים אינטראקציה עם הלקוח. ווידג'טים של שותפים שנבנו באמצעות Channel Integration Framework 2.0 נטענים בחלונית זו. הרכיב הגרפי בגרסה זו מוצג משמאל לחלונית ההפעלה ותומך במצבים Docked, Minimized ו-Hidden .
השתמש בממשקי ה- API הבאים כדי לנהל את מצב לוח התקשורת (רכיב גרפי).
| שיטות | תיאור |
|---|---|
| setWidth | מגדיר את רוחב החלונית לכל ההפעלות. |
| getWidth | מקבל את רוחב החלונית בפיקסלים. |
| setMode | קובע את מצב החלונית. |
| getMode | קובע את מצב החלונית. |
ממשקי API של פעולות CRUD
השתמש בממשקי ה- API הבאים כדי לבצע פעולות CRUD ברשומות ישות.
| שיטות | תיאור |
|---|---|
| createRecord | יוצר רשומת ישות. |
| retrieveRecord | מאחזר רשומת ישות. |
| updateRecord | מעדכן רשומת ישות. |
| deleteRecord | מחיקת רשומת ישות. |
ממשקי API לניהול הודעות
השתמש בממשקי ה- API הבאים כדי להציג או לבטל התראות על שיחות נכנסות.
| שיטות | תיאור |
|---|---|
| notifyEvent | מציג הודעה שניתן להשתמש בה כדי ליידע את הסוכן על שיחה נכנסת. |
| cancelEvent | הסתרה או ביטול של הודעה על סמך אסימון הביטול, כפי שצוין בשיטה notifyEvent . |
ממשקי API לניהול כרטיסיות יישומים
השתמש בממשקי ה- API הבאים כדי ליצור ולנהל את המצב של כרטיסיית יישום.
| שיטות | תיאור |
|---|---|
| createTab | יוצר כרטיסיה בהפעלה ממוקדת ומחזיר את המזהה הייחודי של הכרטיסיה שנוצרה. |
| getTabs | החזרת מערך של מזהי כרטיסיות המשויכים לשם תבנית או לתגי תבנית עבור כרטיסיות בהפעלה במוקד, אם ההפעלה שייכת לספק הערוץ. |
| כרטיסיית מיקוד | מגדיר את המוקד בכרטיסיה, אם ההפעלה הממוקדת שייכת לספק הערוץ ואם הכרטיסיה שייכת להפעלה שבמוקד. |
| getFocusedTab | החזרת מזהה הכרטיסיה בהפעלה ממוקדת, אם ההפעלה שייכת לספק. |
| refreshTab | מרענן את הכרטיסייה. |
| setTabTitle | מגדיר את כותרת הכרטיסיה, אם ההפעלה הממוקדת שייכת לספק הערוץ ואם הכרטיסיה שייכת להפעלה שבמוקד. |
| כרטיסייה סגורה | סגירת הכרטיסיה שצוינה בהפעלה הנוכחית. |
ממשקי API של ניהול הפעלות
השתמש בממשקי ה- API הבאים כדי לנהל הפעלות בסביבת ספק מרובה הפעלות.
| שיטות | תיאור |
|---|---|
| canCreateSession | מאפשר לך לבדוק אם ניתן ליצור הפעלה חדשה. |
| createSession | יוצר הפעלה המבוססת על תבנית ההפעלה המוגדרת כחלק מהתבנית ומחזיר את המזהה הייחודי של ההפעלה שנוצרה. |
| getSession | החזרת אובייקט המכיל את המזהה הייחודי של ההפעלה, ההקשר וערך הפרמטר isFocused , אם ההפעלה שייכת לספק הערוץ. |
| getFocusedSession | החזרת המזהה הייחודי של ההפעלה שנמצאת במוקד, אם הוא שייך לספק הערוץ, אחרת מחזירה null. |
| getAllSessions | החזרת מערך מזהי ההפעלה עבור ספק ערוצים. |
| setSessionTitle | מגדיר את כותרת ההפעלה, אם ההפעלה שייכת לספק הערוץ. |
| requestFocusSession | מגדיר את המוקד בהפעלה שמזהה ההפעלה שלה מועבר כפרמטר, אם ההפעלה שייכת לספק הערוץ. |
ממשקי API של ניתוח ערוצים
השתמש בממשקי ה- API הבאים כדי לעקוב אחר ניתוח אירועים.
| שיטות | תיאור |
|---|---|
| logAnalyticsאירוע | הפעל שיטה זו כדי לרשום ניתוח עבור אירועים מותאמים אישית. |
ממשקי API של מחוון הפעלה
השתמש בממשקי ה- API הבאים כדי לציין הפרה של מחוון ביצועי מפתח (KPI) וכדי לעדכן את מספר הפעילויות החדשות בהפעלה מסוימת.
| שיטות | תיאור |
|---|---|
| הודעהKpiBreach | שיטה זו משמשת לציון הפרת KPI. כאשר נעשה שימוש בשיטה זו, מופיע עיגול אדום בתמונת התצוגה של איש הקשר כאשר התרחשה הפרת KPI. |
| הודעהפעילות חדשה | שיטה זו משמשת לעדכון מספר הפעילויות החדשות בהפעלה מסוימת. |
ממשקי API של נוכחות
השתמש בממשקי API אלה כדי להגדיר ולאחזר את נוכחות הסוכן בריבוי ערוצים באופן תוכניתי. באפשרותך להשתמש בשיטות אלה כאשר סוכן ממוזג עובד על יישום שאינו של Microsoft עם ריבוי ערוצים, וברצונך לסנכרן את מצבי הנוכחות בין יישומים שונים כדי להבטיח שקיבולת הסוכן מנוצלת בצורה מיטבית.
| שיטות | תיאור |
|---|---|
| setPresence | מאפשר להגדיר נוכחות באופן תיכנותי עבור הסוכן בהפעלת הלקוח. |
| getPresence | מאפשר להחזיר נוכחות באופן תוכניתי עבור הסוכן בהפעלת הלקוח. |
שיטות שונות
| שיטות | תיאור |
|---|---|
| getEntityMetadata | החזרת המטה-נתונים של הישות עבור הישות שצוינה. |
| setClickToAct | מגדיר ערך בוליאני כדי להפוך את התקשורת היוצאת לזמינה או ללא זמינה (ClickToAct). |
| getClickToAct | החזרת ערך בוליאני כדי לציין אם התקשורת היוצאת (ClickToAct) זמינה או לא. |
| searchAndOpenRecords | השיטה מחפשת את הרשומה מהרכיב הגרפי של התקשורת במהלך התקשורת הנכנסת ופותחת את הרשומה. |
| getEnvironment | מקבל את היישום הנוכחי של הממשק המאוחד ואת פרטי הדף. הפרטים כוללים מזהה יישום (appid), pageType (pageType), מזהה רשומה (id), גיאוגרפיה ארגונית (orgGeo) וסוג ניווט הפעלה (navigationType). |
| openForm | פתיחת טופס ישות או טופס יצירה מהירה. |
| renderSearchPage | מאפשר לך לחפש בין הרשומות של סוג ישות מסוים. API זה פותח את דף הישות של ממשק מאוחד עם שדה החיפוש שבו מאוכלס מראש במחרוזת החיפוש המועברת כפרמטר. |
| addHandler | מוסיף את המנוי לאירועים.
הערה ניתן להשתמש בממשק API זה הן ברכיב הגרפי והן בדף הממשק המאוחד. |
| removeHandler | מסיר את המנוי מהאירועים.
הערה ניתן להשתמש בממשק API זה הן ברכיב הגרפי והן בדף הממשק המאוחד. |
| להעלות אירוע | מפעיל את המנוי המשויך לאירוע.
הערה אם יצרת אירועים מותאמים אישית באמצעות פעולת השירות addHandler, תוכל להעלות אירועים אלה על ידי העברת שם האירוע כפרמטר בשיטה זו. |
| updateהקשר | שיטה זו מאפשרת לך להגדיר את מילון האוטומציה. |
| עדכוןשיחה | שיטה זו מאפשרת לך לעדכן רשומת שיחה. |
מידע קשור
מה חדש ב- Dynamics 365 Channel Integration Framework
דרישות המערכת עבור Dynamics 365 Channel Integration Framework 2.0