ה-webhook של רשומות שיחות מפורטות מציע פתרון מאובטח, ניתן להרחבה וחזק, המונע על ידי אירועים ולא על ידי בקשות. Webhook זה מספק נראות רבה יותר על פעילויות Webex Calling של הלקוחות שלך, ותומך במקרי שימוש החל מחיוב ועד דיווח מותאם אישית.

באפשרותך להשתמש ב-webhook זה כדי לאסוף רשומות בנוחות עבור כל הלקוחות המנוהלים דרך Partner Hub מבלי לבצע שאילתה לכל לקוח בנפרד. webhook זה מאפשר לך לפתח אפליקציות מותאמות אישית לדיווח, חיוב וניתוח עבור דרישות עסקיות פנימיות ושירותים בעלי ערך מוסף.

למבוא ל-webhook ול-API הנלווים אליו, צפו בסרטון וידאו זה: ממשק API של היסטוריית שיחות מפורטת של שותף שיחות Webex.

מה מספק ה-webhook של Partner

ה-webhook מספק רישומי היסטוריית שיחות מפורטים כל 5 דקות. כל מטען של webhook מכיל:

• רישומי שיחות שהסתיימו בין 10 דקות ל-5 דקות לפני השעה הנוכחית.
• כל הרשומות המאוחרות שעובדו על ידי ענן Webex Calling.
• ממלא אוטומטית רשומות שיחות מאוחרות במטענים הבאים של webhook כדי להבטיח מסירה אמינה.

כדי להראות כיצד רשומות שיחות כלולות בכל מטען, נבחן את הדוגמה הבאה:

• מטען שהתקבל ב 14:05 מכיל שיחות שהסתיימו בין 13:55 ו 14:00.
• שיחות המסתיימות בין 14:00 ו 14:05 כלולים ב- 14:10 מטען.
• רשומות שהושלמו מוקדם יותר (לדוגמה, שיחה שהסתיימה ב- 14:04) אך מעובד באיחור על ידי ענן Webex Calling (לדוגמה, ב 14:11) כלולים במטען המתוזמן הבא (לדוגמה, 14:15).

Webhook ב-Parter Hub

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

רשומות שיחות של Webex מועברות באותו פורמט כמו ממשקי ה-API הקיימים של רשומות שיחות מפורטות. ניתן להגדיר webhook ולבחור בין שני סוגי פיד:

• ניתוח נתונים - כולל את כל רשומות השיחות עבור כל ארגוני הלקוחות שאיתם לשותף יש קשרי Webex Calling. זה כולל ארגונים שבהם:
  • השותף מנהל את ארגון הלקוח בתפקיד שותף מנהל מלא.
  • לארגון הלקוח יש מנוי פעיל של Webex Calling בתוך ארגון השותף.
• חיוב - כולל רישומי שיחות עבור שיחות שבוצעו על ידי משתמשים עם רישיון Webex Calling שנמכר והוקצה על ידי השותף. רשומות שיחות עבור סביבות עבודה כלולות בפיד זה.

גישה ופרטיות נתונים

רק השותף הבעלים יכול לגשת לרשומות פרטי שיחות (CDR) לצורך חיוב.

• שותף (או שותף משנה) שמנהל את הרישיון המשויך לרשומת השיחה הופך לשותף הבעלים.
• הבעלות נקבעת על ידי: מזהה משתמש > מזהה רישיון > מזהה מנוי > מזהה שותף.
• כל CDR נגיש לשותף יחיד.
• חלק מרשומות השיחות אינן משויכות לשותף חיוב, ולא כל השותפים המשויכים לארגון מקבלים גישה שווה לכל הרשומות, מכיוון שרשומות אלו עשויות להכיל מידע אישי מזהה (PII).

בנוסף ל-webhook, Webex Calling מספק נקודות קצה של API לתמיכה בהתאמה של נתונים. נקודות קצה אלו מאפשרות לך להשלים או ליישב את מאגרי הנתונים שלך עם כל רשומה חסרה שייתכן שמאזין ה-webhook שלך לא קיבל. שתי נקודות הקצה של ה-API הן Reconciliation API ו- Records API.

רשומות מממשקי API אלה זמינות למשך 30 יום. כדי להבטיח שתקבלו את כל הרשומות הצפויות, אנו ממליצים לבצע התאמה בין מאגרי הרשומות שלכם מעת לעת, כגון כל 12 או 24 שעות.

