במאמר זה
סקירה כללית
הגדר כתובת אתר להתקשרות חוזרת של webhook
dropdown icon
נקודות קצה של API של שותפים
    נקודת קצה של API התאמה
    נקודת קצה של API רשומות
הבנת קודי תגובה של נקודות קצה של API
ממשק API של דוחות שותפים/תבניות
היסטוריית גרסאות
חיבור אינטרנט מפורט של רשומות שיחות עבור Webex Calling במרכז השותפים
list-menuבמאמר זה
list-menuמשוב?

שותפי Webex Calling מרובי דיירים (MT) יכולים להגדיר הוק אינטרנט כדי לאסוף רשומות Webex Calling עבור כל הלקוחות שלך. זה מאפשר פיוס חיוב יעיל, ניתוח ודיווח מבלי שתצטרך לשאול כל לקוח בנפרד.

סקירה כללית

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

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

לקבלת היכרות עם הוק האינטרנט וממשקי ה- API הנלווים אליו, צפה ב- Vidcast: API היסטוריית Webex Calling שיחות מפורטת של שותפים.

מה מספק הוק האינטרנט של השותפים

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

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

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

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

הוקי האינטרנט מספקים רשומות באופן אמין. עם זאת, ייתכן שתקבל רשומות כפולות בעומסי Webhook הבאים כאשר המערכת משחקת מחדש רשומות בתנאים מסוימים. אתה אחראי לטיפול בביטול כפילויות רשומות. כדי לזהות רשומות כפולות, השתמש בשדה reportID כמפתח הראשי ובש דה ReportTime כדי לקבוע מתי הושלמה או עיבדה שיחה. השתמש בשדות אלה כדי לעדכן או להוסיף את הרשומות למאגרי הנתונים הפנימיים שלך.

הוק אינטרנט במרכז השותפים

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

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

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

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

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

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

הגדר כתובת אתר להתקשרות חוזרת של webhook

הגדר את הוק האינטרנט במרכז השותפים. ניתן להגדיר רק הוק אינטרנט אחד לכל ארגון שותף.

ודא שיש לך תפקיד מנהל מלא של שותף עם 'גישה מלאה ברמת מנהל ארגוני ' וגישת API של Webex Calling CDR מסומנים במרכז הבקרה (תחת ניהול > משתמשים, בחר מנהל מלא של מנהל מערכת או שותף ולאחר מכן בחר תפקידי מנהל מערכת > שותף).

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

Screenshot showing administrator roles settings with Partner admin and Partner full admin selected, along with Webex Calling CDR API Access checked under Functional settings.

1

היכנס לרכ זת השותפים.

2

עבור אל הגדרות ארגון > רש ומות פרטי שיחה.

Screenshot of Organization Settings for Call Detail Records, displaying fields for Webhook URL, Secret token, and Resource Type with Analytics selected.
3

הזן כתובת אתר לשימוש תחת Webhook.

