N2IVR (INAP) EDRs
N2IVR (INAP) Application EDRs
The N2IVR solution supports several different control channels, including the ability to perform interaction under control of an INAP SCP, in which case the N2IVR is fulfilling the role of a Specialized Resource Function (INAP SCF).
When doing so, the N2IVR logs the control messaging received over the INAP/CAP signalling channel. These INAP EDRs are written to the same stream as the SIP EDRs, and will be interleaved with them in the EDR files.
The N2IVR INAP EDR Event Types are:
SETUP-ERRINAP-ARIINAP-PAINAP-PA-EINAP-SRRINAP-PACUIINAP-PACUI-RINAP-PACUI-E
Each of these corresponds to a TCAP message exchange between N2IVR and the SCP.
In addition, the N2IVR under INAP-control will also generate:
- SIP EDRs, and
- SIP Logic EDRs, and
- RTP EDRs
Common Format
The configuration parameters for configuring EDR output including filename structure
and location is defined in the configuration documentation for the EdrApp which is
a base component provided by the n2svcd package.
All EDRs are written by the EdrApp application using its file and record formatting rules.
Refer to the n2svcd base documentation for more details on configuring and managing EDR
streams, and on the syntax/encoding details for N-Squared EDRs.
SETUP-ERR EDR
The SETUP-ERR EDR Event is written in cases where the connection could not be setup correctly.
Example:
2023-11-05 00:16:48.900<kirby~IVR~1699141920~1216662f,kirby~Logic~1699141920~12062b6b>SETUP-ERR|REASON=Abandoned
| Field | Type | Description |
|---|---|---|
REASON
|
String | [Required] The reason why the channel setup failed. |
INAP-ARI EDR
The INAP-ARI EDR Event indicates that the IVR sought assistance from an SCP to perform INAP control of the session.
Example:
2018-05-22 03:44:30.191<2771>INAP-ARI|CORRELATION_ID=860|SCCP_DGT_DIGITS=6400123456|SCCP_DGT_NOA=
→ |SCCP_DGT_NP=1|SCCP_DGT_TT=2|SCCP_DPC=4114|SCCP_DRI=0|SCCP_DSSN=106|SCP_ID=1|SIGTRAN_APP=SIGTRAN
| Field | Type | Description |
|---|---|---|
CALL_ID
|
Integer | [Required] The SIP Call ID for the A-Leg associated with this interaction. |
CORRELATION_ID
|
Integer | [Required] The correlation ID from SIP INVITE called-party or other fields. |
SCCP_DGT_DIGITS
|
[0-9A-F]+
|
The SCCP Destination Global Title digits for the SCP, if present. |
SCCP_DGT_NOA
|
Integer | The SCCP Destination Global Title Nature of Address for the SCP, if present. |
SCCP_DGT_NP
|
Integer | The SCCP Destination Global Title Numbering Plan for the SCP, if present. |
SCCP_DGT_TT
|
Integer | The SCCP Destination Global Title Translation Type for the SCP, if present. |
SCCP_DPC
|
Integer | The SCCP Destination Point Code for the SCP, if present. |
SCCP_DRI
|
Integer | [Required] The SCCP Destination Routing Indicator for the SCP. |
SCCP_DSSN
|
Integer | The SCCP Destination Subsystem Number for the SCP, if present. |
SCP_ID
|
[0-9A-F]+
|
[Required] The ID for the SCP selected to handle this call as configured in |
SIGTRAN_APP
|
String | [Required] The internal application name used to route this INAP interaction. |
INAP-PA EDR
The INAP-PA EDR Event indicates that the IVR received a PlayAnnouncement instruction from the INAP SCP controlling this session.
Example:
2018-05-22 03:44:33.268<2771>INAP-PA|MESSAGE_ID=25046|VARIABLE_PARTS=NUMBER:2589
| Field | Type | Description |
|---|---|---|
LANGUAGE_ID
|
Integer | The language ID (if supplied by the SCP) for this interaction in an INAP extension. |
LANGUAGE
|
String | The name of the default or IVR-specified language. |
MESSAGE_ID
|
Integer | The single Elementary Message ID supplied in the interaction request. |
MESSAGE_IDS
|
Array | A sequence of Elementary Message IDs supplied in the interaction request. |
SEQUENCE
|
Integer |
An integer which starts at 1 and increments for each interaction within the call.
|
VARIABLE_PARTS
|
Array |
A sequence of variable parts supplied in the interaction request. Each part is recorded as [Type]:[Value], see details below. |
INAP-PA-E EDR
The INAP-PA-E EDR Event indicates that the IVR sent a PlayAnnouncement-Error to the INAP SCP controlling this session.
Example:
2018-05-22 03:44:33.268<2771>INAP-PA-E|ERROR_CODE=13
| Field | Type | Description |
|---|---|---|
ERROR_CODE
|
Integer | Any of the relevant error codes defined in INAP CS-1. |
INAP-SRR EDR
The INAP-SRR EDR Event indicates that the IVR sent a SpecializedResourceReport to the INAP SCP controlling this session.
Example:
2018-05-22 03:44:33.268<2771>INAP-SRR|
No further EDR fields are supported for this EDR event.
INAP-PACUI EDR
The INAP-PACUI EDR Event indicates that the IVR received a PromptAndCollectUserInformation instruction from the INAP SCP controlling this session.
Example:
2018-05-22 03:44:30.344<2771>INAP-PACUI|INTERRUPTABLE=1|MAX_DIGITS=16|MESSAGE_ID=25126|MIN_DIGITS=4
| Field | Type | Description |
|---|---|---|
CANCEL_DIGIT
|
[0-9A-F]
|
The Cancel Input Digit requested by the SCP for the interaction (if any). |
END_DIGIT
|
[0-9A-F]
|
The End of Input Digit requested by the SCP for the interaction (if any). |
FIRST_DTO
|
Integer |
The timeout in seconds allowed for first digit entry. Can only be present if this is a prompt-and-collect interaction. |
INTER_DTO
|
Integer |
The timeout in seconds allowed for second-or-subsequent digit entry. Can only be present if this is a prompt-and-collect interaction. |
INTERRUPTABLE
|
0/1
|
Can this interraction be interrupted by digit input. Can only be present if this is a prompt-and-collect interaction. |
LANGUAGE_ID
|
Integer | The language ID supplied by the SCP for this interaction in an INAP extension. |
LANGUAGE
|
String | Our mapped internal name for the supplied language ID. |
MAX_DIGITS
|
Integer |
The maximum number of digits which may be entered during this interaction. Can only be present if this is a prompt-and-collect interaction. |
MESSAGE_ID
|
Integer | The single Elementary Message ID supplied in the interaction request. |
MESSAGE_IDS
|
Array | A sequence of Elementary Message IDs supplied in the interaction request. |
MIN_DIGITS
|
Integer |
The minumum number of digits which must be entered during this interaction. Can only be present if this is a prompt-and-collect interaction. |
SEQUENCE
|
Integer |
An integer which starts at 1 and increments for each interaction within the call.
|
VARIABLE_PARTS
|
Array |
A sequence of variable parts supplied in the interaction request. Each part is recorded as [Type]:[Value], see details below. |
INAP-PACUI-R EDR
The INAP-PA EDR Event indicates that the IVR received a PlayAnnouncement instruction from the INAP SCP controlling this session.
Example:
2018-05-22 03:44:33.247<2771>INAP-PACUI-R|COLLECTED_DIGITS=2589|DIGITS_RESPONSE=2589
| Field | Type | Description |
|---|---|---|
COLLECTED_DIGITS
|
[0-9A-D*#]
|
The original digits collected by the IVR from the A-Leg session. Hex Digits will be in upper-case. May contain * and #. |
DIGITS_RESPONSE
|
[0-9A-F]
|
The digits returned to the IVR in the PACUI-Response. Star and Hash are translated to Hex Digits. All Hex Digits will be in upper-case. |
INAP-PACUI-E EDR
The INAP-PACUI-E EDR Event indicates that the IVR sent a PromptAndCollectUserInformation-Error to the INAP SCP controlling this session.
Example:
2018-05-22 03:44:33.268<2771>INAP-PACUI-E|ERROR_CODE=4
| Field | Type | Description |
|---|---|---|
ERROR_CODE
|
Integer | Any of the relevant error codes defined in INAP CS-1. |
Variable Part Types
The VARIABLE_PARTS fields in the INAP-PA and INAP-PACUI event type EDRs are a comma-separated
list of the variable parts to be constructed and played according to the relevant language
Codec construction rules.
Example: VARIABLE_PARTS=NUMBER:2589,INTEGER:3.
The following types of Variable Parts are supported:
| Type | Value | Description |
|---|---|---|
INTEGER
|
Integer | A value in the range 0-214748364. |
NUMBER
|
[0-9A-F]
|
A sequence of hexadecimal digits. Configuration may be used to map two of these digits to * and/or #.
|
TIME
|
<HHMM> | A 24-hour time in HHMM format. |
DATE
|
<YYMMDD> | A date in YYMMDD format. |
PRICE
|
<DDDDDDCC> | A price in cents, without decimal point. |