עליך להשתמש באסימון גישת שותף כדי לגשת לממשקי API אלה. השג ונהל את אסימון הגישה של השותף שלך בהתאם לנהלי ניהול אסימון גישה סטנדרטיים של Webex Developer .

נקודת קצה של API לפיוס

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

אם אתם מנהלים יותר מ-200 ארגוני לקוחות, ה-API ממסד את התוצאות לפי עמודים כדי לשפר את הקריאות.

כתובת ה-URL של נקודת הקצה של ממשק ה-API להתאמה משתמשת בפורמט הבא:

פרמטרים של API

ניתן להשתמש בממשק ה-API כדי לאחזר רשומות שיחות מ-30 הימים האחרונים. חלון הזמן שבחרת חייב להתחיל לפחות 5 דקות לפני זמן UTC הנוכחי, ולא יכול לעלות על 12 שעות בין שעות ההתחלה והסיום בקריאה אחת ל-API.

פרמטרי ה-API הם:

• startTime (נדרש, מחרוזת) - תאריך ושעת ההתחלה (UTC) עבור הרשומה הראשונה שברצונך לאסוף. ודא כי:
  • אתה פורמט את השעה כ- YYYY-MM-DDTHH:MM:SS.mmmZ. לדוגמה, 2025-08-15T06:00:00.000Z.
  • תאריך ושעת ההתחלה אינם יכולים להיות ישנים יותר מ-30 יום משעון UTC הנוכחי.
  • החלון בין startTime ל- endTime לא יכול לעלות על 12 שעות.
• endTime (נדרש, מחרוזת) - תאריך ושעת הסיום (UTC) עבור הרשומות שברצונך לאסוף. הרישומים מבוססים על זמן דיווח, שהוא הזמן שבו השיחה מסתיימת. ודא כי:
  • אתה פורמט את השעה כ- YYYY-MM-DDTHH:MM:SS.mmmZ. לדוגמה, 2025-08-15T18:00:00.000Z.
  • תאריך ושעת הסיום חייבים להיות 5 דקות לפני שעון UTC הנוכחי ולא לפני 30 יום.
  • תאריך ושעת הסיום חייבים להיות גדולים מ- startTime.
  • החלון בין startTime ל- endTime לא יכול לעלות על 12 שעות.

דוגמה לתגובת JSON של נקודת קצה של API לפיוס:

          {
          "cdr_counts": [
          {
          "orgId": "zzzzzzzz-yyyy-zzzz-xxxx-yyyyyyyyyyyy",
          "count": 3009
          },
          {
          "orgId": "yyyyyyyy-yyyy-zzzz-xxxx-yyyyyyyyyyyy",
          "count": 129
          },
          {
          "orgId": "xxxxxxxx-yyyy-zzzz-xxxx-yyyyyyyyyyyy",
          "count": 27895
          }
          ]
          }          
        

כותרות התגובה של ה-API מציינות את המספר הכולל של הארגונים שהוחזרו והאם דפים נוספים זמינים. בדוק את פרמטרי הכותרת הבאים כדי לוודא שביקשת שאילתה לכל הדפים:

• מספר עמודים: מספר עמודים כולל (לדוגמה, 2)
• סך כל הארגונים: מספר כולל של ארגונים שנכללו בתשובה (לדוגמה, 283)
• עמוד נוכחי: מספר העמוד הנוכחי (לדוגמה, 1)

לדוגמה, אם הכותרות מציגות num-pages=2, total-orgs=283, ו current-page=1, אתה צופה בעמוד הראשון של תגובה בת שני עמודים המכילה 283 ארגונים בסך הכל. כדי לגשת לעמוד הבא, הוסף את page=2 פרמטר לבקשת ה-GET שלך, כפי שמוצג להלן:

https://analytics-calling.webexapis.com/v1/partners/cdrcountbyorg?endTime=YYYY-MM-DDTHH:MM:SS.000Z&startTime=YYYY-MM-DDTHH:MM:SS.000Z&page=2

נקודת קצה של ה-API של רשומות

נקודת הקצה של Records API משמשת לשאילתה על רשומות שיחות חסרות עבור ארגונים ספציפיים שבהם זוהו אי התאמות או נתונים חסרים באמצעות Reconciliation API.

ממשק ה-API של Records מחזיר רשומות שיחות בפורמט JSON, זהה לפורמט המתואר בממשק ה- Detailed Call History API. המטען המוחזר מכיל שדות זהים למטען שהוחזר של היסטוריית השיחות המפורטת. למידע נוסף על השדות והערכים שלהם, ראה דוח היסטוריית שיחות מפורט של שיחות Webex.