כתובת האתר חייבת להסתיים ב- /webhook (לדוגמה, https://yourdomain.com/webhook).
4

אם ברצונך לאמת את מטעני הוק האינטרנט שלך עם אסימון סו די, אתה יכול להוסיף אחד. כדי למצוא מידע נוסף על Webex webhooks ואסימונים סודיים, ראה Webex למפת חים: Webhooks.

5

בחר אחד מסוגי המ שאב הבאים לשימוש עבור Webhook:

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

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

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

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

עליך להשתמש באסימון גישה לשותפים כדי לגשת לממשקי API אלה. המשתמש המאמת חייב להיות מנהל מלא של שותף עם גישה מלאה ברמת מנהל מערכת ארגונית ועליו לאפשר גישה Webex Callingל-CDR API. אסימון OAuth חייב לכלול את ההי spark-admin:calling_cdr_readקף. תפקידי מנהל לקריאה בלבד אינם מספיקים עבור ממשקי API של פיוס שותפים ורשומות.

השתמש בנ analytics-callingקודת הקצה עבור אזור Webex Calling הנתונים של ארגון הלקוח. השתמש בכתובת ה-URL הבסיסית הרלוונטית הן עבור ממשקי API של התאמה והן עבור הרשומות:

  • ארה"ב וקנדה: https://analytics-calling.webexapis.com
  • אירופה: https://analytics-calling-eu.webexapis.com
  • הודו: https://analytics-calling-in.webexapis.com
  • אוסטרליה: https://analytics-calling-au.webexapis.com

טווחי חלונות API חלים על שתי נקודות הקצה כדי להתמודד טוב יותר עם עומס השירות.

  • בטווחי זמן העולים על 48 שעות, משך החלון המרבי המותר הוא 12 שעות (נאכף).
  • עבור מזהה ארגון שותף, ממשקי ה- API מוגבלים בקשת API ראשונית אחת לדקה, לכל היקף אסימון. אם נעשה שימוש בעמוד, מותרות עד 10 בקשות API נוספות לדקה, לכל אסימון, וניתן לבצע אותן מיד לאחר הבקשה הראשונית.

נקודת קצה של API התאמה

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

דרישת גישה: המשתמש המאמת חייב להיות מנהל שותף עם גישה מלאה ברמת מנהל מערכת ועליו לאפשר גישה ל Webex Calling- CDR API. אסימון הגישה חייב לכלול את ההי spark-admin:calling_cdr_readקף.

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

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

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

פרמטרי 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 רשומות

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

זרימה מומלצת: התק /v1/partners/cdrcountbyorgשר קודם. לאחר מכן השתמש במדויק orgIdשהוחזר cdr_counts[].orgIdכאשר אתה מתקשר /v1/partners/cdrsbyorg.

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

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

כתובת ה-URL של נקודת הקצה של 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 התאמה cdr_counts[].orgId.
  • 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 בקשות עמודות לדקה, לכל היקף אסימון.

השתמש בעיבוד וביטול כפילויות אידמפוטנטי בעת אחזור רשומות, כולל בין תגובות עם דפים או חלונות פיוס חוזרים ונשנים. השתמש reportIdכמפתח הראשי ו reportTimeכדי לקבוע את הרשומה המעובדת האחרונה.

לדוגמה, אם בקשת ה- 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

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

<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&startTimeForNextFetch=2025-08-15T09:30:00.000Z&totalCount=20000&max=5000>; rel="next"

עימוד משתמש רק בכותרת הקי rel="next"שור. אם התגובה כוללת rel="next"קישור, השתמש בכתובת URL זו כדי לאחזר את דף הרשומות הבא. אם התגובה אינה כוללת rel="next"קישור, אחזרת את כל הרשומות הזמינות בטווח הזמן שנבחר.

עימוד עבור ממשק API זה עוקב אחר תקן RFC5988 (קישור לאינטרנט). לקבלת מידע נוסף, ראה יסודות API של REST.

הבנת קודי תגובה של נקודות קצה של API

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

טבלה 1. קודי תגובה של נקודת קצה של API

קוד תגובה

תיאור קוד תגובה

200

OK

400

בקשה רעה: הבקשה לא הייתה חוקית או שלא ניתן להגיש אותה אחרת. הודעת שגיאה נלווית תסביר עוד יותר.

401

לא מור שה: אישורי אימות היו חסרים או שגויים.

403

אסור: הבקשה מובנת, אך היא נדחתה או שהגישה אינה מותרת.

404

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

405

שיטה לא מות רת: הבקשה הוגשה למשאב באמצעות שיטת בקשת HTTP שאינה נתמכת.

409

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

410

נעלם: המשאב המבוקש אינו זמין עוד.

415

סוג מדיה לא נתמך: הבקשה הוגשה למשאב מבלי לציין סוג מדיה או השתמשה בסוג מדיה שאינו נתמך.

423

נעול: המשאב המבוקש אינו זמין באופן זמני. ייתכן שתהיה כותרת Retry-After המציינת כמה שניות עליך להמתין לפני שתנסה שוב את הבקשה.

428

תנאי מוקדם נדרש: לא ניתן לסרוק קבצים לאיתור תוכנות זדוניות ויש להוריד אותם בכפייה.

429

יותר מדי בקשות: יותר מדי בקשות נשלחו בפרק זמן נתון והבקשה הוגבלה בשיעור. כותרת Retry-After צריכה להיות נוכחת המציינת כמה שניות עליך להמתין לפני שניתן לבצע בקשה מוצלחת.

451

כברירת מחדל, בקשות analytics-calling.webexapis.comמנותבות לשרתים האזוריים הקרובים ביותר. אם שרתים אלה מארחים את נתוני הארגון, ה- API מחזיר את הנתונים. אחרת, ה- API מחזיר HTTP 451, וגוף התגובה מזהה את נקודת הקצה שבה ניתן לאחזר את נתוני הארגון.

500

שגיאת שרת פני מית: משהו השתבש בשרת. אם הבעיה נמשכת, אל תהסס לפנות אל [צוות התמיכה למפתחים של Webex] (/explore/support).

502

שער רע: השרת קיבל תגובה לא חוקית משרת במעלה הזרם בזמן עיבוד הבקשה. נסה שוב מאוחר יותר.

503

שירות לא זמין: השרת עמוס בבקשות. נסה שוב מאוחר יותר.

504

פסק זמן של Gateway: שרת במעלה הזרם לא הצליח להגיב בזמן. אם השאילתה שלך משתמשת בפרמטר מקסימלי, נסה לצמצם אותו.

ממשק API של דוחות שותפים/תבניות

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

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

היסטוריית גרסאות

היסטוריית עדכוני מסמך

תאריך תיקון

ביצענו את השינויים הבאים במאמר

13/08/26

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

  • קודי התגובה של נקודת הקצה של API Understanding מתעדכנים כך שיכללו קוד שגיאה 451.

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

2/04/2026

  • נוצר טבלת היסטוריית גרסאות העוקבת אחר כל השינויים שבוצעו לאורך זמן.

  • עדכנו את מקטעי נקודת הקצה של API של התאמה ו- API של רשומות כדי לכלול ערכי טבלה או קוד שגיאה.

האם המאמר הועיל לך?
האם המאמר הועיל לך?