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 ユーザーから送信されたメッセージは、エージェントが読みました。

メソッド

create

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