User:Corinneh/VoiceMCSEvents - Revision history

WikiSysop at 23:15, May 3, 2022

2022-05-03T23:15:29Z

WikiSysop at 23:00, May 3, 2022

2022-05-03T23:00:43Z

WikiSysop at 22:30, May 3, 2022

2022-05-03T22:30:41Z

WikiSysop at 19:45, April 19, 2022

2022-04-19T19:45:36Z

WikiSysop at 19:00, April 19, 2022

2022-04-19T19:00:34Z

WikiSysop at 18:45, April 19, 2022

2022-04-19T18:45:58Z

WikiSysop at 18:31, April 19, 2022

2022-04-19T18:31:34Z

WikiSysop at 17:46, April 19, 2022

2022-04-19T17:46:34Z

WikiSysop at 17:31, April 19, 2022

2022-04-19T17:31:47Z

WikiSysop: Created page with "Sample page for Voice MCS "events and call models" documentation."

2022-04-18T19:00:42Z

Created page with "Sample page for Voice MCS "events and call models" documentation."

New page

Sample page for Voice MCS "events and call models" documentation.

@@ Line 201: / Line 201: @@
 *Mandatory: This attribute is not mandatory for any events.
 *Optional: [https://all.docs-qa.genesys.com/Draft:VM/Current/VMEventsandModels/AgentStateandDNEvents#EventAgentLogin EventAgentLogin]
 |}

@@ Line 87: / Line 87: @@
 |-
 !Events that use the attribute
