Adapter - NEC-SV-SMDR
This page describes version 2.0.2 of the adapter.
Overview
The NEC-SV-SMDR adapter provides an interface to the NEC SV Station Message Detail Recording (SMDR) TCP/IP port. Please, refer to the SMDR Feature Programming Manual for details. The adapter supports Flexible Format for the SV95 and IMX 2400 Extended Format for the SV93. The adapter handles connection establishment, data reception and release for the connection.
Warning
The link between the adapter and the PBX is NOT encrypted. Therefore, it is strongly recommended that the adapter be installed on an Adapter HUB system local to the PBX.
The adapter, once started, will maintain a connection to the PBX by periodically sending a status monitor message. The adapter status will show Faulted if the connection cannot be maintained or fails to stay connected to the PBX. When the adapter is manually disabled by the user, the adapter will properly send a Link Release Request to the PBX and wait for the PBX to disconnect in order to prevent the PBX from generating SMDR Device error an message.
Note
The PBX will continue to buffer SMDR records even while the adapter is connected and idle.
The adapter supports two commands, Data Request and Data Acknowledge.
Data Request
The data request command sends a text message to the PBX to request SMDR data. If SMDR data is queued in the PBX's internal buffer, the PBX will respond with a block of SMDR records along with a unique sequence value. The sequence value is used to clear the received block of records from the PBX's internal buffer using the following Data Acknowledge command. The optional "Auto-Acknowledge" parameter can be used to automatically respond with a Data Acknowledge after running the Data Request command if desired.
Note
The PBX will continue to send the same block of records if the data is not acknowledged.
Note
The PBX will disconnect after making a request without an acknowledgement 5 times in a row. An error will be returned on the 5th request.
Data Acknowledge
As described above, the Data Acknowledge command must be sent in response to the Data Request command if the "Auto-Acknowledge" parameter is not set in Data Request command.
Adapter Configuration
Properties
| Name | Display | Is Required | Comments | Type | Default Value | Maximum Value | Minimum Value | Maximum Length | Minimum Length |
|---|---|---|---|---|---|---|---|---|---|
| pbxAddress | PBX Address | True | The PBX (LAN2) IP-Address or host name. | string | 1024 | 1 | |||
| smdrPort | TCP Port | True | The PBX TCP port that supports SMDR output. (default: 60010) | integer | 60010 | 65535 | 1 | ||
| deviceId | Device ID | True | The SMDR Device Identifier to use when connecting to the PBX. (0-3) | integer | 3 | 0 |
Commands
Request Data (requestSmdr)
Request SMDR data from PBX.
Request Properties
| Name | Display | Description | Is Required | Type |
|---|---|---|---|---|
| autoAck | Auto-Acknowledge (ACK) | Automatically acknowledge receipt of SMDR block. (Default: false). | False | boolean |
Response Properties
| Name | Description | Type |
|---|---|---|
| status | The general status of the executed command. Typically a success or failure message. | string |
| smdr | An array of SMDR records returned. | array |
| smdr.raw_data | A single raw SMDR record. | string |
| smdr.call_type | The SMDR call type (incoming, outgoing or station). | string |
| smdr.seized_trunk.fusion_point_code | The fusion point code of the seized trunk. | string |
| smdr.seized_trunk.route_number | The route number of the seized trunk. | string |
| smdr.seized_trunk.trunk_number | The trunk number of the seized trunk. | string |
| smdr.seized_trunk.logical_route_number | The logical route number of the seized trunk. | string |
| smdr.physical_calling_party.terminal_id | The physical calling party terminal type (i.e. station, trunk, attendant). | string |
| smdr.physical_calling_party.tenant | The physical calling party tenant number. | string |
| smdr.physical_calling_party.route_number | The physical calling party route number. | string |
| smdr.physical_calling_party.trunk_number | The physical calling party trunk number. | string |
| smdr.physical_calling_party.station_number | The physical calling party station number. | string |
| smdr.physical_calling_party.attendant_console_number | The physical calling party attendant console number. | string |
| smdr.logical_calling_party.fusion_point_code | The logical calling party fusion point code. | string |
| smdr.logical_calling_party.user_group_number | The logical calling party user group number. | string |
| smdr.logical_calling_party.logical_telephone_number | The logical calling party telephone number. | string |
| smdr.logical_calling_party.logical_route_number | The logical calling party route number. | string |
| smdr.physical_called_party.terminal_id | The physical called party terminal type (i.e. station, trunk, attendant). | string |
| smdr.physical_called_party.tenant | The physical called party tenant number. | string |
| smdr.physical_called_party.route_number | The physical called party route number. | string |
| smdr.physical_called_party.trunk_number | The physical called party trunk number. | string |
| smdr.physical_called_party.station_number | The physical called party station number. | string |
| smdr.physical_called_party.attendant_console_number | The physical called party attendant console number. | string |
| smdr.logical_called_party.fusion_point_code | The logical called party fusion point code. | string |
| smdr.logical_called_party.user_group_number | The logical called party user group number. | string |
| smdr.logical_called_party.logical_telephone_number | The logical called party telephone number. | string |
| smdr.logical_called_party.logical_route_number | The logical called party route number. | string |
| smdr.start_time | The start date and time of the call. | string |
| smdr.end_time | The end date and time of the call. | string |
| smdr.connection_time | How long the call was connected. | string |
| smdr.account_code | The account code used to make the call. | string |
| smdr.condition_b.c0.code | The call record condition B, C0 code value. | string |
| smdr.condition_b.c0.description | The call record condition B, C0 code description. | string |
| smdr.condition_b.c1.code | The call record condition B, C1 value. | string |
| smdr.condition_b.c1.description | The call record condition B, C1 code description. | string |
| smdr.condition_b.c2.code | The call record condition B, C2 value. | string |
| smdr.condition_b.c2.description | The call record condition B, C2 code description. | string |
| smdr.alternate_routing.attempted_fusion_point_code | The attempted fusion point code. | string |
| smdr.alternate_routing.attempted_route | The attempted route. | string |
| smdr.alternate_routing.attempted_logical_route | The attempted logical route. | string |
| smdr.alternate_routing.selected_fusion_point_code | The selected fusion point code. | string |
| smdr.alternate_routing.selected_route | The selected route. | string |
| smdr.alternate_routing.selected_logical_route | The selected logical route. | string |
| smdr.dialed_digits | The digits dialed by the originating party. | string |
| smdr.ccis.calling_office_code | The originating CCIS office code. | string |
| smdr.ccis.billing_office_code | The billing CCIS office code . | string |
| smdr.authorization_code | The authorization code for the call. | string |
| smdr.billing.condition_c.code | The billing condition code value. | string |
| smdr.billing.condition_c.description | The billing condition code description. | string |
| smdr.billing.billing_rate | The billing rate metering information for the call. | string |
| smdr.attendant_billing.condition_d.code | The attendant billing condition code value. | string |
| smdr.attendant_billing.condition_d.description | The attendant billing condition code description. | string |
| smdr.group_code | The group code. | string |
| smdr.ani.identifier | The ANI Identifier value. | string |
| smdr.ani.description | The ANI Identifier description | string |
| smdr.ani.calling_telephone_number | The ANI calling party number. | string |
| smdr.conversion_number | The conversion number. | string |
| smdr.ma_id.calling_party_id | The calling party MA-ID. | string |
| smdr.ma_id.seized_trunk_id | The seized trunk MA-ID. | string |
| smdr.trunk_start_time | The date and time the trunk was seized. | string |
Acknowledge Data (ackSmdr)
A client must acknowledge that a block of SMDR records were received so that the PBX can clear the block from it's internal buffer. Otherwise, the same block of records will be received.
Request Properties
| Name | Display | Description | Is Required | Type |
|---|---|---|---|---|
| sequenceId | Sequence ID | The sequence ID of the SMDR block previously received. | True | string |
Release History
| Version | Type | Description | Tracking # | Date |
|---|---|---|---|---|
| 2.0.1 | Initial | First release in the Adapter Type store. | NAP-23000 | |
| 2.0.2 | Maintenance | Updated third-party components and improved maintainability. | NAP-27635 | 2024-07-31 |