UserMessage

הודעה שנשלחה ממשתמש לנציג.

UserMessage מופיע בשדה data של האובייקט message שהסוכנים מקבלים. השדה data הוא מחרוזות בקידוד base64 שהסוכנים חייבים להמיר לבייטים ולנתח באמצעות מאגר הנתונים הזמני של פרוטוקול UserMessage.

ייצוג JSON
{
  "requestId": string,
  "conversationId": string,
  "customAgentId": string,
  "agent": string,
  "context": {
    object (Context)
  },
  "sendTime": string,
  "dialogflowResponse": {
    object (DialogflowResponse)
  },

  // Union field payload can be only one of the following:
  "message": {
    object (Message)
  },
  "receipts": {
    object (Receipts)
  },
  "userStatus": {
    object (UserStatus)
  },
  "surveyResponse": {
    object (SurveyResponse)
  },
  "suggestionResponse": {
    object (SuggestionResponse)
  },
  "authenticationResponse": {
    object (AuthenticationResponse)
  }
  // End of list of possible types for union field payload.
}
שדות
requestId

string

המזהה הייחודי של ההודעה למשתמש. אפשר להשתמש בשדה הזה כדי לבטל כפילויות של הודעות נכנסות.

conversationId

string

המזהה הייחודי של השיחה.

customAgentId

string

מזהה מותאם אישית של הנציג. מוגדר על ידי השותף במהלך הרשמת הנציג.

agent

string

המזהה של הנציג. ההגדרות ייקבעו במהלך יצירת הנציג.

context

object (Context)

נתונים לפי הקשר שמשויכים להודעה.

sendTime

string (Timestamp format)

השעה שבה ההודעה נשלחה.

חותמת זמן ב-RFC3339 UTC 'Zulu' בפורמט של רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "2014-10-02T15:01:23Z" ו-"2014-10-02T15:01:23.045123456Z".

dialogflowResponse

object (DialogflowResponse)

התשובה של Dialogflow.

שדה איחוד payload. המטען הייעודי (Payload) של הודעת המשתמש. payload יכול להיות רק אחת מהאפשרויות הבאות:
message

object (Message)

תוכן ההודעה.

receipts

object (Receipts)

תוכן הקבלות.

userStatus

object (UserStatus)

התוכן של סטטוס המשתמש.

surveyResponse

object (SurveyResponse)

התגובה לסקר.

suggestionResponse

object (SuggestionResponse)

התגובה להצעה.

authenticationResponse

object (AuthenticationResponse)

תגובת האימות.

UserStatus

סטטוס משתמש.

ייצוג JSON
{
  "createTime": string,

  // Union field status can be only one of the following:
  "isTyping": boolean,
  "requestedLiveAgent": boolean
  // End of list of possible types for union field status.
}
שדות
createTime

string (Timestamp format)

השעה שבה סטטוס המשתמש השתנה.

חותמת זמן ב-RFC3339 UTC 'Zulu' בפורמט של רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "2014-10-02T15:01:23Z" ו-"2014-10-02T15:01:23.045123456Z".

שדה איחוד status.

status יכול להיות רק אחת מהאפשרויות הבאות:

isTyping

boolean

האם המשתמש מקליד.

requestedLiveAgent

boolean

האם המשתמש ביקש נציג תמיכה אנושי.