UserMessage

ユーザーからエージェントに送信されるメッセージ。

UserMessage は、エージェントが受け取る message オブジェクトの data フィールドに表示されます。data フィールドは Base64 でエンコードされた文字列です。エージェントはバイトに変換し、UserMessage プロトコルバッファで解析する必要があります。

JSON 表現

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,
  "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` エージェントのカスタム ID。エージェント登録時にパートナー様が定義します。
`agent`	`string` エージェントの ID。エージェントの作成時に設定されます。
`context`	`object (Context)` メッセージに関連付けられたコンテキストデータ。
`sendTime`	`string (Timestamp format)` メッセージが送信された時刻。 RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: `"2014-10-02T15:01:23Z"`、`"2014-10-02T15:01:23.045123456Z"`。
`dialogflowResponse`	`object (DialogflowResponse)` Dialogflow のレスポンス。
共用体フィールド `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」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: `"2014-10-02T15:01:23Z"`、`"2014-10-02T15:01:23.045123456Z"`。
共用体フィールド `status`。 `status` は次のいずれかになります。
`isTyping`	`boolean` ユーザーが入力中かどうか。
`requestedLiveAgent`	`boolean` ユーザーがライブ対応のエージェントをリクエストしたかどうか。