MCP Metrics

appl_begin

Application Begin

Logged when the VoiceXML application begins.

Format

appl_begin [<name>=<value>[|<name>=<value>...]]
name The name of the parameter. This name is either the name of a Call Manager variable that is sent to the Interpreter when a session is created, INIT_URL (The initial URL), or DEFAULTS (the default page that is used).
value The value of the parameter.

Metrics Id: 130

Examples

  • appl_begin INIT_URL=http://www.voicegenie.com/test.vxml|DEFAULTS=defaults.vxml|ANI=1234|DNIS=1234

appl_end

Application End

Logged when the VoiceXML application comes to an end and the session terminates.

Format

appl_end

Metrics Id: 36

Examples

  • appl_end

asr_trace

ASR Trace

Gives information on ASR events.

Format

asr_trace <event>:<result>
event

This specifies what recognition event has occured:

bargein Currently playing prompts were barged-in with speech.
ASR_DONE User utterance was successfully recognized.
ASR_NOMATCH_WITH_NBEST N-best results were enabled but none of the results were of sufficient confidence or there was an ambiguous match.

result This gives futher information depending on the event. For bargein, it's always "_bargein_". For "ASR_DONE" and "ASR_NOMATCH_WITH_NBEST", it will be the raw recognition results.

Metrics Id: 26

Examples

  • asr_trace bargein:_bargein_
  • asr_trace ASR_DONE:results:+<_gram1>Vancouver|98|<Vancouver>
  • asr_trace ASR_NOMATCH_WITH_NBEST:results:+<_gram1>cinq un|5|<cinq un>

Notes

This metrics entry is also logged by the CMGR and SRM. See the SRM System Reference for the details.

bridge_begin

Bridge Call Begin

This marks the beginning of a 'bridged' call (resulting from use of the transfer tag), recorded when the outbound call has been connected. The data includes dialed number, ANI, UUI, and the owner session (who initiated the call).

Format

bridge_begin <ANI>|<DNIS>|<parent>|<UU>
ANI Automatic Number Identification (if so provisioned); The number from which the user is calling.
DNIS Dialed Number Identification Service; The number dialed by the user.
parent Call ID of the parent inbound call.
UU The User-to-User information passed with the call. This is intended to be represented in IA5 format. Any non-printable data is encoded with 'percent' encoding as defined in RFC 2068. Non-printable data is presented as the hex-equivalent preceded by a percent sign. It will be set to "N/A" if it's not available.

Metrics Id: 3

Examples

  • bridge_begin 4167366493|tel:4167366779;postd=970408|00020023-0C001B58|N/A

bridge_end

Bridge Call End

This record marks the end of a bridged call.

Format

bridge_end <reason>
reason

Disconnection reason. It can be one of:

usrend Session ended because of user hangup
aplend Session ended because of application hangup, including <transfer> maxtime expires.
syserr Session ended because of system error
lmtexc Session ended because <transfer> maxtime expires

Metrics Id: 4

Examples

  • bridge_end usrend

bridge_initiated

Bridge Call Initiated

This marks the initiation of a 'bridged' call (resulting from use of the transfer tag).

Format

bridge_initiated <board ID>:<channel ID>
board ID PSTN board number where incoming call is placed. For VoIP, it is always zero.
channel ID PSTN channel number where incoming call is placed. For VoIP, it is always zero.

Metrics Id: 53

Examples

  • bridge_initiated 101:6

bridge_reject

Bridge Call Rejected

This record is used to indicate that two-leg transfer was initiated but rejected for some reason.

Format

bridge_reject <ANI>|<DNIS>|<parent>|<UU>|<reason>
ANI Automatic Number Identification (if so provisioned); The number from which the user is calling.
DNIS Dialed Number Identification Service; The number dialed by the user.
parent Call ID of the parent inbound call.
UU The User-to-User information passed with the call. This is intended to be represented in IA5 format. Any non-printable data is encoded with 'percent' encoding as defined in RFC 2068. Non-printable data is presented as the hex-equivalent preceded by a percent sign. It will be set to "N/A" if it's not available.
reason

Rejection reason. It can be one of:

badani Bad ANI
baddest Call destination is invalid
badie Bad IE element
busy The called number is busy
error Some error occurred
fax The called number was to a fax machine (with call analysis)
glare Call glare (conflict with an inbound call) occurred
hangup Associated inbound call hung up
ineffectiveother SIT tone ineffectiveother detected
intercept SIT tone intercept detected
interrupt Call was interrupted by the user or platform
networkbusy The network is busy
noanswer Call was not answered or timed out
noautho No authorization for the outbound call
nocircuit SIT tone no circuit detected
nodialtone No dialtone was received (call analysis)
noresource Minimum required resources are not available
noringback No ringback error occurred (call analysis)
operator Operator intercept happened (call analysis)
reorder SIT tone reorder occurred
unknown The attempt failed for an unknown reason
unsupported The network replies unsupported for the request
vacantcode SIT tone vacant code detected

Metrics Id: 5

Examples

  • bridge_reject 4167361234|tel:4167366465|00020023-0C00E41E|N/A|busy

call_appl

Application Name

Logged whenever a <meta> tag with name attribute set to "application" is encountered.

Format

call_appl <appl_name>
appl_name The arbitrary application name as specified with the content attribute of the <meta> tag.

Metrics Id: 12

Examples

  • call_appl XML grammar test

call_begin

Call Begin

This marks an event that an outbound call initiated with a <call> is connected.

Format

