Esta página se ha traducido con Cloud Translation API.

Eventos del módulo de interfaz de usuario

Esta página contiene la documentación de la API de todos los eventos de módulos de interfaz de usuario personalizados.

Información del evento

Nombre del evento	Carga útil	Descripción
active-conversation-selected	ActiveConversationSelectedPayload	Se envía cuando se selecciona una conversación.
smart-reply-selected	SmartReplySelection	Se envía cuando se selecciona un chip de Respuesta inteligente.
smart-reply-follow-up-suggestions-received	SmartReplyFollowUpSuggestionsReceivedPayload	Se envía cuando se han recibido sugerencias de seguimiento de Respuesta inteligente.
conversation-details-received	ConversationDetailsReceivedPayload	Se envía cuando se reciben los detalles de la conversación del SDK (incluida la información del agente y del cliente).
conversation-initialization-requested	ConversationInitializationRequestedPayload	Se envía cuando se debe inicializar la conversación de Dialogflow.
conversation-initialized	ConversationInitializedPayload	Se envía cuando se ha inicializado la conversación de Dialogflow.
conversation-started	ConversationStartedPayload	Se envía cuando se ha iniciado la conversación de Dialogflow.
conversation-completed	ConversationCompletedPayload	Se envía cuando se ha completado la conversación de Dialogflow.
conversation-profile-requested	ConversationProfileRequestedPayload	Se envía cuando se está obteniendo el perfil de conversación de Dialogflow.
conversation-profile-received	ConversationProfileReceivedPayload	Se envía cuando se ha recibido el perfil de conversación de Dialogflow.
conversation-model-requested	ConversationModelRequestedPayload	Se envía cuando se está obteniendo el modelo de conversación de Dialogflow.
conversation-model-received	ConversationModelReceivedPayload	Se envía cuando se recibe el modelo de conversación de Dialogflow.
new-message-received	NewMessageReceivedPayload	Se envía cuando se recibe un nuevo mensaje de transcripción.
analyze-content-requested	AnalyzeContentRequestDetails	Se envía cuando se debe hacer una solicitud AnalyzeContent.
analyze-content-response-received	AnalyzeContentResponseReceivedPayload	Se envía cuando se recibe un nuevo AnalyzeContentResponse.
conversation-summarization-requested	ConversationSummarizationRequestedEventPayload	Se ha solicitado un resumen de la conversación.
stateless-conversation-summarization-requested	StatelessConversationSummarizationRequestedPayload	Se ha solicitado un resumen de conversación sin estado.
stateless-conversation-summarization-response-received	StatelessConversationSummarizationResponseReceivedPayload	Se ha recibido la respuesta de resumen de la conversación sin estado.
conversation-summarization-received	ConversationSummarizationReceivedPayload	Resumen de la conversación recibido.
dialogflow-api-error	DialogflowApiErrorPayload	Se ha producido un error en la API de Dialogflow.
dialogflow-api-authentication-error	void	Se ha producido un error de autenticación de la API de Dialogflow (401).
answer-record-requested	AnswerRecordRequestedPayload	Se ha solicitado el registro de la respuesta.
answer-record-received	AnswerRecordReceivedPayload	Se ha recibido el registro de respuesta.
patch-answer-record-requested	PatchAnswerRecordRequestedPayload	Se ha solicitado un registro de respuestas de parche.
patch-answer-record-received	PatchAnswerRecordReceivedPayload	Se ha recibido una solicitud de registro de respuestas de parches.
article-search-requested	ArticleSearchRequestedPayload	Se ha solicitado una búsqueda de artículos.
article-search-response-received	ArticleSearchResponseReceivedPayload	Resultados de búsqueda de artículos recibidos.
dark-mode-toggled	DarkModeToggledPayload	Se ha activado el modo Oscuro en el escritorio del agente.
snackbar-notification-requested	SnackbarNotificationPayload	Se ha solicitado una notificación de snackbar.
live-person-connector-initialized	void	Se ha inicializado el conector de LivePerson.
genesys-cloud-connector-initialized	void	Se ha inicializado el conector de Genesys Cloud.
api-connector-initialized	void	Conector de API inicializado.
event-based-connector-initialized	void	Se ha inicializado el conector basado en eventos.
live-person-connector-initialization-failed	void	No se ha podido inicializar el conector de LivePerson.
genesys-cloud-connector-initialization-failed	void	No se ha podido inicializar el conector de Genesys Cloud.
genesys-cloud-connector-access-token-received	GenesysCloudConnectorAccessTokenReceivedPayload	Se ha recibido el token de acceso del conector de Genesys Cloud.
api-connector-initialization-failed	void	No se ha podido inicializar el conector de API.
event-based-connector-initialization-failed	void	No se ha podido inicializar el conector basado en eventos.
event-based-connection-established	void	Se envía cuando se establece la conexión WebSocket.
list-messages-requested	ListMessagesRequestedPayload	Solicitud para enumerar los mensajes de una conversación determinada.
list-messages-response-received	ListMessagesResponseReceivedPayload	Se activa cuando se recibe una respuesta de lista de mensajes.
virtual-agent-assist-response-message-selected	VirtualAgentAssistResponseMessageSelectedPayload	Se envía cuando se selecciona un mensaje de respuesta de Virtual Agent Assist. Se usará para rellenar el cuadro de entrada del agente con el mensaje seleccionado.
human-agent-transfer-initiated	HumanAgentTransferInitiatedPayload	Se envía cuando se transfiere una llamada de un agente virtual a un agente humano.
search-knowledge-requested	SearchKnowledgeRequestedPayload	Se ha solicitado la búsqueda de conocimientos.
search-knowledge-response-received	SearchKnowledgeResponseReceivedPayload	Se ha recibido la respuesta de búsqueda de conocimientos.
knowledge-assist-v2-answer-pasted	cadena	Una respuesta de Asistencia de conocimientos v2 que se pegará en el chat.
batch-create-messages-requested	BatchCreateMessagesRequestedPayload	Crear mensajes en bloque en una conversación. De esta forma, los mensajes se añadirán a la conversación sin generar sugerencias de Asistente del agente.
batch-create-messages-response-received	BatchCreateMessagesResponseReceivedPayload	Se ha recibido la respuesta de creación de mensajes por lotes.

Cargas útiles de eventos

Consulte todas las cargas útiles 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;
}

Eventos del módulo de interfaz de usuario Organízate con las colecciones Guarda y clasifica el contenido según tus preferencias.