UserMessage

Eine Nachricht, die von einem Nutzer an einen Agent gesendet wird.

UserMessage wird im Feld data des message-Objekts angezeigt, das Agents erhalten. Das Feld data ist ein base64-codierter String, der von Agents in Byte konvertiert und mit dem UserMessage-Protokollpuffer geparst werden muss.

JSON-Darstellung
{
  "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.
}
Felder
requestId

string

Die eindeutige ID der Nutzernachricht. Verwenden Sie dieses Feld, um eingehende Nachrichten zu deduplizieren.

conversationId

string

Die eindeutige ID der Unterhaltung.

customAgentId

string

Eine benutzerdefinierte Kennung für den Agent. Wird vom Partner bei der Agent-Registrierung definiert.

agent

string

Kennung für den Agent. Wird beim Erstellen des Agents festgelegt.

context

object (Context)

Kontextdaten, die mit der Nachricht verknüpft sind.

sendTime

string (Timestamp format)

Zeitpunkt, zu dem die Nachricht gesendet wurde.

Ein Zeitstempel im Format RFC3339 UTC „Zulu“ mit Nanosekundenauflösung und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".

dialogflowResponse

object (DialogflowResponse)

Die Dialogflow-Antwort.

Union-Feld payload. Die Nutzlast der Nutzernachricht. Für payload ist nur einer der folgenden Werte zulässig:
message

object (Message)

Der Inhalt der Nachricht.

receipts

object (Receipts)

Der Inhalt der Belege.

userStatus

object (UserStatus)

Der Inhalt des Nutzerstatus.

surveyResponse

object (SurveyResponse)

Die Antworten der Umfrage.

suggestionResponse

object (SuggestionResponse)

Die Antwort auf den Vorschlag.

authenticationResponse

object (AuthenticationResponse)

Die Authentifizierungsantwort.

UserStatus

Ein Nutzerstatus.

JSON-Darstellung
{
  "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.
}
Felder
createTime

string (Timestamp format)

Der Zeitpunkt, zu dem sich der Nutzerstatus geändert hat.

Ein Zeitstempel im Format RFC3339 UTC „Zulu“ mit Nanosekundenauflösung und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".

Union-Feld status.

Für status ist nur einer der folgenden Werte zulässig:

isTyping

boolean

Gibt an, ob der Nutzer gerade schreibt.

requestedLiveAgent

boolean

Gibt an, ob der Nutzer einen Live-Kundenservicemitarbeiter angefordert hat.