VM/Current/VMEventsandModels/CallTreatmentEvents - Revision history

WikiSysop at 12:31, July 8, 2022

2022-07-08T12:31:02Z

WikiSysop at 11:45, July 8, 2022

2022-07-08T11:45:48Z

WikiSysop: Created page with "{{ArticleSimplifiedWikiEdit |DisplayName=Call treatment events |Context=Find information about the call treatment events that Voice Microservices produce. }} Call treatment ev..."

2022-06-30T21:16:03Z

Created page with "{{ArticleSimplifiedWikiEdit |DisplayName=Call treatment events |Context=Find information about the call treatment events that Voice Microservices produce. }} Call treatment ev..."

New page

{{ArticleSimplifiedWikiEdit
|DisplayName=Call treatment events
|Context=Find information about the call treatment events that Voice Microservices produce.
}}
Call treatment events are stored in the voice-callthread topic.

Voice Microservices support the following call treatment events, which are described on this page. Click the attribute names in the tables below to see fuller descriptions of the attributes.
{{AnchorDiv|EventList}}
{{ColumnFormat|cols=3|content=
{{#cargo_query:
tables=PEEvent
|fields=CONCAT('[[{{FULLPAGENAME}}#',Event,'|',Event,']]')
|where=_pageName LIKE "{{FULLPAGENAME}}"
|format=ul
}}
}}
{{PEEvent
|Event=EventTreatmentApplied
|EventDesc=The call has been treated and the Treatment Device (TD) is processing the treatment instruction.
|EventGroup=Call treatment
|OptionalAttrs=NetworkCallID, NetworkNodeID, Reasons, ReferenceID, TransferConnID, TransferredNetworkCallID, TransferredNetworkNodeID, TreatmentParms, UserData
|MandatoryAttrs=CallID, CallThreadID, CallType, ConnID, CustomerID, Event, Extensions, Server, ThisDN, ThisDNRole, time, TreatmentType
}}
{{PEEvent
|Event=EventTreatmentEnd
|EventDesc=The call has been treated and the Treatment Device (TD) is waiting for another instruction.

This event does not appear in cases of continuing treatments like <tt>Silence</tt> or <tt>RingBack</tt>.

The '''CollectedDigits''' and '''LastCollectedDigit''' attributes are present if '''TreatmentType''' is either <tt>CollectDigits</tt> or <tt>PlayAnnouncementAndCollectDigits</tt>.

The following key-value pairs are set for all treatment types:
*For all treatment types where an announcement was played, INTERRUPTED is set to:
**NO, if the announcement was not interrupted.
**KEYPAD, if it was interrupted by keypad entry.
**VOICE, if it was interrupted by the caller speaking something.
*For all treatment types where digits are to be collected from the caller, COMPLETION_STATUS is set to:
**NORMAL, if the treatment completed normally (optional).
**TIMEOUT, if the digit collection timed out before all required digits could be collected.
**CANCELLED, if the treatment was cancelled by a request from router.
*For '''TreatmentType'''=<tt>DigitsVerification only</tt>, the following key-value pairs apply:
**VERIFICATION_STATUS (the result of digits verification) is set to 1 if verification succeed, 0 if it did not.
**ATTEMPTS is set to the number of digit-collection attempts made.
*For '''TreatmentType'''=<tt>RecordUserAnnouncement</tt>, the following key-value pair applies:
**USER_ANN_ID is set to the message identifier, an integer, recorded by the user specified with USER_ID.
|EventGroup=Call treatment
|OptionalAttrs=CollectedDigits, Extensions, LastCollectedDigit, NetworkCallID, NetworkNodeID, Reasons, ReferenceID, TransferConnID, TransferredNetworkCallID, TransferredNetworkNodeID, TreatmentParms, UserData
|MandatoryAttrs=CallID, CallThreadID, CallType, ConnID, CustomerID, Event, Server, ThisDN, time, TreatmentType
}}
{{PEEvent
|Event=EventTreatmentNotApplied
|EventDesc=The call has not been treated for some reason. The reason is returned in '''ErrorCode''' and '''ErrorMessage''' parameters.
|EventGroup=Call treatment
|OptionalAttrs=ErrorMessage, Extensions, NetworkCallID, NetworkNodeID, Reasons, TransferConnID, TransferredNetworkCallID, TransferredNetworkNodeID, TreatmentParms, UserData
|MandatoryAttrs=CallID, CallThreadID, CallType, ConnID, CustomerID, ErrorCode, Event, ReferenceID, Server, ThisDN, time, TreatmentType
}}
{{PEEvent
|Event=EventTreatmentRequired
|EventDesc=A call has been placed to a treatment device port specified by '''ThisDN''' and the switch or the treatment device is waiting for treatment instructions.
|EventGroup=Call treatment
|OptionalAttrs=ANI, CustomerID, Extensions, UserData
|MandatoryAttrs=CallID, ConnID, DNIS, Event, Server, ThisDN, time
}}

@@ Line 20: / Line 20: @@
 |EventGroup=Call treatment
 |OptionalAttrs=NetworkCallID, NetworkNodeID, Reasons, ReferenceID, TransferConnID, TransferredNetworkCallID, TransferredNetworkNodeID, TreatmentParms, UserData
-|MandatoryAttrs=CallID, CallThreadID, CallType, ConnID, CustomerID, Event, Extensions, Server, ThisDN, ThisDNRole, time, TreatmentType
+|MandatoryAttrs=CallID, CallThreadID, CallType, ConnID, CustomerID, Extensions, id, Server, ThisDN, ThisDNRole, time, TreatmentType
 }}
 {{PEEvent
@@ Line 46: / Line 46: @@
 |EventGroup=Call treatment
 |OptionalAttrs=CollectedDigits, Extensions, LastCollectedDigit, NetworkCallID, NetworkNodeID, Reasons, ReferenceID, TransferConnID, TransferredNetworkCallID, TransferredNetworkNodeID, TreatmentParms, UserData
-|MandatoryAttrs=CallID, CallThreadID, CallType, ConnID, CustomerID, Event, Server, ThisDN, time, TreatmentType
+|MandatoryAttrs=CallID, CallThreadID, CallType, ConnID, CustomerID, id, Server, ThisDN, time, TreatmentType
 }}
 {{PEEvent
@@ Line 53: / Line 53: @@
 |EventGroup=Call treatment
 |OptionalAttrs=ErrorMessage, Extensions, NetworkCallID, NetworkNodeID, Reasons, TransferConnID, TransferredNetworkCallID, TransferredNetworkNodeID, TreatmentParms, UserData
-|MandatoryAttrs=CallID, CallThreadID, CallType, ConnID, CustomerID, ErrorCode, Event, ReferenceID, Server, ThisDN, time, TreatmentType
+|MandatoryAttrs=CallID, CallThreadID, CallType, ConnID, CustomerID, ErrorCode, id, ReferenceID, Server, ThisDN, time, TreatmentType
 }}