View table: PEEventAttr
Table structure:
- EventAttr - Wikitext
- AttrShortDesc - Wikitext
- AttrLongDesc - Wikitext
This table has 94 rows altogether.
Page | EventAttr | AttrShortDesc | AttrLongDesc | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Draft:VM/Current/VMEventsandModels/Attributes | Agent ID | This parameter uniquely identifies the ACD agent. | This parameter uniquely identifies the ACD agent. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Draft:VM/Current/VMEventsandModels/Attributes | AgentWorkMode | This attribute indicates the agent/supervisor-related current work mode. | This attribute indicates the agent/supervisor-related current work mode. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Draft:VM/Current/VMEventsandModels/Attributes | ANI | Automatic Number Identification. Indicates the telephony-company charge number. | Automatic Number Identification. Indicates the telephony-company charge number. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Draft:VM/Current/VMEventsandModels/Attributes | CallHistory | Information about transferring/routing of the call through a multisite contact center network. | Information about transferring/routing of the call through a multisite contact center network. Typically used to keep track of a call in multisite contact centers. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Draft:VM/Current/VMEventsandModels/Attributes | CallID | This attribute contains the call identification provided by the switch, which uniquely identifies a call. | This attribute contains the call identification provided by the switch, which uniquely identifies a call. As opposed to ConnID that is assigned by Voice Microservices, CallID is created by the switch when the incoming call arrives, or when agent/system out-dial calls are created. The attribute must be present if the switch generates and distributes the corresponding parameter to Voice Microservices. (CallID is zero as long as the switch does not provide that information to Voice Microservices.) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Draft:VM/Current/VMEventsandModels/Attributes | CallState | The current status of the call the event relates to. | The current status of the call the event relates to. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Draft:VM/Current/VMEventsandModels/Attributes | CallThreadID | The call thread identifier of the call. | The call thread identifier of the call. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Draft:VM/Current/VMEventsandModels/Attributes | CallType | The type of call in question. | The type of call in question. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Draft:VM/Current/VMEventsandModels/Attributes | Cause | For network calls, the reason for transitions to certain states — Routing and NoParty. | For network calls, the reason for transitions to certain states — Routing and NoParty. This helps clarify delivery failure, such as Busy or NoAnswer. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Draft:VM/Current/VMEventsandModels/Attributes | CollectedDigits | A pointer to the digits that have been collected from the calling party. | A pointer to the digits that have been collected from the calling party. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Draft:VM/Current/VMEventsandModels/Attributes | ConnID | A current connection identifier of the call to which this event relates. | A current connection identifier of the call to which this event relates. Connection ID structure
ConnID Parameters Global Server Identifier (bits 2-15): 0 is a global server identifier. Local Connection Identifier (bits 16-63): Local identifier of the call this event relates to. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Draft:VM/Current/VMEventsandModels/Attributes | CustomerID | A pointer to the string containing the assigned Customer (Tenant) identifier through which the processing of the call was initiated. | 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 multitenant contact center. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Draft:VM/Current/VMEventsandModels/Attributes | DNIS | The directory number to which the inbound call has been made. | Directory Number Information Service. The directory number to which the inbound call has been made. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Draft:VM/Current/VMEventsandModels/Attributes | ErrorCode | This attribute contains a value that indicates why a client request failed. | This attribute contains a value that indicates why a client request failed. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Draft:VM/Current/VMEventsandModels/Attributes | ErrorMessage | A pointer to the character string containing additional information about an error. | A pointer to the character string containing additional information about an error. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Draft:VM/Current/VMEventsandModels/Attributes | Extensions | 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. | 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 Events section. Some extensions for requests permit tuning of Voice Microservices operations. If present, the Extensions attribute can include a ReasonCode value specifically used to communicate hardware reasons. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Draft:VM/Current/VMEventsandModels/Attributes | id | The event name. | The event name. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Draft:VM/Current/VMEventsandModels/Attributes | InfoStatus | The InfoType information about the telephony object specified by ThisDN and/or ThisQueue. | The InfoType information about the telephony object specified by ThisDN and/or ThisQueue. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Draft:VM/Current/VMEventsandModels/Attributes | LastCollectedDigit | The last digit collected from the calling party. | The last digit collected from the calling party. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Draft:VM/Current/VMEventsandModels/Attributes | NetworkCallID | In the case of network routing, the call identifier assigned by the switch where the call initially arrived. | In the case of network routing, the call identifier assigned by the switch where the call initially arrived. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Draft:VM/Current/VMEventsandModels/Attributes | NetworkNodeID | In the case of network routing, the identifier of the switch where the call initially arrived. | In the case of network routing, the identifier of the switch where the call initially arrived. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Draft:VM/Current/VMEventsandModels/Attributes | OtherDN | The directory number of the second most significant telephony object (except an ACD group or trunk group) with respect to the event in question. | The directory number of the second most significant telephony object (except an ACD group or trunk group) with respect to the event in question. The application does not have to be registered to this directory number to receive the event in question. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Draft:VM/Current/VMEventsandModels/Attributes | OtherDNRole | The role of the telephony object specified by OtherDN in the event in question. | The role of the telephony object specified by OtherDN in the event in question. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Draft:VM/Current/VMEventsandModels/Attributes | OtherQueue | The directory number of the second most significant ACD group with respect to the event in question. | The directory number of the second most significant ACD group with respect to the event in question. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Draft:VM/Current/VMEventsandModels/Attributes | OtherTrunk | The identifier of the second most significant trunk group with respect to the event in question. | The identifier of the second most significant trunk group with respect to the event in question. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Draft:VM/Current/VMEventsandModels/Attributes | PreviousConnID | This attribute links two associated calls. | This attribute links two associated calls. For example, events related to an original call include the connection ID of a consultation call; events related to a consultation call include the connection ID of the original call. For more information, see ConnID. WARNING: |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Draft:VM/Current/VMEventsandModels/Attributes | Reasons | A pointer to an additional data structure that provides reasons for and results of actions taken by the user of ThisDN. | 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 an event 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. Switch information of a similar nature to the Genesys Reasons attribute is sometimes available, but those switch reasons are passed in the Extensions attribute. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Draft:VM/Current/VMEventsandModels/Attributes | ReferenceID | (Use is internal to Voice Microservices.) ReferenceID is the identifier generated by Voice Microservices or a TSetReferenceID() function call and attached to the request a client sends to Voice Microservices. | (Use is internal to Voice Microservices.) ReferenceID is the identifier generated by Voice Microservices or a TSetReferenceID() function call and attached to the request a client sends to Voice Microservices. Every time a client sends a request to Voice Microservices, it uses the current ReferenceID (increasing it by one each time). In response, Voice Microservices generate an event. The resulting event includes the same ReferenceID that was attached to the request only in the response to the client who initiated the request, as acknowledgment that the request has been fulfilled. If the request fails, EventError is sent only to the requestor. For more information, see the following table, which lists the events in which you will find the ReferenceID corresponding to that found with the request that prompted its assignment initially. ReferenceID in events that correspond to requests
a Only the requestor will receive a notification of the event associated with this request. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Draft:VM/Current/VMEventsandModels/Attributes | Server | A unique identifier assigned by Voice Microservices to the connection between a client and Voice Microservices. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Draft:VM/Current/VMEventsandModels/Attributes | ThirdPartyDN | The directory number of the third most significant telephony object (except an ACD group or trunk group) with respect to the event in question. | The directory number of the third most significant telephony object (except an ACD group or trunk group) with respect to the event in question. The application does not have to be registered to this directory number to receive the event in question. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Draft:VM/Current/VMEventsandModels/Attributes | ThirdPartyDNRole | The role of the telephony object specified by ThirdPartyDN in the event in question. | The role of the telephony object specified by ThirdPartyDN in the event in question. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Draft:VM/Current/VMEventsandModels/Attributes | ThirdPartyQueue | The directory number of the third most significant ACD group with respect to the event in question. | The directory number of the third most significant ACD group with respect to the event in question. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Draft:VM/Current/VMEventsandModels/Attributes | ThisDN | The directory number of the most significant telephony object (except an ACD group or trunk group) with respect to the event in question. | 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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Draft:VM/Current/VMEventsandModels/Attributes | ThisDNRole | The role of the telephony object specified by ThisDN in the event in question. | The role of the telephony object specified by ThisDN in the event in question. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Draft:VM/Current/VMEventsandModels/Attributes | ThisQueue | The directory number of the most significant ACD group with respect to the event in question. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Draft:VM/Current/VMEventsandModels/Attributes | ThisTrunk | The identifier of the most significant trunk with respect to the event in question. | The identifier of the most significant trunk with respect to the event in question. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Draft:VM/Current/VMEventsandModels/Attributes | time | The structure specifies event generation time that is expressed in elapsed seconds and microseconds since 00:00 GMT, January 1, 1970 (zero hour). | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Draft:VM/Current/VMEventsandModels/Attributes | TransferConnID | Containes the ConnID of the call for which transfer or conference was initiated. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Draft:VM/Current/VMEventsandModels/Attributes | TreatmentParms | Contains parameters to be used for the treatment. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Draft:VM/Current/VMEventsandModels/Attributes | TreatmentType | The type of treatment to be applied to the telephony object in question. | The type of treatment to be applied to the telephony object in question. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Draft:VM/Current/VMEventsandModels/Attributes | UserData | Specifies the pointer to the call-related user data. | Specifies the pointer to the call-related user data. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Draft:VM/Current/VMEventsandModels/Event attribute descriptions | Agent ID | 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. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Draft:VM/Current/VMEventsandModels/Event attribute descriptions | AgentWorkMode | This attribute indicates the agent/supervisor-related current work mode. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Draft:VM/Current/VMEventsandModels/Event attribute descriptions | CustomerID | 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. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Draft:VM/Current/VMEventsandModels/Event attribute descriptions | Event | The event identifier. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Draft:VM/Current/VMEventsandModels/Event attribute descriptions | Extensions | This is how you'd have to flag new content 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. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Draft:VM/Current/VMEventsandModels/Event attribute descriptions | Reasons | 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. (Switch information of a similar nature to this Genesys Reasons attribute is sometimes available, but those switch reasons are passed in the Extensions attribute.) |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Draft:VM/Current/VMEventsandModels/Event attribute descriptions | ReferenceID | 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. For additional information, see the ReferenceID in Events That Correspond to Requests table, which lists the events in which you will find the ReferenceID corresponding to that found with the request that prompted its assignment initially. For a limited number of specific requests, as noted in the ReferenceID in Events That Correspond to Requests table, T-Server may send more than one event with the same ReferenceID. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Draft:VM/Current/VMEventsandModels/Event attribute descriptions | Server | 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. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Draft:VM/Current/VMEventsandModels/Event attribute descriptions | ThisDN | 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. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Draft:VM/Current/VMEventsandModels/Event attribute descriptions | ThisQueue | The directory number of the most significant ACD group with respect to the event in question. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Draft:VM/Current/VMEventsandModels/Event attribute descriptions | time | The structure specifies event generation time that is expressed in elapsed seconds and microseconds since 00:00 GMT, January 1, 1970 (zero hour). | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
VM/Current/VMEventsandModels/Attributes | Agent ID | This parameter uniquely identifies the ACD agent. | This parameter uniquely identifies the ACD agent. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
VM/Current/VMEventsandModels/Attributes | AgentWorkMode | This attribute indicates the agent/supervisor-related current work mode. | This attribute indicates the agent/supervisor-related current work mode. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
VM/Current/VMEventsandModels/Attributes | ANI | Automatic Number Identification. Indicates the telephony-company charge number. | Automatic Number Identification. Indicates the telephony-company charge number. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
VM/Current/VMEventsandModels/Attributes | CallHistory | Information about transferring/routing of the call through a multisite contact center network. | Information about transferring/routing of the call through a multisite contact center network. Typically used to keep track of a call in multisite contact centers. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
VM/Current/VMEventsandModels/Attributes | CallID | This attribute contains the call identification provided by the switch, which uniquely identifies a call. | This attribute contains the call identification provided by the switch, which uniquely identifies a call. As opposed to ConnID that is assigned by Voice Microservices, CallID is created by the switch when the incoming call arrives, or when agent/system out-dial calls are created. The attribute must be present if the switch generates and distributes the corresponding parameter to Voice Microservices. (CallID is zero as long as the switch does not provide that information to Voice Microservices.) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
VM/Current/VMEventsandModels/Attributes | CallState | The current status of the call the event relates to. | The current status of the call the event relates to. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
VM/Current/VMEventsandModels/Attributes | CallThreadID | The call thread identifier of the call. | The call thread identifier of the call. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
VM/Current/VMEventsandModels/Attributes | CallType | The type of call in question. | The type of call in question. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
VM/Current/VMEventsandModels/Attributes | Cause | For network calls, the reason for transitions to certain states — Routing and NoParty. | For network calls, the reason for transitions to certain states — Routing and NoParty. This helps clarify delivery failure, such as Busy or NoAnswer. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
VM/Current/VMEventsandModels/Attributes | CollectedDigits | A pointer to the digits that have been collected from the calling party. | A pointer to the digits that have been collected from the calling party. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
VM/Current/VMEventsandModels/Attributes | ConnID | A current connection identifier of the call to which this event relates. | A current connection identifier of the call to which this event relates. Connection ID structure
ConnID Parameters Global Server Identifier (bits 2-15): 0 is a global server identifier. Local Connection Identifier (bits 16-63): Local identifier of the call this event relates to. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
VM/Current/VMEventsandModels/Attributes | CustomerID | A pointer to the string containing the assigned Customer (Tenant) identifier through which the processing of the call was initiated. | 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 multitenant contact center. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
VM/Current/VMEventsandModels/Attributes | DNIS | The directory number to which the inbound call has been made. | Directory Number Information Service. The directory number to which the inbound call has been made. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
VM/Current/VMEventsandModels/Attributes | ErrorCode | This attribute contains a value that indicates why a client request failed. | This attribute contains a value that indicates why a client request failed. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
VM/Current/VMEventsandModels/Attributes | ErrorMessage | A pointer to the character string containing additional information about an error. | A pointer to the character string containing additional information about an error. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
VM/Current/VMEventsandModels/Attributes | Extensions | 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. | 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 Events section. Some extensions for requests permit tuning of Voice Microservices operations. If present, the Extensions attribute can include a ReasonCode value specifically used to communicate hardware reasons. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
VM/Current/VMEventsandModels/Attributes | id | The event name. | The event name. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
VM/Current/VMEventsandModels/Attributes | InfoStatus | The InfoType information about the telephony object specified by ThisDN and/or ThisQueue. | The InfoType information about the telephony object specified by ThisDN and/or ThisQueue. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
VM/Current/VMEventsandModels/Attributes | LastCollectedDigit | The last digit collected from the calling party. | The last digit collected from the calling party. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
VM/Current/VMEventsandModels/Attributes | MonitorNextCallType | Indicates whether to monitor one (MonitorOneCall (0)) or all (MonitorAllCalls (1)) of the next calls. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
VM/Current/VMEventsandModels/Attributes | NetworkCallID | In the case of network routing, the call identifier assigned by the switch where the call initially arrived. | In the case of network routing, the call identifier assigned by the switch where the call initially arrived. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
VM/Current/VMEventsandModels/Attributes | NetworkNodeID | In the case of network routing, the identifier of the switch where the call initially arrived. | In the case of network routing, the identifier of the switch where the call initially arrived. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
VM/Current/VMEventsandModels/Attributes | OtherDN | The directory number of the second most significant telephony object (except an ACD group or trunk group) with respect to the event in question. | The directory number of the second most significant telephony object (except an ACD group or trunk group) with respect to the event in question. The application does not have to be registered to this directory number to receive the event in question. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
VM/Current/VMEventsandModels/Attributes | OtherDNRole | The role of the telephony object specified by OtherDN in the event in question. | The role of the telephony object specified by OtherDN in the event in question. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
VM/Current/VMEventsandModels/Attributes | OtherQueue | The directory number of the second most significant ACD group with respect to the event in question. | The directory number of the second most significant ACD group with respect to the event in question. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
VM/Current/VMEventsandModels/Attributes | OtherTrunk | The identifier of the second most significant trunk group with respect to the event in question. | The identifier of the second most significant trunk group with respect to the event in question. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
VM/Current/VMEventsandModels/Attributes | PreviousConnID | This attribute links two associated calls. | This attribute links two associated calls. For example, events related to an original call include the connection ID of a consultation call; events related to a consultation call include the connection ID of the original call. For more information, see ConnID. WARNING: |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
VM/Current/VMEventsandModels/Attributes | Reasons | A pointer to an additional data structure that provides reasons for and results of actions taken by the user of ThisDN. | 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 an event 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. Switch information of a similar nature to the Genesys Reasons attribute is sometimes available, but those switch reasons are passed in the Extensions attribute. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
VM/Current/VMEventsandModels/Attributes | ReferenceID | (Use is internal to Voice Microservices.) ReferenceID is the identifier generated by Voice Microservices or a TSetReferenceID() function call and attached to the request a client sends to Voice Microservices. | (Use is internal to Voice Microservices.) ReferenceID is the identifier generated by Voice Microservices or a TSetReferenceID() function call and attached to the request a client sends to Voice Microservices. Every time a client sends a request to Voice Microservices, it uses the current ReferenceID (increasing it by one each time). In response, Voice Microservices generate an event. The resulting event includes the same ReferenceID that was attached to the request only in the response to the client who initiated the request, as acknowledgment that the request has been fulfilled. If the request fails, EventError is sent only to the requestor. For more information, see the following table, which lists the events in which you will find the ReferenceID corresponding to that found with the request that prompted its assignment initially. ReferenceID in events that correspond to requests
a Only the requestor will receive a notification of the event associated with this request. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
VM/Current/VMEventsandModels/Attributes | Server | A unique identifier assigned by Voice Microservices to the connection between a client and Voice Microservices. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
VM/Current/VMEventsandModels/Attributes | ThirdPartyDN | The directory number of the third most significant telephony object (except an ACD group or trunk group) with respect to the event in question. | The directory number of the third most significant telephony object (except an ACD group or trunk group) with respect to the event in question. The application does not have to be registered to this directory number to receive the event in question. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
VM/Current/VMEventsandModels/Attributes | ThirdPartyDNRole | The role of the telephony object specified by ThirdPartyDN in the event in question. | The role of the telephony object specified by ThirdPartyDN in the event in question. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
VM/Current/VMEventsandModels/Attributes | ThirdPartyQueue | The directory number of the third most significant ACD group with respect to the event in question. | The directory number of the third most significant ACD group with respect to the event in question. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
VM/Current/VMEventsandModels/Attributes | ThisDN | The directory number of the most significant telephony object (except an ACD group or trunk group) with respect to the event in question. | 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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
VM/Current/VMEventsandModels/Attributes | ThisDNRole | The role of the telephony object specified by ThisDN in the event in question. | The role of the telephony object specified by ThisDN in the event in question. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
VM/Current/VMEventsandModels/Attributes | ThisQueue | The directory number of the most significant ACD group with respect to the event in question. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
VM/Current/VMEventsandModels/Attributes | ThisTrunk | The identifier of the most significant trunk with respect to the event in question. | The identifier of the most significant trunk with respect to the event in question. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
VM/Current/VMEventsandModels/Attributes | time | The structure specifies event generation time that is expressed in elapsed seconds and microseconds since 00:00 GMT, January 1, 1970 (zero hour). | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
VM/Current/VMEventsandModels/Attributes | TransferConnID | Containes the ConnID of the call for which transfer or conference was initiated. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
VM/Current/VMEventsandModels/Attributes | TreatmentParms | Contains parameters to be used for the treatment. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
VM/Current/VMEventsandModels/Attributes | TreatmentType | The type of treatment to be applied to the telephony object in question. | The type of treatment to be applied to the telephony object in question. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
VM/Current/VMEventsandModels/Attributes | UserData | Specifies the pointer to the call-related user data. | Specifies the pointer to the call-related user data. |