Esta página foi traduzida pela API Cloud Translation.

Eventos do módulo da UI

Esta página contém a documentação da API para todos os eventos personalizados do módulo da UI.

Detalhes do evento

Nome do evento	Payload	Descrição
active-conversation-selected	ActiveConversationSelectedPayload	Enviado quando uma conversa é selecionada.
smart-reply-selected	SmartReplySelection	Enviado quando um ícone de Resposta inteligente é selecionado.
smart-reply-follow-up-suggestions-received	SmartReplyFollowUpSuggestionsReceivedPayload	Enviado quando as sugestões de acompanhamento da Resposta inteligente são recebidas.
conversation-details-received	ConversationDetailsReceivedPayload	É enviado quando os detalhes da conversa são recebidos do SDK, incluindo informações do agente e do cliente.
conversation-initialization-requested	ConversationInitializationRequestedPayload	É enviado quando a conversa do Dialogflow precisa ser inicializada.
conversation-initialized	ConversationInitializedPayload	Enviado quando a conversa do Dialogflow é inicializada.
conversation-started	ConversationStartedPayload	Enviado quando a conversa do Dialogflow é iniciada.
conversation-completed	ConversationCompletedPayload	Enviado quando a conversa do Dialogflow é concluída.
conversation-profile-requested	ConversationProfileRequestedPayload	É enviado quando o perfil de conversa do Dialogflow está sendo buscado.
conversation-profile-received	ConversationProfileReceivedPayload	Enviado quando o perfil de conversa do Dialogflow é recebido.
conversation-model-requested	ConversationModelRequestedPayload	É enviado quando o modelo de conversa do Dialogflow está sendo buscado.
conversation-model-received	ConversationModelReceivedPayload	Enviado quando o modelo de conversa do Dialogflow é recebido.
new-message-received	NewMessageReceivedPayload	É enviado quando uma nova mensagem de transcrição é recebida.
analyze-content-requested	AnalyzeContentRequestDetails	É enviada quando uma solicitação de AnalyzeContent precisa ser feita.
analyze-content-response-received	AnalyzeContentResponseReceivedPayload	Enviado quando uma nova AnalyzeContentResponse é recebida.
conversation-summarization-requested	ConversationSummarizationRequestedEventPayload	Resumo da conversa solicitado.
stateless-conversation-summarization-requested	StatelessConversationSummarizationRequestedPayload	Resumo da conversa sem estado solicitado.
stateless-conversation-summarization-response-received	StatelessConversationSummarizationResponseReceivedPayload	Resposta de resumo de conversa sem estado recebida.
conversation-summarization-received	ConversationSummarizationReceivedPayload	Resumo da conversa recebido.
dialogflow-api-error	DialogflowApiErrorPayload	Erro na API Dialogflow.
dialogflow-api-authentication-error	void	Erro de autenticação da API Dialogflow (401).
answer-record-requested	AnswerRecordRequestedPayload	Registro de resposta solicitado.
answer-record-received	AnswerRecordReceivedPayload	Registro de resposta recebido.
patch-answer-record-requested	PatchAnswerRecordRequestedPayload	Registro de resposta de patch solicitado.
patch-answer-record-received	PatchAnswerRecordReceivedPayload	Solicitação de registro de correção da resposta recebida.
article-search-requested	ArticleSearchRequestedPayload	Pesquisa de artigos solicitada.
article-search-response-received	ArticleSearchResponseReceivedPayload	Resultados da pesquisa de artigos recebidos.
dark-mode-toggled	DarkModeToggledPayload	Modo escuro ativado no computador do agente.
snackbar-notification-requested	SnackbarNotificationPayload	Notificação da barra de informações solicitada.
live-person-connector-initialized	void	O conector do LivePerson foi inicializado.
genesys-cloud-connector-initialized	void	O conector Genesys Cloud foi inicializado.
api-connector-initialized	void	Conector de API inicializado.
event-based-connector-initialized	void	O conector baseado em eventos foi inicializado.
live-person-connector-initialization-failed	void	Falha na inicialização do conector do LivePerson.
genesys-cloud-connector-initialization-failed	void	Falha na inicialização do conector Genesys Cloud.
genesys-cloud-connector-access-token-received	GenesysCloudConnectorAccessTokenReceivedPayload	Token de acesso do conector Genesys Cloud recebido.
api-connector-initialization-failed	void	Falha na inicialização do conector da API.
event-based-connector-initialization-failed	void	Falha na inicialização do conector baseado em eventos.
event-based-connection-established	void	Enviado quando a conexão do WebSocket é estabelecida.
list-messages-requested	ListMessagesRequestedPayload	Solicitação para listar mensagens de uma determinada conversa.
list-messages-response-received	ListMessagesResponseReceivedPayload	Enviado quando uma resposta de lista de mensagens é recebida.
virtual-agent-assist-response-message-selected	VirtualAgentAssistResponseMessageSelectedPayload	Enviado quando uma mensagem de resposta do Assistente Virtual é selecionada. Ele será usado para preencher a caixa de entrada do agente com a mensagem selecionada.
human-agent-transfer-initiated	HumanAgentTransferInitiatedPayload	É enviada quando uma chamada é transferida de um agente virtual para um humano.
search-knowledge-requested	SearchKnowledgeRequestedPayload	Solicitação de pesquisa de conhecimento.
search-knowledge-response-received	SearchKnowledgeResponseReceivedPayload	Resposta de pesquisa recebida.
knowledge-assist-v2-answer-pasted	string	Uma resposta do Assistente de conhecimento v2 para ser colada no chat.
batch-create-messages-requested	BatchCreateMessagesRequestedPayload	Criar mensagens em lote em uma conversa. Isso vai adicionar as mensagens à conversa sem gerar sugestões do Assistente do agente.
batch-create-messages-response-received	BatchCreateMessagesResponseReceivedPayload	Resposta de criação de mensagens em lote recebida.

Payloads de eventos

Confira todos os payloads de eventos personalizados.

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;
}