You are here: CSP Developer’s Guide: Internet Protocol > 3 IP Network Interface Series 2 Card > Summary of API Messages

Summary of API Messages

API Messages

The following API messages support the IP Network Interface Series 2 card.

Card Population Query (0x0007)

IP Network Interface Series 2 card and Multi-Function Media
I/O card are supported card types.

Outseize Control (0x002C)/Route Control (0x00E8)

The IP Network Interface Series 2 does not respond to the Outseize Control message until after it receives an answer from the Destination IP Address. If the destination's hardware address cannot be resolved, a negative acknowledgement (NACK) message of 0x24 (Outseize Failed Due To No Answer) is returned.

The host can optionally override the default VoIP Resource Attributes when sending down a Route/Outseize Control message. Please be aware that the list of VoIP Resource Attributes contained in the Generic PPL for VoIP (0x1E) Data ICB is dependent on the resource profile assigned to the Source IP Address. Refer to Chapter 3, VoIP Resource Profiles for more detailed information.

Channel Parameter Query (0x0080)

When querying the channel parameters of a IP Network Interface Series 2 channel, the PPL Protocol Name (Data[18-37]) returned is "VDAC2"

Card Status Query/ Report (0x0083/0x00A6)

The Card Status Query/Report messages support the IP Network Interface Series 2 card, Multi-Function Media I/O card, and IP Network Interface Series 2 VoIP module.

You can address the Card Status Query message to the I/O slot behind the IP Network Interface Series 2 card. The following are possible results:

• If the Multi-Function I/O card is present, the Card Type contains 0xCA.

• If an illegal I/O card is present the Card Type is 0xAA.

• If no I/O card is present the CSP nacked the message with status 0x61-Invalid Slot.

Alarm (0x00B9)

The text includes reference to the IP Network Interface Series 2 card.

Resource Attribute Configure (0x00E3)

Resource Attribute TLVs:

VoIP Resource Profile Assign (0x01E5)

The resource profile assigned to each VoIP module defines the terminal capabilities of the IP endpoint. This includes which VoIP Attributes are configurable, when VoIP Attributes are configurable, and the range of valid values for each VoIP Attribute. Please refer to Chapter 3, VoIP Resource Profiles for more detailed information.

Resource Attribute Query (0x00E4)

VoIP Resource Attribute TLVs:

VoIP Resource Profile Assign (0x01E5)

Querying this TLV results in the requested VoIP Module's VoIP resource profile information being returned.

VoIP Terminal Capabilities (0x01EA)

A module's terminal capabilities can be queried in one of two ways, by Module IP Address or Span/Channel of an active connection. Please refer to Chapter 3, VoIP Resource Profiles for more detailed information.

IP Address Query/Configure (0x00E6/0x00E7)

Ethernet Redundancy is not configurable for IP Network Interface Series 2 card and, therefore, does not support the following TLVs:

Ethernet Link Redundancy (0x09)

Activate Ethernet Port (0x0A)

Internet Protocol. Part of the TCP/IP family of protocols used to route messages and tracks the addresses of nodes.
Outgoing call setup during real-time call processing on a specific channel.
A 32-bit address, used in IP routing, which includes a Network address identifier assigned by a central authority and a Host ID (an end station identifier assigned by a LAN administrator).
Negative acknowledgement to a message.
Voice over Internet Protocol. The delivery of voice information in digital form in discrete packets rather than in the traditional circuit-committed protocols of the public-switched telephone network (PSTN).
See Programmable Protocol Language.
See Information Control Block.
Tag-Length-Value block. A standardized block that allows data to inserted in a standard way into API messages.
Range of channels provided by T1 or E1 transmission service. A physical span is a group of channels taking up a single physical wire. A logical span is a group of channels taking up less than a single logical wire, or carried over more than one physical wire.
The protocol used in most local area PC networks. Typically, most Ethernet networks support data transmission speeds up to 10 Mbps, but 100 Mbps is also possible.
The point in the Excel platform where a DS0 connects to a network. Also known as a "socket."