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	已要求顯示 Snackbar 通知。
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	選取 Virtual Agent Assist 回覆訊息時，系統會發出這個事件。這會用來在代理程式輸入框中填入所選訊息。
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;
}