Cette page contient la documentation de l'API pour tous les événements de module d'UI personnalisés.
Détails de l'événement
Nom de l'événement | Charge utile | Description |
---|---|---|
active-conversation-selected | ActiveConversationSelectedPayload | Déclenché lorsqu'une conversation est sélectionnée. |
smart-reply-selected | SmartReplySelection | Expédié lorsqu'un chip de réponse suggérée est sélectionné. |
smart-reply-follow-up-suggestions-received | SmartReplyFollowUpSuggestionsReceivedPayload | Envoi effectué lorsque des suggestions de suivi de la réponse suggérée sont reçues. |
conversation-details-received | ConversationDetailsReceivedPayload | Expédiée lorsque les détails de la conversation sont reçus du SDK (y compris les informations sur l'agent et le client). |
conversation-initialization-requested | ConversationInitializationRequestedPayload | Distribué lorsque la conversation Dialogflow doit être initialisée. |
conversation-initialized | ConversationInitializedPayload | Distribué lorsque la conversation Dialogflow a été initialisée. |
conversation-started | ConversationStartedPayload | Distribué lorsque la conversation Dialogflow a commencé. |
conversation-completed | ConversationCompletedPayload | Expédié lorsque la conversation Dialogflow est terminée. |
conversation-profile-requested | ConversationProfileRequestedPayload | Distribué lorsque le profil de conversation Dialogflow est extrait. |
conversation-profile-received | ConversationProfileReceivedPayload | Expédié lorsque le profil de conversation Dialogflow a été reçu. |
conversation-model-requested | ConversationModelRequestedPayload | Distribué lorsque le modèle de conversation Dialogflow est extrait. |
conversation-model-received | ConversationModelReceivedPayload | Expédié lorsque le modèle de conversation Dialogflow a été reçu. |
new-message-received | NewMessageReceivedPayload | Envoyé lorsqu'un nouveau message de transcription a été reçu. |
analyze-content-requested | AnalyzeContentRequestDetails | Distribué lorsqu'une requête AnalyzeContent doit être envoyée. |
analyze-content-response-received | AnalyzeContentResponseReceivedPayload | Expédié lorsqu'un nouvel AnalyzeContentResponse a été reçu. |
conversation-summarization-requested | ConversationSummarizationRequestedEventPayload | Résumé de la conversation demandé. |
stateless-conversation-summarization-requested | StatelessConversationSummarizationRequestedPayload | Résumé de conversation sans état demandé. |
stateless-conversation-summarization-response-received | StatelessConversationSummarizationResponseReceivedPayload | Réponse de résumé de conversation sans état reçue. |
conversation-summarization-received | ConversationSummarizationReceivedPayload | Résumé de la conversation reçu. |
dialogflow-api-error | DialogflowApiErrorPayload | Erreur de l'API Dialogflow détectée. |
dialogflow-api-authentication-error | void | Erreur d'authentification de l'API Dialogflow (401). |
answer-record-requested | AnswerRecordRequestedPayload | Enregistrement de la réponse demandé. |
answer-record-received | AnswerRecordReceivedPayload | Enregistrement de réponses reçu. |
patch-answer-record-requested | PatchAnswerRecordRequestedPayload | Enregistrement de la réponse de correctif demandé. |
patch-answer-record-received | PatchAnswerRecordReceivedPayload | Demande de création d'un enregistrement de réponse de correctif reçue. |
article-search-requested | ArticleSearchRequestedPayload | Recherche d'article demandée. |
article-search-response-received | ArticleSearchResponseReceivedPayload | Résultats de recherche d'articles reçus. |
dark-mode-toggled | DarkModeToggledPayload | Mode sombre activé/désactivé dans l'interface Agent sur ordinateur. |
snackbar-notification-requested | SnackbarNotificationPayload | Notification de barre de notification demandée. |
live-person-connector-initialized | void | Connecteur LivePerson initialisé. |
genesys-cloud-connector-initialized | void | Connecteur Genesys Cloud initialisé. |
api-connector-initialized | void | Connecteur d'API initialisé. |
event-based-connector-initialized | void | Connecteur basé sur les événements initialisé. |
live-person-connector-initialization-failed | void | Échec de l'initialisation du connecteur LivePerson. |
genesys-cloud-connector-initialization-failed | void | Échec de l'initialisation du connecteur Genesys Cloud. |
genesys-cloud-connector-access-token-received | GenesysCloudConnectorAccessTokenReceivedPayload | Jeton d'accès du connecteur Genesys Cloud reçu. |
api-connector-initialization-failed | void | Échec de l'initialisation du connecteur d'API. |
event-based-connector-initialization-failed | void | Échec de l'initialisation du connecteur basé sur les événements. |
event-based-connection-established | void | Distribué lorsque la connexion WebSocket est établie. |
list-messages-requested | ListMessagesRequestedPayload | Requête visant à lister les messages d'une conversation donnée. |
list-messages-response-received | ListMessagesResponseReceivedPayload | Expédiée lorsqu'une réponse de liste de messages est reçue. |
virtual-agent-assist-response-message-selected | VirtualAgentAssistResponseMessageSelectedPayload | Expédié lorsqu'un message de réponse de l'assistance par agent virtuel est sélectionné. Le message sélectionné sera renseigné dans la zone de saisie de l'agent. |
human-agent-transfer-initiated | HumanAgentTransferInitiatedPayload | Envoyé lorsqu'un appel est transféré d'un agent virtuel à un agent humain. |
search-knowledge-requested | SearchKnowledgeRequestedPayload | Informations sur la recherche demandées. |
search-knowledge-response-received | SearchKnowledgeResponseReceivedPayload | Réponse de la base de connaissances sur le Réseau de Recherche reçue. |
knowledge-assist-v2-answer-pasted | chaîne | Réponse Knowledge Assist v2 à coller dans le chat. |
batch-create-messages-requested | BatchCreateMessagesRequestedPayload | Créer des messages groupés dans une conversation Les messages seront ajoutés à la conversation sans générer de suggestions Agent Assist. |
batch-create-messages-response-received | BatchCreateMessagesResponseReceivedPayload | Réponse reçue pour la création de messages par lot. |
Charges utiles d'événement
Afficher toutes les charges utiles d'événement personnalisé.
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;
}