הגדרת בקשה לשליחת הודעה.
| ייצוג ב-JSON |
|---|
{
"acceptedOutputModes": [
string
],
"taskPushNotificationConfig": {
object ( |
| שדות | |
|---|---|
acceptedOutputModes[] |
רשימה של סוגי מדיה שהלקוח מוכן לקבל עבור חלקי התשובה. הסוכנים צריכים להשתמש במידע הזה כדי להתאים את הפלט שלהם. |
taskPushNotificationConfig |
הגדרות שמאפשרות לסוכן לשלוח התראות על עדכונים במשימות. כששולחים את ההגדרה הזו בבקשת |
returnImmediately |
אם |
historyLength |
המספר המקסימלי של ההודעות האחרונות מההיסטוריה של המשימה שיוחזרו בתשובה. אם לא מוגדר ערך, המשמעות היא שהלקוח לא מטיל מגבלה כלשהי. ערך של אפס מציין בקשה לא לכלול הודעות. השרת לא יכול להחזיר יותר הודעות מהערך שסופק, אבל הוא יכול להחיל מגבלה נמוכה יותר. |
TaskPushNotificationConfig
מאגר שמשייך הגדרת התראה בדחיפה למשימה ספציפית.
| ייצוג ב-JSON |
|---|
{
"tenant": string,
"id": string,
"taskId": string,
"url": string,
"token": string,
"authentication": {
object ( |
| שדות | |
|---|---|
tenant |
זה שינוי אופציונלי. מזהה ניתוב אטום. הערך חייב להיות זהה לערך |
id |
פרטי ההגדרה של ההתראה. מזהה ייחודי (למשל UUID) של הגדרת ההתראה בדחיפה הזו. |
taskId |
המזהה של המשימה שההגדרה הזו משויכת אליה. |
url |
חובה. כתובת ה-URL שאליה צריך לשלוח את ההתראה. |
token |
טוקן ייחודי למשימה או לסשן הזה. |
authentication |
נדרשים פרטי אימות כדי לשלוח את ההתראה. |
AuthenticationInfo
הגדרת פרטי אימות, שמשמשים להתראות פוש.
| ייצוג ב-JSON |
|---|
{ "scheme": string, "credentials": string } |
| שדות | |
|---|---|
scheme |
חובה. סכמת אימות HTTP ממאגר IANA. דוגמאות: |
credentials |
פרטי הכניסה של ההתראות. הפורמט תלוי בסכימה (למשל, טוקן ל-Bearer). |