REST Resource: phones.agentEvents

リソース: AgentEvent

エージェントからユーザーに送信されるイベント。

JSON 表現
{
  "name": string,
  "eventType": enum (AgentEvent.EventType),
  "messageId": string,
  "sendTime": string
}
フィールド
name

string

このフィールドは RBM プラットフォームによって設定されます。エージェント イベントの作成時にこの属性を含めないでください。このフィールドは、phones/{E.164}/agentEvents/{eventId} に解決されます。{E.164} は E.164 形式のユーザーの電話番号、{eventId} はエージェント イベントのエージェント割り当て ID です。

eventType

enum (AgentEvent.EventType)

エージェント イベントのタイプ。

messageId

string

エージェント イベントが関連するユーザー メッセージの ID。このフィールドは、タイプが READ のエージェント イベントにのみ適用されます。

sendTime

string (Timestamp format)

このフィールドは RBM プラットフォームによって設定されます。エージェント メッセージを作成するときに含めないでください。このフィールドは、イベントがユーザーに送信された時刻を解決します。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

AgentEvent.EventType

エージェント イベントのタイプ。

列挙型
TYPE_UNSPECIFIED 指定されていません。
IS_TYPING エージェントが入力中です。
READ ユーザーが送信したメッセージがエージェントによって読み取られました。

Methods

create

エージェントからユーザーにイベントを送信します。