ה-API מספק רישומי שיחות שהסתיימו 5 דקות לפני השעה הנוכחית. כדי להבטיח שכל רישומי השיחות יהיו זמינים, אנו ממליצים לבצע שאילתה ב-API שעה לאחר חלון הזמן המועדף עליכם.

כתובת ה-URL של נקודת הקצה של Records API משתמשת בפורמט הבא:

https://analytics-calling.webexapis.com/v1/partners/cdrsbyorg?orgId=zzzzzzzz-yyyy-zzzz-xxxx-yyyyyyyyyyyy&endTime=YYYY-MM-DDTHH:MM:SS.000Z&startTime=YYYY-MM-DDTHH:MM:SS.000Z

פרמטרים של API

• OrgID (נדרש, מחרוזת) - מזהה הארגון שעבורו ברצונך לאחזר רשומות. ניתן לקבל מזהי ארגון מממשק ה-API של ההתאמה.
• startTime (נדרש, מחרוזת) - תאריך ושעת ההתחלה (UTC) עבור הרשומה הראשונה שברצונך לאסוף. ודא כי:
  • אתה פורמט את השעה כ- YYYY-MM-DDTHH:MM:SS.mmmZ. לדוגמה, 2025-08-15T06:00:00.000Z.
  • תאריך ושעת ההתחלה אינם יכולים להיות ישנים יותר מ-30 יום משעון UTC הנוכחי.
  • המרווח בין startTime ל- endTime לא יעלה על 12 שעות בבקשת API בודדת.
• endTime (נדרש, מחרוזת) - תאריך ושעת הסיום (UTC) עבור הרשומה האחרונה שברצונך לאסוף. הרישומים מבוססים על זמן דיווח, שהוא הזמן שבו השיחה מסתיימת. ודא כי:
  • אתה פורמט את השעה כ- YYYY-MM-DDTHH:MM:SS.mmmZ. לדוגמה, 2025-08-15T18:00:00.000Z.
  • תאריך ושעת הסיום חייבים להיות לפחות 5 דקות לפני שעון UTC הנוכחי ולא לפני 30 יום.
  • תאריך ושעת הסיום חייבים להיות גדולים מ- startTime.
  • המרווח בין startTime ל- endTime לא יעלה על 12 שעות בבקשת API בודדת.
• מקסימום (אופציונלי, מספר) - מגביל את מספר הרשומות המרבי בכל עמוד בתגובה. ודא כי:
  • הטווח הוא בין 500 ל-5000. ערך ברירת המחדל הוא 5000. לדוגמה, Max=1000.
  • אם ל-API יש יותר רשומות להחזיר מהערך המקסימלי שצוין, התגובה מדורגת לפי עמודים.
  • אם מצוין ערך מתחת ל-500, הוא יותאם אוטומטית ל-500. אם מצוין ערך מעל 5000, הוא יותאם למטה ל-5000.

עימוד

כדי לזהות אם תגובות ה-API ממוספרות בעמודים, בדוק את כותרות התגובות עבור כותרת קישור. אם קיים קישור next בכותרת הקישור, חלץ אותו והשתמש בערך startTimeForNextFetch כדי לבקש את קבוצת הרשומות הבאה. אם אין קישור הבא, כל הדוחות עבור טווח הזמן שנבחר נאספים.

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

לדוגמה, אם בקשת ה-API הראשונית היא:

https://analytics-calling.webexapis.com/v1/partners/cdrsbyorg?orgId=zzzzzzzz-yyyy-zzzz-xxxx-yyyyyyyyyyyy&endTime=2025-08-15T18:00:00.000Z&startTime=2025-08-15T06:00:00.000Z&Max=5000

אז כותרת הקישור בתגובה היא:

; rel="next"

ערכי קישור אפשריים אחרים כוללים rel="first" ו- rel="prev" עבור העמוד הראשון והקודם, בהתאמה.

שׁוּתָף reports/templates ממשק API

ניתן ליצור ולהוריד דוחות הזמינים במרכז השותפים באמצעות ממשקי ה-API של דוחות שותפים. למידע נוסף, עיינו ב שותף report/templates.

שותפים יכולים גם לגשת ולהוריד דוחות מרובים ישירות ממרכז השותפים. למידע נוסף, ראו דוחות מרכז השותפים.