השתמש ב- webhook כדי לקבל הודעות ואירועים

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

השירות ינסה שנית שלוש פעמים, עם זמן קצוב של 10 שניות בכל ניסיון.

נקודת הקצה

{webhook_url}/v3/conversations/{conversationId}/activities

איפה

• {webhook_url} היא כתובת ה- URL הבסיסית שאת תצורתה קבעת בערוץ המותאם אישית שלך.
• {conversationId} עם ה-GUID שמציין את השיחה הפעילה.

שיטה

POST

כותרות בקשות

כותרת	Description
ההרשאות	אסימון הרשאה מסוג Bearer שהושג מהאפליקציה של Microsoft Entra הרשומה.

הערה

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

נסה שוב את המדיניות

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

מטען בקשה

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

שדות גוף בקשה

מפתח רמה 1	מפתח רמה 2	מפתח רמה 3	Description	סוג
סוג נתונים			סוג פעילות (הודעה, אירוע, הקלדה)	מחרוזת (256 לכל היותר)
channelId			מזהה הערוץ (לדוגמה, "MessagingApi")	מחרוזת (256 לכל היותר)
מאת			אובייקט שולח	אובייקט
	מזהה		מזהה שולח	מחרוזת (256 לכל היותר)
	שם		שם התצוגה של השולח	מחרוזת (256 לכל היותר)
שיחה	מזהה		מזהה שיחה	מחרוזת (256 לכל היותר)
עיצוב טקסט			עיצוב טקסט ההודעה (markdown)	מחרוזת (256 לכל היותר)
קבצים מצורפים	[ ]		רשימת קבצים מצורפים (אם קיימות)	מערך
	סוג תוכן		סוג MIME של הקובץ המצורף	מחרוזת (256 לכל היותר)
	תוכן -Url		כתובת URL של קובץ	מחרוזת
	תוכן		בדרך כלל Null	—
	שם		שם הקובץ	מחרוזת (256 לכל היותר)
	תמונה ממוזערתUrl		בדרך כלל Null	—

סוגי פעילות נתמכים

סוג	Description
הודעה	טקסט רגיל או הודעה עשירה
הקלדה	מציין שהנציג או נציג שירות הלקוחות (נציג שירות או נציג) מקליד
אירוע	אירועים ברמת המערכת כגון הצטרפות/סגירה

שמות אירועי פעילות

הערכים הבאים נשלחים בשדה השם של פעילויות האירוע:

• סוכן התקבל
• סוכןEndSession
• PrimaryAgentEndConversation
• סוכן מנותק
• AgentStartSecondaryChannel
• AgentRaiseSecondaryChannel
• AgentEndSecondaryChannel
• סגירת שיחה
• SupervisorForceClosedConversation
• ConsultAgentInitiated
• ConsultAgentFailed
• ConsultAgentAcceptSession
• ConsultAgentEndSession
• ConsultAgentRejectSession
• פגישת הייעוץ עם הסוכן פגה
• ConsultAgentRemoved
• העברהלסוכןמתחילה
• העברה לסוכן נכשלה
• TransferAgentAcceptSession
• TransferAgentRejectSession
• TransferAgentTimedOutSession
• AgentEndedConsult
• סוכן הצטרף לשיחת הלקוח
• סוכן הייעוץ עזב את השיחה הציבורית
• העברת לתור הופעלה
• TransferToQueueFailed
• CustomerDisconnected
• הלקוח התנתק, הנציג ממתין
• הוקצה סוכן
• מחוץ לשעות הפעילות עקב שעות עבודה לא פעילות
• מחוץ לשעות הפעילות עקב חג

מטענים לדוגמה

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

נציג/סוכן קיבל

{
  "type": "message",
  "channelId": "<custom channel Id GUID>",
  "conversation": {
    "id": "{conversation_id}"
  },
  "text": "EventName: **_AgentAccepted_**",
  "name": "AgentAccepted"
}

נציג/נציגת מקליד/ת

{
  "type": "typing",
  "channelId": "MessagingApi",
  "conversation": {
    "id": "{conversation_id}"
  },
  "recipient": {
    "id": "{recipient_id}"
  }
}

הודעה מנציג

{
  "type": "message",
  "channelId": "<custom channel Id GUID>",
  "from": {
    "id": "{sender_id}",
    "name": "{sender_name}"
  },
  "conversation": {
    "id": "{conversation_id}"
  },
  "textFormat": "markdown",
  "text": "hello"
}

סוכן/נציג שולח קובץ מצורף

{
  "type": "message",
  "channelId": "<custom channel Id GUID>",
  "from": {
    "id": "{sender_id}",
    "name": "{sender_name}"
  },
  "conversation": {
    "id": "{conversation_id}"
  },
  "textFormat": "markdown",
  "attachments": [
    {
      "contentType": "image/jpeg",
      "contentUrl": "{attachment_url}",
      "content": null,
      "name": "issue (1).jpg",
      "thumbnailUrl": null
    }
  ]
}

נציג/נציג סגור

{
  "type": "message",
  "channelId": "<custom channel Id GUID>",
  "from": {
    "id": "{sender_id}"
  },
  "conversation": {
    "id": "{conversation_id}"
  },
  "text": "EventName: **_AgentClosed_**",
  "name": "AgentClosed"
}

השיחה נסגרה

{
  "type": "message",
  "channelId": "<custom channel Id GUID>",
  "from": {
    "id": "{sender_id}"
  },
  "conversation": {
    "id": "{conversation_id}"
  },
  "text": "EventName: **_ConversationClosed_**",
  "name": "ConversationClosed"
}

תגובה

קוד HTTP של 200. הפונקציה מתעלמת מכל הנתונים שפורסמו בגוף הבקשה.

מידע קשור

מבט כולל על ממשקי API של העברת הודעות