No Custom Parameters
Send XSI data to a monitored phone.
JTapiSendXSIData will send XSI data to the monitored phone. A maximum of
2000 bytes can be sent to the phone.
JTapiSendXSIData is supported in Cisco Unified Communications Manager 5.0 and above.
JTapiSendXSIData can send two distinctly different commands to the Cisco IP Phone. One type of command is the
Execute XML object, which is used to cause the phone to execute internal commands, such as
Dial, or to cause the phone to fetch IP Phone XML from an HTTP server.
JTapiSendXSIData can also used to send content-based XML objects, such as a
Menu XML object.
The Cisco IP Phones have an important limitation in that one can only push
2000 bytes of content to the phone. This effectively means that pushing a
Execute XML object to a phone is the more robust way to have the phone render large amounts of data, instead of pushing a potentially large content-based XML object, such as
Menu. With an
Execute XML object, one can send an HTTP-based URI that will server out the content-based XML, circumventing the
2000 byte 'push' limitation. There is no
2000 byte limitation when the phone makes a request to a HTTP-based URI.
SendExecute both allow one to send an XSI command to an IP Phone. To help determine which one is more appropriate, consider the following points:
SendExecuteaction requires an IP address to send the XML command to using an HTTP POST. However, it is a common problem to not have the IP address of a Cisco IP phone readily available, although often one has the device name (of the form SEPXXXXXXXXXXXX) of the phone. While it is possible that one can use the
Cisco DeviceListXcache to determine IP address of a Cisco IP Phone based on this device name, with
JTapiSendXSIDataonly the phone device name is needed.
SendExecutesends an HTTP request from the application server directly to the phone; whereas
JTapiSendXSIDatainstructs Cisco Unified Communications Manager to send the command via the phone's transport protocol. Because of this difference, the
JTapiSendXSIDatacommand is generally more robust when one considers firewalls and security policies. For instance, because IP Communicator runs on the personal computer of an end user, it is possible that the user has a firewall running on that machine. Also, in some Cisco Unified Communication Manager deployments, it is possible that the internal web server on the IP Phone has been turned off, rendering
SendExecuteis executed, the IP phone will request from its configured 'Authentication URL' whether the username and password sent to the phone is valid. By default, this request is sent to the Cisco Unified Communications Manager publisher node, which makes this determination by checking that specified credentials match the credentials of a user associated with the phone in the Cisco Unified Communications Manager database. In contrast, with
JTapiSendXSIData, super user credentials can be used to send commands to any phone, without having to know the enduser associated with that phone.
This action communicates with the Cisco IP Phone using the phone's protocol (SCCP or SIP) as the transport.
|Parameter Name||.NET Type||Default||Description|
|DeviceName *||The name of a controlled device which will be sent the XSI command.|
|XSIData *||The XSI object to be pushed to the monitored device. The object can not be directly passed in to this parameter. Instead, one must invoke the |
|Parameter Name||.NET Type||Description|
|ResultCode||Describes the result of the action with a textual success or error message.|