call_begin <ANI>|<DNIS>|<parent>|<UU>
ANI Automatic Number Identification (if so provisioned); The number from which the user is calling.
DNIS Dialed Number Identification Service; The number dialed by the user.
parent Call ID of the parent inbound call.
UU The User-to-User information passed with the call. This is intended to be represented in IA5 format. Any non-printable data is encoded with 'percent' encoding as defined in RFC 2068. Non-printable data is presented as the hex-equivalent preceded by a percent sign. It will be set to "N/A" if it's not available.

Metrics Id: 6

Examples

  • call_begin 4167379496|tel:4167379205|00020023-0C00E50B|N/A

call_end

Call End

This record marks the end of an outbound call initiated by <call> tag.

Format

call_end <reason>
reason

Disconnection reason. It can be one of:

usrend Session ended because of user hangup
aplend Session ended because of application hangup, including <call> maxtime expires.
syserr Session ended because of system error
lmtexc Session ended because <transfer> maxtime expires

Metrics Id: 7

Examples

  • call_end usrend

call_initiated

Call Initiated

This marks the initiation of an outbound call by <call> tag.

Format

call_initiated <board ID>:<channel ID>
board ID PSTN board number where incoming call is placed. For VoIP, it is always zero.
channel ID PSTN channel number where incoming call is placed. For VoIP, it is always zero.

Metrics Id: 54

Examples

  • call_initiated 101:6

call_reference

Call Reference

This maps the association between VoiceGenie Call-ID and PSTN channel or SIP-Call-ID.

Format

call_reference <Network ID>
Network ID PSTN channel ID or SIP Call-ID

Metrics Id: 56

Examples

  • call_reference XB01T23
  • call_reference 00020023-080A1371-5060@10.0.0.211

call_reject

Call Rejected

This record is used to indicate that outbound call was initiated but rejected for some reason.

Format

call_reject <ANI>|<DNIS>|<parent>|<UU>|<reason>
ANI Automatic Number Identification (if so provisioned); The number from which the user is calling.
DNIS Dialed Number Identification Service; The number dialed by the user.
parent Call ID of the parent inbound call.
UU The User-to-User information passed with the call. This is intended to be represented in IA5 format. Any non-printable data is encoded with 'percent' encoding as defined in RFC 2068. Non-printable data is presented as the hex-equivalent preceded by a percent sign. It will be set to "N/A" if it's not available.
reason

Rejection reason. It can be one of:

aplend Session ended because of application hangup
badani Bad ANI
baddest Call destination is invalid
badie Bad IE element
busy The called number is busy
error Some error occurred
fax The called number was to a fax machine (with call analysis)
glare Call glare (conflict with an inbound call) occurred
hangup Associated inbound call hung up
ineffectiveother SIT tone ineffectiveother detected
intercept SIT tone intercept detected
interrupt Call was interrupted by the user or platform
networkbusy The network is busy
noanswer Call was not answered or timed out
noautho No authorization for the outbound call
nocircuit SIT tone no circuit detected
nodialtone No dialtone was received (call analysis)
noresource Minimum required resources are not available
noringback No ringback error occurred (call analysis)
operator Operator intercept happened (call analysis)
reorder SIT tone reorder occurred
unknown The attempt failed for an unknown reason
unsupported The network replies unsupported for the request
vacantcode SIT tone vacant code detected

Metrics Id: 8

Examples

  • call_reject 4167361234|tel:4167366465|00020023-0C00E3DE|N/A|busy

choice_select

Choice Select

When a <choice> in a <menu> is selected, the choice phrase and the choice action are logged. The choice action can be a target URL (and possibly an anchor specifying a dialog on that page) of a page that is being transitioned to or an event that is being thrown.

Format

choice_select [<DTMF_digits>]|[<PCDATA>] [next=<target_URL>][event=<event>]
DTMF_digits The DTMF sequence associated with this choice.
PCDATA The PCDATA of the selected choice.
target_URL

The target URL (and possibly an anchor specifying a dialog on that page) of a page that is being transitioned to. It has the following format:

