UI モジュール イベント

このページには、すべてのカスタム UI モジュール イベントの API ドキュメントが記載されています。

予定の詳細

イベント名	ペイロード	説明
active-conversation-selected	ActiveConversationSelectedPayload	会話が選択されたときにディスパッチされます。
smart-reply-selected	SmartReplySelection	スマート リプライ チップが選択されたときにディスパッチされます。
smart-reply-follow-up-suggestions-received	SmartReplyFollowUpSuggestionsReceivedPayload	スマート リプライのフォローアップの候補が届いたときに送信されます。
conversation-details-received	ConversationDetailsReceivedPayload	SDK から会話の詳細（エージェントとお客様の情報を含む）が受信されたときにディスパッチされます。
conversation-initialization-requested	ConversationInitializationRequestedPayload	Dialogflow の会話を初期化する必要があるときにディスパッチされます。
conversation-initialized	ConversationInitializedPayload	Dialogflow の会話が初期化されたときにディスパッチされます。
conversation-started	ConversationStartedPayload	Dialogflow の会話が開始されたときにディスパッチされます。
conversation-completed	ConversationCompletedPayload	Dialogflow の会話が完了したときにディスパッチされます。
conversation-profile-requested	ConversationProfileRequestedPayload	Dialogflow の会話プロファイルがフェッチされているときにディスパッチされます。
conversation-profile-received	ConversationProfileReceivedPayload	Dialogflow の会話プロファイルが受信されたときにディスパッチされます。
conversation-model-requested	ConversationModelRequestedPayload	Dialogflow 会話モデルがフェッチされているときにディスパッチされます。
conversation-model-received	ConversationModelReceivedPayload	Dialogflow 会話モデルが受信されたときにディスパッチされます。
new-message-received	NewMessageReceivedPayload	新しい文字起こしメッセージが受信されたときにディスパッチされます。
analyze-content-requested	AnalyzeContentRequestDetails	AnalyzeContent リクエストを送信する必要があるときにディスパッチされます。
analyze-content-response-received	AnalyzeContentResponseReceivedPayload	新しい AnalyzeContentResponse を受信したときにディスパッチされます。
conversation-summarization-requested	ConversationSummarizationRequestedEventPayload	会話の要約をリクエストしました。
stateless-conversation-summarization-requested	StatelessConversationSummarizationRequestedPayload	ステートレスの会話の要約がリクエストされました。
stateless-conversation-summarization-response-received	StatelessConversationSummarizationResponseReceivedPayload	ステートレス会話の要約レスポンスを受信しました。
conversation-summarization-received	ConversationSummarizationReceivedPayload	会話の要約を受信しました。
dialogflow-api-error	DialogflowApiErrorPayload	Dialogflow API エラーが発生しました。
dialogflow-api-authentication-error	void	Dialogflow API 認証（401）エラーが発生しました。
answer-record-requested	AnswerRecordRequestedPayload	回答レコードをリクエストしました。
answer-record-received	AnswerRecordReceivedPayload	回答記録を受信しました。
patch-answer-record-requested	PatchAnswerRecordRequestedPayload	パッチ回答レコードをリクエストしました。
patch-answer-record-received	PatchAnswerRecordReceivedPayload	パッチ回答レコードのリクエストを受領しました。
article-search-requested	ArticleSearchRequestedPayload	記事の検索をリクエストしました。
article-search-response-received	ArticleSearchResponseReceivedPayload	記事の検索結果が届きました。
dark-mode-toggled	DarkModeToggledPayload	エージェントのデスクトップでダークモードが切り替わっている。
snackbar-notification-requested	SnackbarNotificationPayload	スナックバー通知をリクエストしました。
live-person-connector-initialized	void	LivePerson コネクタが初期化されました。
genesys-cloud-connector-initialized	void	Genesys Cloud コネクタが初期化されました。
api-connector-initialized	void	API コネクタが初期化されました。
event-based-connector-initialized	void	イベントベースのコネクタが初期化されました。
live-person-connector-initialization-failed	void	LivePerson コネクタの初期化に失敗しました。
genesys-cloud-connector-initialization-failed	void	Genesys Cloud コネクタの初期化に失敗しました。
genesys-cloud-connector-access-token-received	GenesysCloudConnectorAccessTokenReceivedPayload	Genesys Cloud コネクタのアクセス トークンが受信されました。
api-connector-initialization-failed	void	API コネクタの初期化に失敗しました。
event-based-connector-initialization-failed	void	イベントベースのコネクタの初期化に失敗しました。
event-based-connection-established	void	WebSocket 接続が確立されたときにディスパッチされます。
list-messages-requested	ListMessagesRequestedPayload	特定の会話のメッセージを一覧表示するリクエスト。
list-messages-response-received	ListMessagesResponseReceivedPayload	リスト メッセージ レスポンスが受信されたときにディスパッチされます。
virtual-agent-assist-response-message-selected	VirtualAgentAssistResponseMessageSelectedPayload	仮想エージェント アシスタントのレスポンス メッセージが選択されたときにディスパッチされます。これは、選択したメッセージがエージェントの入力ボックスに入力されるために使用されます。
human-agent-transfer-initiated	HumanAgentTransferInitiatedPayload	通話が仮想エージェントから人間のエージェントに転送されたときにディスパッチされます。
search-knowledge-requested	SearchKnowledgeRequestedPayload	検索知識がリクエストされました。
search-knowledge-response-received	SearchKnowledgeResponseReceivedPayload	検索ナレッジのレスポンスが届きました。
knowledge-assist-v2-answer-pasted	文字列	チャットに貼り付ける Knowledge Assist v2 の回答。
batch-create-messages-requested	BatchCreateMessagesRequestedPayload	会話内のメッセージを一括作成します。これにより、メッセージの Agent Assist の候補を生成せずに、メッセージが会話に追加されます。
batch-create-messages-response-received	BatchCreateMessagesResponseReceivedPayload	バッチ作成メッセージのレスポンスを受信しました。

