TrustedSIPPeer Class
This content is no longer actively maintained. It is provided as is, for anyone who may still be using these technologies, with no warranties or claims of accuracy with regard to the most recent product version or service release.
The TrustedSIPPeer class includes members for viewing and modifying trusted SIP peer configuration settings in Speech Server. Instances of the TrustedSIPPeer class on a computer running Speech Server represent the specific SIP peers with which Speech Server can communicate.
Warning
For each instance of TrustedSIPPeer on a computer running Speech Server, there must be a corresponding instance of the SIPPeer class on the computer used for Speech Server administration. If this is not the case, the Speech Server Administrator console on the administration computer might not work properly.
The following syntax is simplified from Managed Object Format (MOF) code.
Syntax
class TrustedSIPPeer
{
????????string Name;
????????string Address;
????????string Type;
????????uint32 TCPPort;
????????uint32 TLSPort;
????????boolean AllowOutboundCalls;
????????boolean AllowTransfers;
????????boolean UseMutualTLS;
};
Methods
The TrustedSIPPeer class has no methods.
Properties
The TrustedSIPPeer class has the following properties.
Name
Data type: string
Specifies the name of the trusted SIP peer.
This property is exposed in the Speech Server Administrator console.
Address
Data type: string
Specifies the address of the trusted SIP peer. It can be the fully qualified domain name (FQDN) or IP address.
Note
Do not begin the last name element of the SIP peer address with a number. For example, 1SIP is not an acceptable address. However, 1SIP.mydomain.com is acceptable.
The default value of Address is localhost. This property is exposed in the Speech Server Administrator console.
Type
Data type: string
Specifies the type of this SIP peer. This property has the following valid string values:
- Default ??? Applies to all SIP peers except Telephony Interface Manager Connector (TIMC).
- TIMC ??? Applies to TIMC only.
This property is exposed in the Speech Server Administrator console.
TCPPort
Data type: uint32
Specifies the IP port number on this trusted SIP peer to use for communication with Speech Server.
The default value of TCPPort is 5060. This property is exposed in the Speech Server Administrator console.
TLSPort
Data type: uint32
Specifies the IP port number on this trusted SIP peer to use for secure communication, using Transport Layer Security (TLS), with Speech Server.
The default value of TLSPort is 5061. This property is exposed in the Speech Server Administrator console.
AllowOutboundCalls
Data type: boolean
Determines whether calls can be originated from Speech Server to the trusted SIP peer. If this property is set to false, all outbound calls, including supervised transfers, are disabled.
The default value of AllowOutboundCalls is false. This property is exposed in the Speech Server Administrator console.
AllowTransfers
Data type: boolean
Determines whether call transfers are allowed between Speech Server and this trusted SIP peer. This property applies to blind (unattended) or supervised (attended) call transfers for this trusted SIP peer.
The default value of AllowTransfers is false. This property is exposed in the Speech Server Administrator console.
UseMutualTLS
Data type: boolean
Data type: boolean
Specifies whether Speech Server expects Mutual TLS (TLS) connections from the SIP peer. If the property is true, you must specify a security certificate for authenticating Speech Server with the SIP peer.
Note
If no SIP peer is configured to use Mutual TLS, calls to and from applications configured to use Secure RTP are declined by Speech Server.
The default value of UseMutualTLS is false. This property is exposed in the Speech Server Administrator console.
Windows Management Instrumentation (WMI) Script Example
strComputer = "."
Set objWMIService = GetObject("winmgmts:\\" & strComputer & "\root\MSSV2")
Set colItems = objWMIService.ExecQuery( _
"SELECT * FROM TrustedSIPPeer",,48)
For Each objItem in colItems
Wscript.Echo "-----------------------------------"
Wscript.Echo "TrustedSIPPeer instance"
Wscript.Echo "-----------------------------------"
Wscript.Echo "Address: " & objItem.Address
Wscript.Echo "AllowOutboundCalls: " & objItem.AllowOutboundCalls
Wscript.Echo "AllowTransfers: " & objItem.AllowTransfers
Wscript.Echo "Name: " & objItem.Name
Wscript.Echo "TCPPort: " & objItem.TCPPort
Wscript.Echo "TLSPort: " & objItem.TLSPort
Wscript.Echo "Type: " & objItem.Type
Wscript.Echo "UseMutualTLS: " & objItem.UseMutualTLS
Next
Requirements
Server: Requires Microsoft Windows Server 2003 with Speech Server
Namespace: Included in \root\mssv2