1.1.1 Basic Information
XML Interface for Network Services
Local Connections
By default, the 2N® NetSpeaker Server listens on TCP port 6543 on all eth server ports. External applications are connected to this port.
Communication between external applications and the 2N® NetSpeaker Server always starts with the BIND command. This command is sent by the client.
Applications cannot continue communicating until they receive the <bind Status="OK"/> reply from the 2N® NetSpeaker Server. The server thus confirms the connection and creation of a communication channel.
Clients can choose to implement a full XMPP client or to simply run a streaming XML parser, such as the libxml2 Simple API for XML (SAX) parser.
XML Interface
After communication initialisation is completed, the 2N® NetSpeaker Server sends <bind Status="OK"/>. There are two types of XML messages for communication:
The request and response messages define the request-message content using the "<msg Id=" ID information element command, the "<CTI_IE_REFERENCE Ref" tag and IE </msg> termination at the end of message. This type of XML message is used for communication commands and replies from the 2N® NetSpeaker Server. This type of communication is also used for event registration and unregistration of events.
Event messages use the "<CTI_IE_REFERENCE Ref" tag. This type of IE is used for recognition of responses sent asynchronously on events in the 2N® NetSpeaker Server.
Message Request and Response
The 2N® NetSpeaker Server XML interface has two different formats:
Request
<msg Id="command identify">
<CTI_IE_REFERENCE Ref="0x421"/>
<CTI_REQUEST />
</msg>
Response
<msg Id="command identify">
<CTI_IE_REFERENCE Ref="0x421"/>
<CTI_IE_RESULT Result="OK"/>
</msg>
This document also contains XML schemes, which provide details on the incoming and outgoing combinations using the XML request and response.