イベント ペイロード

すべてのカスタム イベント ペイロードを表示します。

ActiveConversationSelectedPayload

interface ActiveConversationSelectedPayload {
  conversationName: string;
}

AnalyzeContentRequestDetails

interface AnalyzeContentRequestDetails {
  type?: string;
  conversationId: string;
  participantRole:
    | "ROLE_UNSPECIFIED"
    | "HUMAN_AGENT"
    | "AUTOMATED_AGENT"
    | "END_USER";

  /**
   * @link
   * https://cloud.google.com/dialogflow/es/docs/reference/rest/v2beta1/projects.locations.conversations.participants/analyzeContent#request-body
   */
  request: AnalyzeContentRequest;
}

AnalyzeContentResponseReceivedPayload

interface AnalyzeContentResponseReceivedPayload {
  conversationName: string;
  payload: {
    type?: string;

    /**
     * @link
     * https://cloud.google.com/dialogflow/es/docs/reference/rest/v2beta1/projects.locations.conversations.participants#Participant
     */
    participant?: Participant;

    /**
     * @link
     * https://cloud.google.com/dialogflow/es/docs/reference/rest/v2beta1/projects.locations.conversations.participants/analyzeContent#request-body
     */
    request?: AnalyzeContentRequest;

    /**
     * @link
     * https://cloud.google.com/dialogflow/es/docs/reference/rest/v2beta1/AnalyzeContentResponse
     */
    response: AnalyzeContentResponse;
  };
}

ArticleSearchRequestedPayload

interface ArticleSearchRequestedPayload {
  queryText: string;
}

ArticleSearchResponseReceivedPayload

interface ArticleSearchResponseReceivedPayload {
  conversationName: string;

  /**
   * @link
   * https://cloud.google.com/dialogflow/priv/docs/reference/rest/v2beta1/projects.locations.conversations.suggestions/searchArticles#response-body
   */
  payload: SearchArticlesResponse;
}

ConversationDetailsReceivedPayload

interface ConversationDetailsReceivedPayload {
  conversationName: string;
  payload: {
    chatInfo: {
      rtSessionId: string;
      accountId: string;
      chatRequestedTime: number;
      chatStartTime: number;
      sessionStartTime: number;
      chatStartUrl: string;
      spectatedEngagement: boolean;
      chatSkill: string;
    };
    chattingAgentInfo: {
      agentName: string;
      agentNickname: string;
      agentGroupName: string;
      agentId: number;
    };
    agentInfo: {
      accountId: string;
      agentName: string;
      agentNickname: string;
      agentId: number;
      agentEmail: string;
      employeeId: string;
      maxChats: number;
      agentGroupName: string;
    };
    chatTranscript: { lines: TranscriptMessage[] };
    surveyQuestions: {
      preChat: {
        email: { value: string; displayName: string };
        phone: { value: string; displayName: string };
        name: { value: string; displayName: string };
        customizedQuestions: [];
      };
      postChat: [];
      agentSurvey: [];
    };
    visitorInfo: {
      visitorId: string;
      visitorName: string;
      visitorSso: boolean;
      device: string;
      browser: string;
      operatingSystem: string;
      country: string;
      countryCode: string;
      state: string;
      city: string;
      isp: string;
      organization: string;
      IpAddress: string;
      visitStartTime: string;
      chattingVisitorState: string;
      chatRequestedTime: string;
      chatStartUrl: string;
      visitorTimezone: string;
      visitorTyping: boolean;
    };
    campaignInfo: {
      campaignName: string;
      campaignId: string;
      campaignDescription: string;
      targetAudience: [];
      goalName: string;
      goalId: string;
      goalDescription: string;
    };
    engagementInfo: {
      VisitorBehavior: [];
      skill: string;
      engagementType: string;
      engagementId: string;
      engagementName: string;
      agentNote: string;
      engagementSkill: string;
    };
    visitorJourney: {
      pages: [];
      searchEngine: { searchProvider: string; searchKeywords: string };
    };
    SDE: {
      customerDetails: [];
      personalInfo: [];
      marketingSource: [];
      leadGeneration: [];
      transaction: [];
      viewedProducts: [];
      shoppingCart: [];
      serviceActivity: [];
      error: [];
    };
    authenticatedData: { customerDetails: []; personalInfo: [] };
    claimsAndAuthType: { claims: {}; acr: string };
    applicationInfo: { theme: "light" | "dark" };
    customVariables: [];
    splitSession: { customVariables: [] };
  };
}