[<URL>][#<dialog_ID>]

Where:

<URL> The URL of the target page.
<dialog_ID> The ID of a <form> or <menu>.

event The event that is being thrown.

Metrics Id: 77

Examples

  • choice_select :3|three next=http://host.com/page.vxml#address_form
  • choice_select :1|one event=one_selected_event

compile_done

Compile Done

The compilation of a fetched VoiceXML page is complete.

Format

compile_done :<URL>
URL The absolute URL of the page.

Metrics Id: 41

Examples

  • compile_done :http://test.voicegenie.com/test.vxml

dtmf

DTMF Input

DTMF input was received.

Format

dtmf <action>:<digits>
action

This specifies how this input will be processed:

input The digits will be counted as recognition input.
bargein The digits will barge-in an on-going prompt playback.
ignored The digits will be ignored because the Interpreter is not in a state to process DTMF input.

digit The sequence of DTMF digits received.

Metrics Id: 27

Examples

  • dtmf input:99
  • dtmf ignored:1

dtmf_end

DTMF Collection End

The collection of DTMF digits ends.

Format

dtmf_end :<reason>
reason

The reason DTMF collection ended. It can be one of:

MATCHED The DTMF sequence matched an active DTMF grammar.
NO_MATCH The DTMF sequence didn't match any active grammars.
NO_INPUT There was no DTMF input within the timeout interval.
NO_DTMF_GRAMMAR No active DTMF grammars within scope.
GRAMMAR_ERROR There's a problem with a DTMF grammar.
INTERNAL_ERROR DTMF collection terminated due to an internal error.
ABORTED DTMF collection aborted due to an event being thrown (e.g. hangup).

Metrics Id: 128

Examples

  • dtmf_end :MATCHED

eval_cond

Condition Evaluated

The result of the evaluation of a condition.

Format

eval_cond :{<condition>}=<result>
condition A Boolean ECMAScript expression.
result The evaluated result of the expression ("true" or "false").

Metrics Id: 44

Examples

  • eval_cond :{reenter == true}=true

eval_expr

Expression Attribute Evaluated

An ECMAScript expression specified in an element attribute was evaluated.

Format

eval_expr <<element>>:<attr>={<expression>}=<value>
element The element that has the attribute. This can be any element that has any attribute that is an expression. Examples are: "FIELD", "AUDIO", "GRAMMAR".
attribute The attribute being evaluated.
expression The expression that is specified with the attribute.
value The evaluation result of the expression.

Metrics Id: 47

Examples

  • eval_expr <SCRIPT>:expr={'utils' + version + '.js'}=utils2.js

eval_script

Script Executed

A <script> element was executed.

Format

eval_script <location>:[<size>][<src>] <outcome>
location

Where the script resides. This can be one of:

inline An inline script.
extern An external script specified by the src attribute.

size The size in characters of the inline script.
src The src attribute of the <script> element. Note that this does not have to be the absolute URL.
outcome

Whether the execution of the script was successful or not.

done The script was executed without problems.
error An error was encountered while executing the script.

Metrics Id: 45

Examples

  • eval_script inline:21 done
  • eval_script extern:domutil.js done
  • eval_script inline:142 error

eval_var

Variable Declaration

A variable has been declared or assigned to using the <var> or <assign> element.

Format

eval_var :<variable>[={<expression>}]=<value>
variable The name of the variable.
expression The expression that is specified in the expr attribute.
value The final value assigned to the variable. The evaluation result of the expression if an expression has been specified, or "undefined" if the variable has just been declared without an expr attribute.

Metrics Id: 46

Examples

  • eval_var :globalvar={41 + 1}=42
  • eval_var :justdeclared=undefined

event

Event Thrown

An event has been thrown.

Format

event <event_name>:<count>[|<message>]
event_name The event that has been thrown.
count The event count associated with this event.
message The message associated with this event.

Metrics Id: 34

Examples

  • event connection.disconnect.hangup:1|Call hang up during FileWaiter
  • event myevent:2

event_handler_enter

Event Handler Enter

An event was caught by an event handler.

Format

event_handler_enter <event_name>|<location>
event_name The event attribute of the <catch> element or the tag name of a <nomatch>, <noinput>, <error> or <help> element. This may or may not be the same as the name of the actual event that is caught.
location

Points to the location in the document where the event handler resides. It has the following format:

[<URL>][#<dialog_ID>[.<form_item_name>]]

Where:

<URL> The URL of the page. This may include a query string.
<dialog_ID> The ID of the <form> or <menu>.
<form_item_name> The name of the form item.

Metrics Id: 80

Examples

  • event_handler_enter :NOINPUT|http://host.com/root.vxml
  • event_handler_enter :myevent|http://host.com/page.vxml#dialog2.field3

event_handler_exit

Event Handler Exit

Whenever the execution of an event handler is complete, this entry is logged. This means that the closing </catch>, </noinput>, etc. tag was reached and the event handler was not left because of a <goto>, <submit>, <throw>, <return>, <exit>, <disconnect> or an event.

Format

event_handler_exit <event_name>
event_name The event attribute of the <catch> element or the tag name of a <nomatch>, <noinput>, <error> or <help> element.

Metrics Id: 81

Examples

  • event_handler_exit :error.connection

exec_error

Execution Error

A fatal problem was encountered during the execution of a page. Note that a blank line may follow this metric.

Format

exec_error (<URL>,[<application>]):<desc>
URL The absolute URL of the page.
application The application name specified by this page.
desc Description of the problem.

Metrics Id: 39

Examples

  • exec_error (http://host.com/non-vxml.xml,):No <vxml> in VXML page

exec_warning

Execution Warning

A non-fatal problem was encountered during the execution of a page.

Format

exec_warning (<URL>,[<application>]):<desc>
URL The absolute URL of the page.
application The application name specified by this page.
desc Description of the problem.

Metrics Id: 40

Examples

  • exec_warning (http://host.com/clear.vxml,):Variable "x" listed in <clear>'s attribute "namelist" is not defined

fetch_end

Resource Fetch Response

Fetch response for a resource (audio, external grammar, external script, XML data). Note that fetch_end is not logged for built-in audio files.

Format

fetch_end <outcome> ([<origin>][<failure_reason>]):<URL>
outcome

The outcome of the fetch. This can be one of:

done Fetch success.
fail Fetch failure.

origin

For a successful fetch, the origin of the response. It can be one of the following:

memory The file was served from the shared memory cache of the Fetching Module.
proxy-hit The file was served from the HTTP proxy (Squid).
proxy-miss Means that the HTTP proxy didn?t have a fresh enough copy and the file was fetched from the application server by the HTTP proxy.
direct Indicates a direct fetch from an application server when the platform is configured to bypass the HTTP proxy.
file Logged for local files (file://...).

failure_reason For a failed fetch, the reason of failure. This may be "timeout", "connect timeout" for https timeout, or "http-error-xxx" where xxx specifies an HTTP status code.
URL The absolute URL of the fetch request.

Metrics Id: 43

Examples

  • fetch_end done (proxy-miss):http://host.com/common/grammar/agent.xml
  • fetch_end done (file):file:///usr/local/samples/hello.vox
  • fetch_end fail (timeout):http://mars.com/stream.cgi
  • fetch_end fail (http-error-404):http://host.com/doesnotexist.wav

fetch_start

Resource Fetch Request

Fetch request for a resource (audio, external grammar, external script, XML data). Note that fetch_start is not logged for built-in audio files.

Format

fetch_start <fetch type>:<URL>
fetch type The resource type of the file to fetch. It can be one of grammar, audio, script, or data.
URL The absolute URL of the page that's being fetched.

Metrics Id: 42

Examples

  • fetch_start data:http://www.example.com/rss/newsfeed.xml

filled_enter

Filled Entered

A <filled> handler has been entered.

Format

filled_enter <mode>[:<form items>]
mode The mode attribute of the <filled>. This can be ALL or ANY.
form items The list of form items that this <filled> has been triggered for.

Metrics Id: 32

Examples

  • filled_enter ALL:pword

filled_exit

Filled Exit

This entry is logged when the execution of a <filled> element is complete. This means that the closing </filled> tag was reached and the <filled> was not left because of a <goto>, <submit>, <throw>, <return>, <exit>, <disconnect> or an event.

Format

filled_exit

Metrics Id: 127

Examples

  • filled_exit

filling

Filling Form Item

Logged when a form item gets filled.

Format

filling :[<Dialog Id>].<Form Item Name>:<Form Item Type>:<Value>
Dialog Id The id attribute of the menu or form, if specified.
Form Item Name The name of the form item.
Form Item Type The type (tag name) of the form item that is being filled. This can be one of FIELD, TRANSFER, RECORD, SUBDIALOG or OBJECT.
Value The value that is used to fill the form item.

Metrics Id: 76

Examples

  • filling :.field1:FIELD:yes

form_enter

Form Entered

Logged when a <form> has been entered.

Format

form_enter [:<ID>]
ID The ID of the form, if specified.

Metrics Id: 28

Examples

  • form_enter
  • form_enter :Welcome

form_exit

Form Exited

The current form has been left either because the FIA cannot find any other items to visit or there has been an internal error.

Format

form_exit <reason>[:<error>]
reason

How the form has been left. This can be:

normal The FIA can't find a form item to visit and the form is left for "natural reasons".
internal_error There has been an internal error.

error The description of the error when reason is internal_error.

Metrics Id: 30

Examples

  • form_exit normal

form_select

Form Item Selected

The FIA has selected a form item to visit.

Format

form_select :<item_name>:<item_type>
item_name The name of the form item. This is an internally generated name if a name hasn't been specified for the item.
item_type The type of the form item. This can be one of FIELD, TRANSFER, RECORD, SUBDIALOG, OBJECT, BLOCK, or INITIAL.

Metrics Id: 29

Examples

  • form_select :pword:FIELD
  • form_select :_tempBlock1:BLOCK

goto

Goto Executed

Transition to another page, dialog or form item.

Format

goto :[<target_URL>][#<dialog_ID>[.<form_item_name>]]
target_URL The absolute URL of the page being transitioned to.
dialog_ID The dialog on the current page or the target page.
form_item_name The form item on the current dialog.

Metrics Id: 33

Examples

  • goto :#exit
  • goto :http://diamond/next.vxml
  • goto :#address_form.city

incall_begin

Inbound Call Begin

This marks the beginning of an inbound call.

Format

incall_begin <DNIS>|<ANI>|<TRAN>|<II>|<UU>|<RDNIS>
DNIS Dialed Number Identification Service; The number dialed by the user.
ANI Automatic Number Identification (if so provisioned); The number from which the user is calling.
TRAN

The transaction identifier. The format of the transaction identifier is:

<yyyy><mm><dd><tttttt><seqno>

Where:

<yyyy> 4 digit year e.g. 2005
<mm> 2 digit month. e.g. 08
<dd> 2 digit day e.g. 20
<tttttt> 6 digit value of time in seconds since 00:00:00 UTC, January 1, 1970, modulo 1000000
<seqno> 3-digit number generated for each user session; incremented for each new call, modulo 1000

II The ISDN Information Digits for the call.
UU The User-to-User information passed with the call. This is intended to be represented in IA5 format. Any non-printable data is encoded with 'percent' encoding as defined in RFC 2068. Non-printable data is presented as the hex-equivalent preceded by a percent sign. It will be set to "N/A" if it's not available.
RDNIS Redirected Dialed Number Identification Service; The number dialed by the user before being re-directed.

Metrics Id: 0

Examples

  • incall_begin sip:2222@diamond:5060|sip:1234@pearl:5060|20050310488528015|N/A|foo|N/A

incall_end

Inbound Call End

This record marks the end of an inbound session. The record specific data indicates the reason for the call end.

Format

incall_end <reason>
reason

Disconnection reason. It can be one of:

usrend Session ended because of user hangup
aplend Session ended because of application hangup
syserr Session ended because of system error

Metrics Id: 1

Examples

  • incall_end usrend

incall_initiated

Inbound Call Initiated

This marks the offering of an inbound call by the network.

Format

incall_initiated <board ID>:<channel ID>
board ID PSTN board number where incoming call is placed. For VoIP, it is always zero.
channel ID PSTN channel number where incoming call is placed. For VoIP, it is always zero.

Metrics Id: 52

Examples

  • incall_initiated 101:23

incall_reject

Inbound Call Rejected

This record is used to indicate that an inbound call has been presented to the platform, but has been rejected for some reason.

Format

incall_reject <DNIS>|<ANI>|<TRAN>|<II>|<UU>|<RDNIS>|<reason>
DNIS Dialed Number Identification Service; The number dialed by the user.
ANI Automatic Number Identification (if so provisioned); The number from which the user is calling.
TRAN The transaction identifier. The format is the same as in incall_begin.
II The ISDN Information Digits for the call.
UU The User-to-User information passed with the call.
RDNIS Redirected Dialed Number Identification Service; The number dialed by the user before being re-directed.
reason

Rejection reason. It can be one of:

badfetch the page could not be fetched
decline the call is declined based on the page (meta tag)
error some error occurred
hangup Associated inbound call hung up
noresource a resource, such as TTS, ASR or requested Application Module, is not available
unknown the attempt failed for an unknown reason
timeout the incoming call is accepted, however the network fails to acknowledge or complete the connection within 10 seconds

Metrics Id: 2

Examples

  • incall_reject sip:4167366779@205.150.90.154;user=phone|sip:205.150.90.78|20060621901817666|N/A|N/A|N/A|timeout

input_end

Input End

Recognition has ended.

Format

input_end [:<phrase>]
phrase The interpretation of the input. If no interpretation is present, the value will be the DTMF sequence for DTMF input or the utterance for speech recognition.

Metrics Id: 25

Examples

  • input_end :10678
  • input_end :paper

input_start

Input Begin

Marks the start of a recognition session.

Format

input_start [:<modes>]
modes

The list of input modes active for this recognition session, delimited by the "|" (pipe) character. These can be:

DTMF DTMF recognition.
VOICE Speech recognition.
TDD TDD/TTY input.

Metrics Id: 24

Examples

  • input_start :VOICE|DTMF

link_triggered

Link Triggered

Logged when a link is triggered in the VoiceXML application.

Format

link_triggered <type>=<URL or event>
type

The type of action taken by the link. It can be one of:

event An event will be thrown
next The link will goto a URL

URL or event The URL that the link is going to or the name of the event thrown due to triggering the link.

Metrics Id: 129

Examples

  • link_triggered next=#form2
  • link_triggered event=myevent

log

Log Executed

<log> element data.

Format

log :<data>
data The contents of the <log> element.

Metrics Id: 35

Examples

  • log :Hello World!

menu_enter

Menu Entered

A <menu> has been entered.

Format

menu_enter [<ID>]
ID The ID of the menu, if specified.

Metrics Id: 31

Examples

  • menu_enter

mrcp_trace

MRCP Trace

The RTSP/MRCP session ID and the MRCP server information

Format

mrcp_trace <event>: <session id> IP: <MRCP server IP> Vendor: <vendor name>
event

This specifies the MRCP session:

RTSPSESSION A RTSP Session is established.
ChannelID A SIP Session is established.

session id It is an string representing a RTSP session
MRCP server IP This is the MRCP server IP address and port number information.
vendor name The MRCP server vendor.

Metrics Id: 132

Examples

  • mrcp_trace RTSPSESSION: d75a96cd_0000054c_44e20460_0dd6_0000 IP: 205.150.90.215:554 Vendor: NUANCE
  • mrcp_trace ChannelID: 78136@speechrecog IP: 10.0.0.120:6075 Vendor: SPEECHWORKS

outcall_begin

Outbound Call Begin

This marks an event that an outbound call initiated with remote dial client is connected.

Format

outcall_begin <ANI>|<DNIS>|<TRAN>|<UU>
ANI Automatic Number Identification (if so provisioned); The number from which the user is calling.
DNIS Dialed Number Identification Service; The number dialed by the user.
TRAN

The transaction identifier. The format of the transaction identifier is:

<yyyy><mm><dd><tttttt><seqno>

Where:

<yyyy> 4 digit year e.g. 2005
<mm> 2 digit month. e.g. 08
<dd> 2 digit day e.g. 20
<tttttt> 6 digit value of time in seconds since 00:00:00 UTC, January 1, 1970, modulo 1000000
<seqno> 3-digit number generated for each user session; incremented for each new call, modulo 1000

UU The User-to-User information passed with the call. This is intended to be represented in IA5 format. Any non-printable data is encoded with 'percent' encoding as defined in RFC 2068. Non-printable data is presented as the hex-equivalent preceded by a percent sign. It will be set to "N/A" if it's not available.

Metrics Id: 9

Examples

  • outcall_begin sip:VoiceGenie@pearl|sip:dialog.vxml.http%3A//host/helloworld.vxml@diamond|20050316986819816|N/A

outcall_end

Outbound Call End

This record marks the end of an outbound call initiated by remote dial client.

Format

outcall_end <reason>
reason

Disconnection reason. It can be one of:

usrend Session ended because of user hangup
aplend Session ended because of application hangup
syserr Session ended because of system error
lmtexc Session ended because <transfer> maxtime expires

Metrics Id: 10

Examples

  • outcall_end usrend

outcall_initiated

Outbound Call Initiated

This marks the initiation of an outbound call by remote dial client. In particular, a channel is selected and the outbound calling request is sent to the network.

Format

outcall_initiated <board ID>:<channel ID>
board ID PSTN board number where incoming call is placed. For VoIP, it is always zero.
channel ID PSTN channel number where incoming call is placed. For VoIP, it is always zero.

Metrics Id: 55

Examples

  • outcall_initiated 101:6

outcall_reject

Outbound Call Rejected

This record is used to indicate that outbound call was initiated but rejected for some reason.

Format

outcall_reject <DNIS>|<ANI>|<TRAN>|<II>|<UU>|<RDNIS>|<reason>
DNIS Dialed Number Identification Service; The number dialed by the user.
ANI Automatic Number Identification (if so provisioned); The number from which the user is calling.
TRAN The transaction identifier. The format is the same as in incall_begin.
II The ISDN Information Digits for the call.
UU The User-to-User information passed with the call.
RDNIS Redirected Dialed Number Identification Service; The number dialed by the user before being re-directed.
reason

Rejection reason. It can be one of:

badani Bad ANI
baddest Call destination is invalid
badfetch the page could not be fetched
badie Bad IE element
busy The called number is busy
decline the call is declined based on the page (meta tag)
error Some error occurred
fax The called number was to a fax machine (with call analysis)
glare Call glare (conflict with an inbound call) occurred
hangup Associated inbound call hung up
ineffectiveother SIT tone ineffectiveother detected
intercept SIT tone intercept detected
interrupt Call was interrupted by the user or platform
machine Called number was to an answering machine (call analysis)
networkbusy The network is busy
noanswer Call was not answered or timed out
noautho No authorization for the outbound call
nocircuit SIT tone no circuit detected
nodialtone No dialtone was received (call analysis)
noresource Minimum required resources are not available
noringback No ringback error occurred (call analysis)
operator Operator intercept happened (call analysis)
reorder SIT tone reorder occurred
unknown The attempt failed for an unknown reason
unsupported The network replies unsupported for the request
vacantcode SIT tone vacant code detected

Metrics Id: 11

Examples

  • outcall_reject sip:VoiceGenie@pearl|sip:dialog.vxml.http%3A//host/helloworld.vxml@diamond|20050316956139646|N/A|error

outcall_requested

Outbound Call Requested

This marks the initiation of an outbound call by remote dial client. The request is not sent to the network and the channel is not selected yet when this entry is logged.

Format

outcall_requested

Metrics Id: 74

Examples

  • outcall_requested

parse_error

Parse Error

Parse error while compiling a VoiceXML page.

Format

parse_error (<URL>,[<application>], line <line>):<desc>
URL The absolute URL of the page.
application The application name specified by this page.
line The line number at which the problem was encountered.
desc Description of the problem.

Metrics Id: 37

Examples

  • parse_error (http://10.0.0.136/cc.vxml,transfer_to_agent, line 33):Exactly one of "aai"("uuidata") or "aaiexpr"("uuidataexpr") may be specified in <transfer>

parse_warning

Parse Warning

Parse warning while compiling a VoiceXML page.

Format

parse_warning (<URL>,[<application>], line <line>):<desc>
URL The absolute URL of the page.
application The application name specified by this page.
line The line number at which the problem was encountered.
desc Description of the problem.

Metrics Id: 38

Examples

  • parse_warning (http://tester/test.vxml,, line 6):unsupported element FIELD in BLOCK

prompt

Prompt Begin

Marks the begining of prompt playback. There will be a single entry even if a queue of multiple prompts is being played.

Format

prompt <filename>[:<type>|<data>[;<type>|<data>...]]
filename The filename for the temporary "prompts file" that is used internally.
type

The type of an individual prompt. This can be one of:

audio An audio file referenced by a URL, a built-in audio or fetch audio.
tts TTS prompt.
value_tts The result of a <value> element being played as TTS, or a <record> form item value (the playback of a recording as an audio file).

data

The data associated with that prompt. This can mean different things for different prompt types:

For audio, it's the absolute URL of the audio file or the part after "builtin:" for built-in audio.

For tts, it's the SSML text.

For value_tts, it has the following format:

<expression>=<value>

Where:

<expression> The expression of a <value> element or the form item name of a <record> element.
<value> The evaluated value of the expression or the full local path, prefixed by a magic string, of the audio file that contains the recording.

Metrics Id: 18

Examples

  • prompt /usr/local/phoneweb/tmp/00020022-101E7410-0001/... ...:audio|default_audio/error.vox;audio|default_audio/goodbye.vox;

prompt (NGI)

Prompt Begin

Marks the begining of prompt playback. There will be a single entry even if a queue of multiple prompts is being played.

Format

prompt (NGI)

Metrics Id: 18

Examples

  • prompt

prompt_end

Prompt End

Playback of prompts has ended.

Format

prompt_end <reason>[:<input>]
reason

Specifies whether the prompt playback was completed or interrupted. It can be one of:

done The prompts were played to completion.
hangup The prompt playback was aborted due to hang up..
error The prompt playback was aborted due to an error.
dtmfbargein The playback of prompts was interrupted by DTMF barge-in.
asrbargein The playback of prompts was interrupted by speech barge-in.

input The input that lead to the barge-in. This could either be a phrase in case of speech input (asrbargein result) or a sequence of DTMF digits in case of DTMF input (dtmfbargein result).

Metrics Id: 19

Examples

  • prompt_end done
  • prompt_end dtmfbargein:9
  • prompt_end asrbargein:stop

prompt_play

Prompt Play

Playback of a single element of the prompt queue. One or more of these metrics occur between a prompt and prompt_end metric.

Format

prompt_play <type>|<data>
type

Specifies the type of auido being played. It can be one of:

mark A mark tag
audio An audio tag
break A break tag
tts SSML
beep A beep
recording A recording

data Details of the specific audio item. This could be a url, an SSML snippet and so on.

Metrics Id: 134

Examples

  • prompt_play audio|http://127.0.0.1/audio/sample.ulaw
  • prompt_play tts|<?xml version="1.0" encoding="UTF-8"?><speak version="1.0" xmlns="http://www.w3.org/2001/10/synthesis" xml:lang="en-US">10.00.</speak>

record_end

Record End

A recording has finished or has been aborted.

Format

record_end :<outcome>[|<data>]
outcome

The outcome of the record operation. Can be one of:

RECORD SUCCESS This indicates that there was audio input before record termination and the <record> element is being filled.
NOINPUT This indicates that there was no audio input within the timeout period.
local grammar match dtmfterm was set to false and the recording was terminated by a local grammar match with the length of the recording being less than the mintime attribute.
global grammar match dtmfterm was set to false and the recording was terminated by a global grammar match.
MINTIME This indicates that the recording was terminated and the length of the recording was less than the mintime attribute.
INTERNAL_ERROR This indicates that when processing the end of a recording an internal error occured.

data

This field provides additional data. The data presented depends on the outcome of the record operation.

If the outcome of the record is RECORD SUCCESS, data is of the form |<term reason>|<duration>|<audio_format>|<filename>.

<term reason>

This indicates the reason the recording was terminated. Possible values are:

DTMF The recording was terminated by DTMF input while dtmfterm was set to true.
MAXTIME The recording was terminated because the audio input duration exceeded maxtime.
FINALSILENCE This means that the audio input was terminated by a period of silence exceeding finalsilence.
HANGUP This means that the audio input was terminated by the user hanging up.
MSG_INTERRUPT This means that the audio input was terminated due to an asynchronous message which was handled immediately.

<duration> This contains the duration (in seconds) of the recording.
<audio_format> This contains the MIME type of the audio format in which the recording was made.
<filename> This contains the local filename where the recording has been saved.

If the outcome of the record is NOINPUT, there may be data present. If data is present, data is of the form MINTIME|dtmf=<dtmf>.

<dtmf> This indicates which dtmf was pressed to terminate the recording or it may be the letter "n" in the case where the recording was terminated because it satisfied the finalsilence condition and the length of the recording was less that the mintime attribute.

If the outcome of the record is MINTIME, data is of the form |<reason>. Reason can be one of:

HANGUP This means that the audio input was terminated by the user hanging up.
MSG_INTERRUPT This means that the audio input was terminated due to an asynchronous message which was handled immediately.

Metrics Id: 21

Examples

  • record_end :RECORD SUCCESS|DTMF|4|audio/vox|/usr/local/tmp/file0001.vox
  • record_end :RECORD SUCCESS|MAXTIME|20|audio/wave|/usr/local/tmp/file0002.vox
  • record_end :NOINPUT
  • record_end :global grammar match

record_start

Record Begin

A <record> element has been executed and recording has started.

Format

record_start :<filename>
filename The local filename where the recording is going to be saved.

Metrics Id: 20

Examples

  • record_start :/usr/local/phoneweb/tmp/00020023-101E744C-0001/...

root_appl

Root Application

The VoiceXML document specifies a root document.

Format

root_appl :<URL>
URL The root application URL as specified in the application attribute of the <vxml> element.

Metrics Id: 79

Examples

  • root_appl :http://darkstar.com/common/root.vxml

subdialog_return

Subdialog End

Returning from a VoiceXML subdialog.

Format

subdialog_return :<name>|<return_type>
name The name of the subdialog.
return_type

This field provides additional data. The data presented depends on what is returned from the subdialog.

If the subdialog returns a namelist, return_type is of the form namelist|[<param_name>;<param_value>;[<param_name>;<param_value>;...]]

<param_name> A parameter being returned from the subdialog
<param_value> The value of the parameter.

If the subdialog returns an event, return_type is of the form event|<event_name>

<event_name> The name of the returned event.

Metrics Id: 23

Examples

  • subdialog_return :GetPIN|namelist|status;OK;realname;Joe;

subdialog_start

Subdialog Begin

Visiting a VoiceXML subdialog.

Format

subdialog_start :<name>:<URL>[#<fragment>] |param|[<param_name>;<param_value>;[<param_name>;<param_value>;...]]
name The name of the subdialog.
URL The URL of the subdialog.
fragment The fragment (dialog ID), if specified.
param_name A parameter being passed to the subdialog.
param_value The value of the parameter.

Metrics Id: 22

Examples

  • subdialog_start :GetPIN:http://diamond/collectpin.vxml |param|user;joe;

submit

Submit

When a <submit> is executed, the URL being transitioned is logged along with submitted parameters, if any.

Format

submit :<target> |namelist|[<name>;<value>;[<name>;<value>...]]
target The URL, dialog and form item being transitioned to.
name The name of a variable that is specified in the namelist attribute.
value The value of the variable.

Metrics Id: 78

Examples

  • submit :http://host.com/page.cgi#entry |namelist|app;45;page;3;
  • submit :#dialog2 |namelist|

transfer_connected

Transfer Connected

This marks the establishment of transfer where the transfer type with the system provides such information.

Format

transfer_connected <ANI>|<DNIS>|<parent>|<UU>
ANI Automatic Number Identification (if so provisioned); The number from which the user is calling.
DNIS Dialed Number Identification Service; The number dialed by the user.
parent Call ID of the parent inbound call.
UU The User-to-User information passed with the call. This is intended to be represented in IA5 format. Any non-printable data is encoded with 'percent' encoding as defined in RFC 2068. Non-printable data is presented as the hex-equivalent preceded by a percent sign. It will be set to "N/A" if it's not available.

Metrics Id: 73

Examples

  • transfer_connected 4167366493|tel:4167366779;postd=970408|00020023-0C001B58|N/A

transfer_end

Transfer End

A transfer has ended with either success or failure.

Format

transfer_end :<outcome>
outcome

The outcome of the transfer. The possible values are:

network_busy Some intermediate network refused the call.
invalid ...
restricted ...
fax ...
machine ...
busy The endpoint refused the call.
noanswer There was no answer within the time specified by the connecttimeout attribute.
rejected Only possible with multiphase transfers (i.e. when consultexpr is set); this result occurs when the child script exits without setting accepttransfer (or with it set to a value other than true).
unknown The outcome of the transfer is unknown.
near_end_disconnect The call was completed and was terminated by the caller.
maxtime_disconnect The call duration exceeded the value of maxtime attribute and was terminated by the platform.
far_end_disconnect The call was completed and was terminated by the callee.
far_end_machine The remote end was deteced as an answer machine using call analysis.

Metrics Id: 14

Examples

  • transfer_end :noanswer

transfer_initiated

Transfer Initiated

This marks the initiation of transfer.

Format

transfer_initiated <board ID>:<channel ID>
board ID PSTN board number where incoming call is placed. For VoIP, it is always zero.
channel ID PSTN channel number where incoming call is placed. For VoIP, it is always zero.

Metrics Id: 72

Examples

  • transfer_initiated 0:0

Notes

For redirect type of transfer, <BOARD ID>:<CHANNEL ID> has the information of the inbound, and for transfers involving outbound call this has the information of the outbound.

transfer_result

Transfer Result

This record is used to indicate that one-leg transfer has completed.

Format

transfer_result <ANI>|<DNIS>|<UU>|<method>|<reason>
ANI Automatic Number Identification (if so provisioned); The number from which the user is calling.
DNIS Dialed Number Identification Service; The number dialed by the user.
UU The User-to-User information passed with the call. This is intended to be represented in IA5 format. Any non-printable data is encoded with 'percent' encoding as defined in RFC 2068. Non-printable data is presented as the hex-equivalent preceded by a percent sign. It will be set to "N/A" if it's not available.
method

Transfer method applied to the network. It can be one of:

bridge/BRIDGE Bridge transfer
h450/H450 H.450-2 blind transfer
h450join/H450JOIN H.450-2 consultative transfer
hkf/HKF Hook flash
inband/INBAND Inband DTMF transfer
mediaredirect/MEDIAREDIRECT Media redirect transfer
refer/REFER SIP refer transfer
referjoin/REFERJOIN SIP refer transfer with replace header

reason

Transfer result. It can be one of:

baddest Call destination is invalid
badie Bad IE element
busy The called number is busy
done Call is successfully transferred
error Some error occurred
fax The called number was to a fax machine (with call analysis)
hangup Associated inbound call hung up
ineffectiveother SIT tone ineffectiveother detected
intercept SIT tone intercept detected
interrupt Call was interrupted by the user or platform
invalidtrigger Invalid trigger for the current call state
lmtexc Outbound call has reached maximum call time
machine Called number was to an answering machine (call analysis)
maxredirects Maximum redirects reached
missingie Missing mandatory IE in ISDN transfer message
networkbusy The network is busy
noanswer Call was not answered or timed out
noautho No authorization for the outbound call
nocircuit SIT tone no circuit detected
nodialtone No dialtone was received
noringback No ringback error occurred
operator Operator intercept happened (call analysis)
reorder SIT tone reorder occurred
resourcelimit Minimum required resources are not available
timeout (For Q.Sig Transfer only) Call was disconnected when network fails to respond withint the configurated time limit, defined by the parameter dlgc.qsigfailontimeout
unknown The attempt failed for an unknown reason
unsupported The network replies unsupported for the request
vacantcode SIT tone vacant code detected

Metrics Id: 15

Examples

  • transfer_result sip:Username@205.150.90.136:5060|sip:XXXX@galahad|N/A|REFER|done

transfer_start

Transfer Start

A transfer element has been executed.

Format

transfer_start :<dest>
dest The transfer destination.

Metrics Id: 13

Examples

  • transfer_start :3333@wizard

wf_arrived

Page Fetch Response

Fetch response for a VoiceXML page

Format

wf_arrived <outcome> ([<origin>][<failure_reason>]):<URL>
outcome

The outcome of the fetch. This can be one of:

s Fetch success.
f Fetch failure.

origin

For a successful fetch, the origin of the response. It can be one of the following:

memory The file was served from the shared memory cache of the Fetching Module.
proxy-hit The file was served from the HTTP proxy (Squid).
proxy-miss Means that the HTTP proxy didn?t have a fresh enough copy and the file was fetched from the application server by the HTTP proxy.
direct Indicates a direct fetch from an application server when the platform is configured to bypass the HTTP proxy.
file Logged for local files (file://...).

failure_reason For a failed fetch, the reason of failure. This may be "timeout", "connect timeout" for https timeout, or "http-error-xxx" where xxx specifies an HTTP status code.
URL The absolute URL of the fetch request.

Metrics Id: 17

Examples

  • wf_arrived s (proxy-miss):http://host.com/test.vxml
  • wf_arrived s (file):file:///usr/local/samples/hello.vxml
  • wf_arrived f (timeout):http://mars.com/slow.cgi
  • wf_arrived f (http-error-404):http://host.com/doesnotexist.vxml

wf_lookup

Page Fetch Request

Fetch request for a VoiceXML page

Format

wf_lookup <URL>
URL The absolute URL of the page that's being fetched.

Metrics Id: 16

Examples

  • wf_lookup http://grass.voicegenie.com/test.vxml