-|This attribute is used in the following events:
 *Mandatory: This attribute is not mandatory for any events.
 *Optional: [https://all.docs-qa.genesys.com/Draft:VM/Current/VMEventsandModels/AgentStateandDNEvents#EventAgentLogin EventAgentLogin]
@@ Line 198: / Line 198: @@
 |-
 !Events that use the attribute
-|This attribute is used in the following events:
 *Mandatory: This attribute is not mandatory for any events.
 *Optional: [https://all.docs-qa.genesys.com/Draft:VM/Current/VMEventsandModels/AgentStateandDNEvents#EventAgentLogin EventAgentLogin]
 |}

← Older revision		Revision as of 22:30, May 3, 2022
Line 70:		Line 70:
	*EventTreatmentNotApplied		*EventTreatmentNotApplied
	*EventTreatmentRequired		*EventTreatmentRequired
		+
		+
		+	==Testing attribute description layouts==
		+	===Consumer ID===
		+	{\|
		+	\|A pointer to the string containing the assigned Customer (Tenant) identifier through which the processing of the call was initiated. The attribute must be present in every event for a multi-tenant contact center.
		+	\|This attribute is used in the following events:
		+	*Mandatory: This attribute is not mandatory for any events.
		+	*Optional: [https://all.docs-qa.genesys.com/Draft:VM/Current/VMEventsandModels/AgentStateandDNEvents#EventAgentLogin EventAgentLogin]
		+	\|}
		+
		+	===Consumer ID v2===
		+	{\|
		+	!Description
		+	\|A pointer to the string containing the assigned Customer (Tenant) identifier through which the processing of the call was initiated. The attribute must be present in every event for a multi-tenant contact center.
		+	\|-
		+	!Events that use the attribute
		+	\|This attribute is used in the following events:
		+	*Mandatory: This attribute is not mandatory for any events.
		+	*Optional: [https://all.docs-qa.genesys.com/Draft:VM/Current/VMEventsandModels/AgentStateandDNEvents#EventAgentLogin EventAgentLogin]
		+	\|}
		+
		+	===Conn ID===
		+	{\|
		+	\|A current connection identifier of the call to which this event relates.
		+	{\|
		+	\|'''Byte'''
		+	\|colspan="8" \| '''Bits'''
		+	\|-
		+	\|
		+	\|0
		+	\|1
		+	\|2
		+	\|3
		+	\|4
		+	\|5
		+	\|6
		+	\|7
		+	\|-
		+	\|0
		+	\|colspan="2" \| Reserved
		+	\|colspan="6" \| Global Server Identifier
		+	\|-
		+	\|1
		+	\|colspan="8" \| Global Server Identifier
		+	\|-
		+	\|2
		+	\|colspan="8" \| Local Connection Identifier
		+	\|-
		+	\|3
		+	\|colspan="8" \| Local Connection Identifier
		+	\|-
		+	\|4
		+	\|colspan="8" \| Local Connection Identifier
		+	\|-
		+	\|5
		+	\|colspan="8" \| Local Connection Identifier
		+	\|-
		+	\|6
		+	\|colspan="8" \| Local Connection Identifier
		+	\|-
		+	\|7
		+	\|colspan="8" \| Local Connection Identifier
		+	\|}
		+
		+	'''ConnID Parameters'''<br/>
		+	Reserved (bits 0 and 1)—Bits reserved for future usage.
		+
		+	Global Server Identifier (bits 2-15)—Unique identifier for this T-Server specified by the server-id option. If server-id is not specified, the ConnID may not be unique within a multi-site contact center.
		+
		+	Local Connection Identifier (bits 16-63)—Local identifier of the call this event relates to.
		+	\|This attribute is used in the following events:
		+	*Mandatory: This attribute is not mandatory for any events.
		+	*Optional: [https://all.docs-qa.genesys.com/Draft:VM/Current/VMEventsandModels/AgentStateandDNEvents#EventAgentLogin EventAgentLogin]
		+	\|}
		+
		+	===Conn ID v2===
		+	{\|
		+	!Description
		+	\|A current connection identifier of the call to which this event relates.
		+	{\|
		+	\|'''Byte'''
		+	\|colspan="8" \| '''Bits'''
		+	\|-
		+	\|
		+	\|0
		+	\|1
		+	\|2
		+	\|3
		+	\|4
		+	\|5
		+	\|6
		+	\|7
		+	\|-
		+	\|0
		+	\|colspan="2" \| Reserved
		+	\|colspan="6" \| Global Server Identifier
		+	\|-
		+	\|1
		+	\|colspan="8" \| Global Server Identifier
		+	\|-
		+	\|2
		+	\|colspan="8" \| Local Connection Identifier
		+	\|-
		+	\|3
		+	\|colspan="8" \| Local Connection Identifier
		+	\|-
		+	\|4
		+	\|colspan="8" \| Local Connection Identifier
		+	\|-
		+	\|5
		+	\|colspan="8" \| Local Connection Identifier
		+	\|-
		+	\|6
		+	\|colspan="8" \| Local Connection Identifier
		+	\|-
		+	\|7
		+	\|colspan="8" \| Local Connection Identifier
		+	\|}
		+
		+	'''ConnID Parameters'''<br/>
		+	Reserved (bits 0 and 1)—Bits reserved for future usage.
		+
		+	Global Server Identifier (bits 2-15)—Unique identifier for this T-Server specified by the server-id option. If server-id is not specified, the ConnID may not be unique within a multi-site contact center.
		+
		+	Local Connection Identifier (bits 16-63)—Local identifier of the call this event relates to.
		+	\|-
		+	!Events that use the attribute
		+	\|This attribute is used in the following events:
		+	*Mandatory: This attribute is not mandatory for any events.
		+	*Optional: [https://all.docs-qa.genesys.com/Draft:VM/Current/VMEventsandModels/AgentStateandDNEvents#EventAgentLogin EventAgentLogin]
		+	\|}

@@ Line 1: / Line 1: @@
-=Voice Microservices topics available in Kafka event streaming=
+=Voice Microservices topics for event streaming=
-Voice Microservices provide the following topics for Kafka event streaming.
+Voice Microservices use the following topics for event streaming.
 '''Topic name'''=voice-agentstate<br/>
 '''Topic used for'''=Agent events<br/>
-'''Topic message key'''="{tenant_id}:{agent_id}" template
+'''Event key'''="{tenant_id}:{agent_id}" template
 '''Topic name'''=voice-callthread<br/>
 '''Topic used for'''=Call events<br/>
-'''Topic message key'''="{tenant_id}:{callthread_id}" template
+'''Event key'''="{tenant_id}:{callthread_id}" template
-==Events produced for each topic==
+==Events stored in each topic==
 The "grouping" attribute used in this documentation is not part of the topic or event structure in any way. Each grouping name is then used as section headings to group together similar events based on the purpose of events and the type of information that they convey.

@@ Line 1: / Line 1: @@
-=Voice Microservices event topics=
+=Voice Microservices topics available in Kafka event streaming=
 Voice Microservices provide the following topics for Kafka event streaming.
-Topic name=voice-agentstate<br/>
+'''Topic name'''=voice-agentstate<br/>
-Topic used for=Agent events<br/>
+'''Topic used for'''=Agent events<br/>
-Topic message key="{tenant_id}:{agent_id}" template
+'''Topic message key'''="{tenant_id}:{agent_id}" template
-Topic name=voice-callthread<br/>
+'''Topic name'''=voice-callthread<br/>
-Topic used for=Call events<br/>
+'''Topic used for'''=Call events<br/>
-Topic message key="{tenant_id}:{callthread_id}" template
+'''Topic message key'''="{tenant_id}:{callthread_id}" template
-===Events produced for each available topic===
+==Events produced for each topic==
 The "grouping" attribute used in this documentation is not part of the topic or event structure in any way. Each grouping name is then used as section headings to group together similar events based on the purpose of events and the type of information that they convey.
-Topic=voice-agentstate<br/>
+'''Topic'''=voice-agentstate<br/>
-Grouping=Agent state and DN events<br/>
+'''Grouping'''=Agent state and DN events<br/>
-Events list=
+'''Events list'''=
 *EventAgentLogin
 *EventAgentLogout
@@ Line 40: / Line 38: @@
 *EventMessageWaitingOff
-Topic=voice-callthread<br/>
+'''Topic'''=voice-callthread<br/>
-Grouping=Call Handling and Transfer/Conference Events<br/>
+'''Grouping'''=Call Handling and Transfer/Conference Events<br/>
-Events list=
+'''Events list'''=
 *EventDialing
 *EventRinging
@@ Line 59: / Line 57: @@
 *EventRetrieved
-Topic=voice-callthread<br/>
+'''Topic'''=voice-callthread<br/>
-Grouping=Call Routing Events<br/>
+'''Grouping'''=Call Routing Events<br/>
-Events list=
+'''Events list'''=
 *EventRouteRequest
 *EventRouteUsed
-Topic=voice-callthread<br/>
+'''Topic'''=voice-callthread<br/>
-Grouping=Call Treatment Events<br/>
+'''Grouping'''=Call Treatment Events<br/>
-Events list=
+'''Events list'''=
 *EventTreatmentApplied
 *EventTreatmentEnd
 *EventTreatmentNotApplied
 *EventTreatmentRequired

@@ Line 87: / Line 87: @@
 |-
 |Agent ID
-|(optional) XXX
+|(optional) This parameter uniquely identifies the ACD agent.
 AgentID must be present if the agent is logged in through T-Server or if the information is available.
 |-
 |CustomerID
-|(optional)
+|(optional) A pointer to the string containing the assigned Customer (Tenant) identifier through which the processing of the call was initiated. The attribute must be present in every event for a multi-tenant contact center.
 |-
 |Event
-|(mandatory)
+|(mandatory) The event identifier.
 |-
 |Reasons
-|(optional)
+|(optional) A pointer to an additional data structure that provides reasons for and results of actions taken by the user of ThisDN. Any Reasons attribute that appears in TEvent is taken directly from the corresponding request. (See ReferenceID in Events That Correspond to Requests.) There is no other source for the information found in the content of the Reasons attribute. That is, no Reasons attribute should be expected for an event that is unsolicited. An event with no reference ID has no identifiable request that prompted it. See Persistent Reasons for more information.
 |-
 |ReferenceID
-|(optional)
+|(optional) ReferenceID is the identifier generated by T-Library or a TSetReferenceID() function call and attached to the request a client sends to T-Server. Every time a client sends a request to T-Server, it uses the current ReferenceID (increasing it by one each time). In response, T-Server generates an event. Only in the response to the client who initiated the request, as acknowledgment that the request has been fulfilled, the resulting event includes the same ReferenceID that was attached to the request. If the request fails, EventError will be sent only to the requestor.
 |-
 |Server
-|(mandatory)
+|(mandatory) A local server handle to the T-Server in question. In other words, a unique identifier assigned by T-Library to the connection between a client and T-Server.
 |-
 |ThisDN
-|(mandatory)
+|(mandatory) The directory number of the most significant telephony object (except an ACD group or trunk group) with respect to the event in question. The application must be registered to this directory number to receive the event in question.
 |-
 |ThisQueue
-|(optional)
+|(optional) The directory number of the most significant ACD group with respect to the event in question.
 |-
 |time
-|(mandatory)
+|(mandatory) The structure specifies event generation time that is expressed in elapsed seconds and microseconds since 00:00 GMT, January 1, 1970 (zero hour). For more information, refer to the type Time in your API reference.
 |-
-|{{Editgrn_open}}AgentWorkMode{{Editgrn_close}} <font color="#B24DE7">'''Corinne's Note:''' This was "WorkMode" in the legacy document, but json examples show it as AgentWorkMode for Kafka events. I'm assuming it is always AgentWorkMode for this document.</font>
+|{{Editgrn_open}}AgentWorkMode{{Editgrn_close}} <font color="#B24DE7">'''Corinne's Note:''' This was "WorkMode" in the legacy document, but json examples show it as AgentWorkMode for Kafka events. Which should I use for the Kafka event attribute name?</font>
-|(optional)
+|(optional) This attribute indicates the agent/supervisor-related current work mode.
 |-
 |Extensions
-|(optional) XXX
+|(optional) A pointer to an additional data structure that takes into account switch-specific features that cannot be described by the other parameters in an event or a request. Extensions that are specific to particular events are noted with their event information in the T-Library Events section. Some extensions for requests, however, are applicable to all T-Servers, and permit tuning of T-Server operations.
 If present, the Extensions attribute can include a ReasonCode value specifically used to communicate hardware reasons.

← Older revision		Revision as of 17:31, April 19, 2022
Line 1:		Line 1:
−	~~Sample page~~ for ~~Voice MCS~~ "events ~~and call models~~" documentation.	+	=Voice Microservices event topics=
		+
		+	==Topics available in Kafka event streaming==
		+	Voice Microservices provide the following topics for Kafka event streaming.
		+
		+	Topic name=voice-agentstate<br/>
		+	Topic used for=Agent events<br/>
		+	Topic message key="{tenant_id}:{agent_id}" template
		+
		+	Topic name=voice-callthread<br/>
		+	Topic used for=Call events<br/>
		+	Topic message key="{tenant_id}:{callthread_id}" template
		+
		+	===Events produced for each available topic===
		+	The "grouping" attribute used in this documentation is not part of the topic or event structure in any way. Each grouping name is then used as section headings to group together similar events based on the purpose of events and the type of information that they convey.
		+
		+	Topic=voice-agentstate<br/>
		+	Grouping=Agent state and DN events<br/>
		+	Events list=
		+	*EventAgentLogin
		+	*EventAgentLogout
		+	*EventQueueLogout
		+	*EventAgentReady
		+	*EventAgentNotReady
		+	*EventDNOutOfService
		+	*EventDNBackInService
		+	*EventDNDOn
		+	*EventDNDOff
		+	*EventForwardSet
		+	*EventForwardCancel
		+	*EventMonitoringNextCall
		+	*EventMonitoringCancelled
		+	*EventOffHook
		+	*EventOnHook
		+	*EventMuteOn
		+	*EventMuteOff
		+	*EventListenDisconnected
		+	*EventListenReconnected
		+	*EventMessageWaitingOn
		+	*EventMessageWaitingOff
		+
		+	Topic=voice-callthread
		+	Grouping=Call Handling and Transfer/Conference Events
		+	Events list=
		+	*EventDialing
		+	*EventRinging
		+	*EventEstablished
		+	*EventAbandoned
		+	*EventDestinationBusy
		+	*EventDiverted
		+	*EventHeld
		+	*EventNetworkReached
		+	*EventPartyAdded
		+	*EventPartyChanged
		+	*EventPartyDeleted
		+	*EventQueued
		+	*EventBridged
		+	*EventReleased
		+	*EventRetrieved
		+
		+	Topic=voice-callthread
		+	Grouping=Call Routing Events
		+	Events list=
		+	*EventRouteRequest
		+	*EventRouteUsed
		+
		+	Topic=voice-callthread
		+	Grouping=Call Treatment Events
		+	Events list=
		+	*EventTreatmentApplied
		+	*EventTreatmentEnd
		+	*EventTreatmentNotApplied
		+	*EventTreatmentRequired
		+
		+	==Event descriptions==
		+	This section contains event descriptions.
		+
		+	===Agent state and DN events===
		+	Voice Microservices support the agent state and DN events described on this page.