ConversationInitializationRequestedPayload

interface ConversationInitializationRequestedPayload {
  conversationName: string;
}

ConversationInitializedPayload

interface ConversationInitializedPayload {
  conversation: Conversation;
  participants: ParticipantsMap<Participant_ | null>;
}

ConversationProfileRequestedPayload

interface ConversationProfileRequestedPayload {
  conversationProfileName: string;
}

ConversationProfileReceivedPayload

type ConversationProfileReceivedPayload =
  /**
   * @link
   * https://cloud.google.com/dialogflow/es/docs/reference/rest/v2beta1/projects.locations.conversationProfiles#ConversationProfile
   */
  ConversationProfile | null;

ConversationModelRequestedPayload

interface ConversationModelRequestedPayload {
  modelName: string | null;
}

ConversationModelReceivedPayload

type ConversationModelReceivedPayload =
  /**
   * @link
   * https://cloud.google.com/dialogflow/es/docs/reference/rest/v2beta1/projects.locations.conversationModels#ConversationModel
   */
  ConversationModel | null;

ConversationSummarizationReceivedPayload

interface ConversationSummarizationReceivedPayload {
  conversationName: string;

  /**
   * @link
   * https://cloud.google.com/dialogflow/es/docs/reference/rest/v2beta1/SuggestConversationSummaryResponse
   */
  payload: SuggestConversationSummaryResponse;
}

ConversationSummarizationRequestedEventPayload

type ConversationSummarizationRequestedEventPayload = {
  conversationName?: string;

  /**
   * @link
   * https://cloud.google.com/dialogflow/es/docs/reference/rest/v2beta1/projects.locations.conversations.suggestions/suggestConversationSummary#request-body
   */
  request?: SuggestConversationSummaryRequest;
} | void;

DarkModeToggledPayload

interface DarkModeToggledPayload {
  on: boolean;
}

DialogflowApiErrorPayload

type DialogflowApiErrorPayload = {
  conversationName: string;
  source:
    | "TYPE_UNSPECIFIED"
    | "ARTICLE_SUGGESTION"
    | "FAQ"
    | "SMART_REPLY"
    | "DIALOGFLOW_ASSIST"
    | "SMART_COMPOSE"
    | "ISSUE_SMART_COMPOSE"
    | "SPELL_GRAMMAR_CORRECTION"
    | "CONVERSATION_SUMMARIZATION"
    | "KEY_MOMENT"
    | "ARTICLE_SEARCH"
    | "CONVERSATION_GUIDANCE"
    | "ARTICLE_SUGGESTION_VOICE"
    | "CONVERSATION_SUMMARIZATION_VOICE"
    | "KNOWLEDGE_SEARCH"
    | "KNOWLEDGE_ASSIST"
    | "ENTITY_EXTRACTION"
    | "ANALYZE_CONTENT"
    | "INITIALIZATION"
    | "AUTHORIZATION"
    | "LIST_MESSAGES"
    | "BATCH_CREATE_MESSAGES"
    | "GET_CONVERSATION_PROFILE"
    | "GET_CONVERSATION_MODEL"
    | "SEARCH_KNOWLEDGE"
    | "GENERATE_STATELESS_SUMMARY";
  data?: Dictionary;
  error: GoogleRpcStatus | null;
} | null;

SmartReplySelection

SuggestionFeatureSelection<SmartReplyAnswer>

SmartReplyFollowUpSuggestionsReceivedPayload

interface SmartReplyFollowUpSuggestionsReceivedPayload {
  conversationName: string;

  /**
   * @link
   * https://cloud.google.com/dialogflow/es/docs/reference/rest/v2beta1/SuggestSmartRepliesResponse#smartreplyanswer
   */
  payload: SmartReplyAnswer_[];
}

PatchAnswerRecordRequestedPayload

type PatchAnswerRecordRequestedPayload = PatchPayload<{
  /**
   * @link
   * https://cloud.google.com/dialogflow/es/docs/reference/rest/v2beta1/projects.answerRecords#AnswerRecord
   */
  answerRecord: AnswerRecord;

  /**
   * @link
   * https://cloud.google.com/dialogflow/es/docs/reference/rest/v2beta1/projects.answerRecords#AnswerRecord
   */
  previousAnswerRecord?: AnswerRecord | undefined;
}>;

PatchAnswerRecordReceivedPayload

interface PatchAnswerRecordReceivedPayload {
  conversationName: string;

  /**
   * @link
   * https://cloud.google.com/dialogflow/es/docs/reference/rest/v2beta1/projects.answerRecords#AnswerRecord
   */
  payload: AnswerRecord;
}

SnackbarNotificationPayload

interface SnackbarNotificationPayload {
  message: string;
  actionMessage?: string | undefined;
  actionHandler?: () => void;
}

AnswerRecordRequestedPayload

interface AnswerRecordRequestedPayload {
  answerRecordName: string;
}

AnswerRecordReceivedPayload

interface AnswerRecordReceivedPayload {
  conversationName: string;

  /**
   * @link
   * https://cloud.google.com/dialogflow/es/docs/reference/rest/v2beta1/projects.answerRecords#AnswerRecord
   */
  payload: AnswerRecord;
}

ConversationStartedPayload

interface ConversationStartedPayload {
  conversationName: string;
}

ConversationCompletedPayload

interface ConversationCompletedPayload {
  conversationName: string;
}

NewMessageReceivedPayload

type NewMessageReceivedPayload =
  /**
   * @link
   * https://cloud.google.com/dialogflow/es/docs/reference/rest/v2beta1/Message
   */
  Message;

GenesysCloudConnectorAccessTokenReceivedPayload

export declare interface GenesysCloudConnectorAccessTokenReceivedPayload {
  accessToken: string;
}

ListMessagesRequestedPayload

interface ListMessagesRequestedPayload {
  conversationName: string;
}

ListMessagesResponseReceivedPayload

interface ListMessagesResponseReceivedPayload {
  conversationName: string;

  /**
   * @link
   * https://cloud.google.com/dialogflow/es/docs/reference/rest/v2beta1/ListMessagesResponse
   */
  payload: ListMessagesResponse;
}

VirtualAgentAssistResponseMessageSelectedPayload

interface VirtualAgentAssistResponseMessageSelectedPayload {
  responseMessage: string;
}

HumanAgentTransferInitiatedPayload

interface HumanAgentTransferInitiatedPayload {
  conversationName: string;
}

SearchKnowledgeRequestedPayload

interface SearchKnowledgeRequestedPayload {
  /**
   * @link
   * https://cloud.google.com/dialogflow/es/docs/reference/rest/v2beta1/projects.locations.suggestions/searchKnowledge
   */
  request: SearchKnowledgeRequest;
}

SearchKnowledgeResponseReceivedPayload

interface SearchKnowledgeResponseReceivedPayload {
  /**
   * @link
   * https://cloud.google.com/dialogflow/es/docs/reference/rest/v2beta1/projects.locations.suggestions/searchKnowledge
   */
  request: SearchKnowledgeRequest;

  /**
   * @link
   * https://cloud.google.com/dialogflow/es/docs/reference/rest/v2beta1/SearchKnowledgeResponse
   */
  response: SearchKnowledgeResponse;
}

BatchCreateMessagesRequestedPayload

interface BatchCreateMessagesRequestedPayload {
  conversationName: string;

  /**
   * @link
   * https://cloud.google.com/dialogflow/es/docs/reference/rest/v2beta1/projects.locations.conversations.messages/batchCreate#request-body
   */
  request: BatchCreateMessagesRequest;
}

BatchCreateMessagesResponseReceivedPayload

interface BatchCreateMessagesResponseReceivedPayload {
  conversationName: string;

  /**
   * @link
   * https://cloud.google.com/dialogflow/es/docs/reference/rest/v2beta1/BatchCreateMessagesResponse
   */
  response: BatchCreateMessagesResponse;
}

StatelessConversationSummarizationRequestedPayload

interface StatelessConversationSummarizationRequestedPayload {
  conversationName?: string;

  /**
   * @link
   * https://cloud.google.com/dialogflow/es/docs/reference/rest/v2beta1/projects.locations.suggestions/generateStatelessSummary#request-body
   */
  request?: GenerateStatelessSummaryRequest;
}

StatelessConversationSummarizationResponseReceivedPayload

interface StatelessConversationSummarizationResponseReceivedPayload {
  conversationName?: string;

  /**
   * @link
   * https://cloud.google.com/dialogflow/es/docs/reference/rest/v2beta1/GenerateStatelessSummaryResponse
   */
  response?: GenerateStatelessSummaryResponse;
}