jtapidevguide_short

94
B-1 Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager Release 7.1(2) OL-18531-01 APPENDIX B Cisco Unified JTAPI Classes and Interfaces This appendix contains a listing of all classes and interfaces that are available in the Cisco Unified JTAPI implementation: Cisco Unified JTAPI Version 1.2 Classes and Interfaces, page B-1, which lists all the JTAPI v 1.2 classes and methods. The supported classes and methods have a check mark in the Cisco Unified JTAPI Support column. Cisco Unified JTAPI Extension Classes and Interfaces, page B-17, which lists the Cisco Unified JTAPI extension classes and methods. Cisco Trace Logging Classes and Interfaces, page B-20, which lists the error tracing classes and methods. Cisco Unified JTAPI Version 1.2 Classes and Interfaces This section includes the following: Core Package, page B-2 Call Center Package, page B-4 Call Center Capabilities Package, page B-6 Call Center Events Package, page B-7 Call Control Package, page B-8 Call Control Capabilities Package, page B-11 Call Control Events Package, page B-12 Capabilities Package, page B-13 Events Package, page B-14 Media Package, page B-15 Media Capabilities Package, page B-16 Media Events Package, page B-16 Unsupported Packages, page B-17

Upload: alex-fulton

Post on 17-Aug-2015

135 views

Category:

Documents


30 download

TRANSCRIPT

Cisco Unified JTAPI Developers Guide for Cisco UnifOL-18531-01

A

P P E N D I X B Cisco Unified JTAPI Classes and Interfaces

This appendix contains a listing of all classes and interfaces that are available in the Cisco Unified JTAPI implementation:

• Cisco Unified JTAPI Version 1.2 Classes and Interfaces, page B-1, which lists all the JTAPI v 1.2 classes and methods. The supported classes and methods have a check mark in the Cisco Unified JTAPI Support column.

• Cisco Unified JTAPI Extension Classes and Interfaces, page B-17, which lists the Cisco Unified JTAPI extension classes and methods.

• Cisco Trace Logging Classes and Interfaces, page B-20, which lists the error tracing classes and methods.

Cisco Unified JTAPI Version 1.2 Classes and InterfacesThis section includes the following:

• Core Package, page B-2

• Call Center Package, page B-4

• Call Center Capabilities Package, page B-6

• Call Center Events Package, page B-7

• Call Control Package, page B-8

• Call Control Capabilities Package, page B-11

• Call Control Events Package, page B-12

• Capabilities Package, page B-13

• Events Package, page B-14

• Media Package, page B-15

• Media Capabilities Package, page B-16

• Media Events Package, page B-16

• Unsupported Packages, page B-17

B-1ied Communications Manager Release 7.1(2)

Appendix B Cisco Unified JTAPI Classes and InterfacesCisco Unified JTAPI Version 1.2 Classes and Interfaces

Core PackageTable B-1 lists each JTAPI interface in the JTAPI Core Package followed by the associated method(s) and whether the classes are supported by the Cisco Unified JTAPI implementation.

Table B-1 Support for javax.telephony

Class Names Method Names

Cisco Unified JTAPI Support Comments

Address addCallObserver Yes

addressObserver Yes

getAddressCapabilities Yes

getCallObservers Yes

getCapabilities Yes

getConnections Yes

getName Yes

getObservers Yes

getProvider Yes

getTerminals Yes

removeCallObserver Yes

removeObserver Yes

AddressObserver addressChangedEvent Yes

Call addObserver Yes

connect Yes A CallObserver must exist for the Terminal or Address originating the call.

The FeaturePriority parameter is not supported.

getCallCapabilities Yes

getCapabilities Yes

getConnections Yes

getObservers Yes

getProvider Yes

getState Yes

removeObserver Yes

CallObserver callChangedEvent Yes

Connection disconnect Yes

getAddress Yes

getCall Yes

getCapabilities Yes

B-2Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager Release 7.1(2)

OL-18531-01

Appendix B Cisco Unified JTAPI Classes and InterfacesCisco Unified JTAPI Version 1.2 Classes and Interfaces

getConnectionCapabilities Yes

getState Yes

getTerminalConnections Yes

JtapiPeer getName Yes

getProvider Yes

getServices Yes

JtapiPeerFactory getJtapiPeer Yes

Provider addObserver Yes

createCall Yes

getAddress Yes

getAddressCapabilities() Yes

getAddressCapabilities(Terminal)

Yes

getAddresses Yes

getCallCapabilities() Yes

getCallCapabilities(Terminal, Address)

Yes

getCalls Yes This method returns calls only when there are CallObservers attached to Addresses or Terminals, when a RouteAddress is registered for routing, or when a CiscoMediaTerminal is registered.

getCapabilities Yes

getConnectionCapabilities() Yes

getConnectionCapabilities(Terminal, Address)

Yes

getName Yes

getObservers Yes

getProviderCapabilities() Yes

getProviderCapabilities(Terminal)

Yes

getState Yes

getTerminal Yes

getTerminalCapabilities() Yes

getTerminalCapabilities(Terminal)

Yes

getTerminalConnectionCapabilities()

Yes

Table B-1 Support for javax.telephony (continued)

B-3Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager Release 7.1(2)

OL-18531-01

Appendix B Cisco Unified JTAPI Classes and InterfacesCisco Unified JTAPI Version 1.2 Classes and Interfaces

Call Center PackageTable B-2 lists each JTAPI interface in the JTAPI Call Center Package followed by the associated method(s) and whether the classes are supported by the Cisco Unified JTAPI implementation.

getTerminalConnectionCapab ilities(Terminal)

Yes

getTerminals Yes

removeObserver Yes

shutdown Yes

ProviderObserver providerChangedEvent Yes

Terminal addCallObserver Yes

addObserver Yes

getAddresses Yes

getCallObservers Yes

getCapabilities Yes

getName Yes

getObservers Yes

getProvider Yes

getTerminalCapabilities Yes

getTerminalConnections Yes

removeCallObserver Yes

removeObserver Yes

TerminalConnection answer Yes

getCapabilities Yes

getConnection Yes

getState Yes

getTerminal Yes

getTerminalConnection Capabilities

Yes

TerminalObserver terminalChangedEvent Yes

Table B-1 Support for javax.telephony (continued)

Table B-2 Support for javax.telephony.callcenter

Class Names Method Names

Cisco Unified JTAPI Suppt Comments

ACDAddress getACDManagerAddress

getLoggedOnAgents

B-4Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager Release 7.1(2)

OL-18531-01

Appendix B Cisco Unified JTAPI Classes and InterfacesCisco Unified JTAPI Version 1.2 Classes and Interfaces

getNumberQueued

getOldestCallQueued

getQueueWaitTime

getRelativeQueueLoad

ACDAddressObserver

ACDConnection getACDManagerConnection

ACDManagerAddress getACDAddresses

ACDManagerConnection getACDConnections

Agent getACDAddress

getAgentAddress

getAgentID

getAgentTerminal

getState

setState

AgentTerminal addAgent

getAgents

removeAgents

setAgents

AgentTerminalObserver

CallCenterAddress addCallObserver

CallCenterCall connectPredictive

getApplicationData

getTrunks

setApplicationData

CallCenterCallObserver

CallCenterProvider getACDAddresses

getACDManagerAddresses

getRouteableAddresses

CallCenterTrunk getCall

getName

getState

getType

RouteAddress cancelRouteCallback Yes

getActiveRouteSessions Yes

getRouteCallback Yes

registerRouteCallback Yes

RouteCallback reRouteEvent Yes

Table B-2 Support for javax.telephony.callcenter (continued)

B-5Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager Release 7.1(2)

OL-18531-01

Appendix B Cisco Unified JTAPI Classes and InterfacesCisco Unified JTAPI Version 1.2 Classes and Interfaces

Call Center Capabilities PackageTable B-3 lists each JTAPI interface in the JTAPI Call Center Capabilities Package followed by the associated method(s), and whether the classes are supported by the Cisco Unified JTAPI implementation.

routeCallbackEndedEvent Yes

routeEndEvent Yes

routeEvent Yes

routeUsedEvent Yes

RouteSession endRoute Yes

getCause Yes

getRouteAddress Yes

getState Yes

selectRoute Yes

Table B-2 Support for javax.telephony.callcenter (continued)

Table B-3 Support for javax.telephony.callcenter.capabilities

Class Names Method Names

Cisco Unified JTAPI Suppt Comments

ACDAddressCapabilities canGetACDManagerAddress

canGetLoggedOnAgents

canGetNumberQueued

canGetOldestCallQueued

canGetQueueWaitTime

canGetRelativeQueueLoad

ACDConnectionCapabilities canGetACDManager Connection

ACDManagerAddress Capabilities

canGetACDAddresses

ACDManagerConnection Capabilities

canGetACDConnections

AgentTerminalCapabilities canHandleAgents

CallCenterAddress Capabilities

canAddCallObserver

CallCenterCallCapabilities canConnectPredictive

canGetTrunks

canHandleApplicationData

CallCenterProvider Capabilities

canGetACDAddresses Yes

B-6Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager Release 7.1(2)

OL-18531-01

Appendix B Cisco Unified JTAPI Classes and InterfacesCisco Unified JTAPI Version 1.2 Classes and Interfaces

Call Center Events PackageTable B-4 lists each JTAPI interface in the JTAPI Call Center Events Package followed by the associated method(s), and whether the classes are supported by the Cisco Unified JTAPI implementation.

canGetACDManagerAddresses

Yes

canGetRouteableAddresses Yes

RouteAddressCapabilities canRouteCalls Yes

Table B-3 Support for javax.telephony.callcenter.capabilities (continued)

Table B-4 Support for javax.telephony.callcenter.events

Class Names Method Names

Cisco Unified JTAPI Suppt Comments

ACDAddrBusyEv

ACDAddrEv getAgent

getAgentAddress

getAgentTerminal

getState

getTrunks

ACDAddrLoggedOffEv

ACDAddrLoggedOnEv

ACDAddrNotReadyEv

ACDAddrReadyEv

ACDAddrUnknownEv

ACDAddrWorkNotReadyEv

ACDAddrWorkReadyEv

AgentTermBusyEv

AgentTermEv getACDAddress

getAgent

getAgentAddress

getAgentID

getState

AgentTermLoggedOffEv

AgentTermLoggedOnEv

AgentTermNotReadyEv

AgentTermReadyEv

AgentTermUnknownEv

B-7Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager Release 7.1(2)

OL-18531-01

Appendix B Cisco Unified JTAPI Classes and InterfacesCisco Unified JTAPI Version 1.2 Classes and Interfaces

Call Control PackageTable B-5 lists each JTAPI interface in the JTAPI Call Control Package followed by the associated method(s) and whether the classes are supported by the Cisco Unified JTAPI Implementation.

AgentTermWorkNotReadyEv

AgentTermWorkReadyEv

CallCentCallAppDataEv getApplicationData

CallCentCallEv getCalledAddress

getCallingAddress

getCallingTerminal

getLastRedirectedAddress

getTrunks

CallCentConnEv

CallCentConnInProgressEv

CallCentEv getCallCenterCause

CallCentTrunkEv getTrunk

CallCentTrunkInvalidEv

CallCentTrunkValidEv

ReRouteEvent Yes

RouteCallbackEndedEvent getRouteAddress Yes

RouteEndEvent Yes

RouteEvent getCallingAddress Yes

getCallingTerminal Yes

getCurrentRouteAddress Yes

getRouteSelectAlgorithm Yes

getSetupInformation Yes

RouteSessionEvent getRouteSession Yes

RouteUsedEvent getCallingAddress Yes

getCallingTerminal Yes

getDomain Yes

getRouteUsed Yes

Table B-4 Support for javax.telephony.callcenter.events (continued)

B-8Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager Release 7.1(2)

OL-18531-01

Appendix B Cisco Unified JTAPI Classes and InterfacesCisco Unified JTAPI Version 1.2 Classes and Interfaces

Table B-5 Support for javax.telephony.callcontrol

Class Names Method Names

Cisco Unified JTAPI Suppt Comments

CallControlAddress cancelForwarding Yes Only for Call Forward All

getDoNotDisturb

getForwarding Yes Only for Call Forward All

getMessageWaiting

setDoNotDisturb

setForwarding Yes Only for Call Forward All

setMessageWaiting

CallControlCall addParty

conference Yes In a consult conference scenario, only OriginalCall.conference (ConsultCall ) is supported. ConsultCall.conference (OriginalCall) is not supported.

consult(TerminalConnection) Yes

consult(TerminalConnection, String)

Yes

drop Yes

getCalledAddress Yes

getCallingAddress Yes

getCallingTerminal Yes

getConferenceController Yes

getConferenceEnable Yes

getLastRedirectedAddress Yes

getTransferController Yes

getTransferEnable Yes

offHook Yes

setConferenceController Yes

setConferenceEnable Yes

setTransferController Yes

setTransferEnable Yes

B-9Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager Release 7.1(2)

OL-18531-01

Appendix B Cisco Unified JTAPI Classes and InterfacesCisco Unified JTAPI Version 1.2 Classes and Interfaces

transfer(Call) Yes In a consult transfer scenario, only OriginalCall.transfer (ConsultCall) is supported. ConsultCall.transfer (OriginalCall) is not supported.

transfer(String) Yes

CallControlCallObserver Yes

CallControlConnection accept Yes

addToAddress Yes

getCallControlState Yes

park Yes

redirect Yes Redirect allows a connection in the CallControlConnection. ESTABLISHED state to be redirected.

reject Yes

CallControlForwarding getDestinationAddress

getFilter

getSpecificCaller

getType

CallControlTerminal getDoNotDisturb

pickup (Address, Address)

pickup (Connection, Address)

pickup (TerminalConnection, Address)

pickupFromGroup(Address)

pickupFromGroup(String, Address)

setDoNotDisturb

CallControlTerminalConnection

getCallControlState Yes

hold Yes

join Yes Only implemented for CiscoIntercomAddresses

leave

Table B-5 Support for javax.telephony.callcontrol (continued)

B-10Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager Release 7.1(2)

OL-18531-01

Appendix B Cisco Unified JTAPI Classes and InterfacesCisco Unified JTAPI Version 1.2 Classes and Interfaces

Call Control Capabilities PackageTable B-6 lists each JTAPI interface in the JTAPI Call Control Capabilities Package followed by the associated method(s) and whether the classes are supported by the Cisco Unified JTAPI implementation.

unhold Yes

CallControlTerminalObserver

Table B-5 Support for javax.telephony.callcontrol (continued)

Table B-6 Support for javax.telephony.callcontrol.capabilities

Class Names Method Names

Cisco Unified JTAPI Suppt Comments

CallControlAddress Capabilities

canCancelForwarding Yes

canGetDoNotDisturb Yes

canGetForwarding Yes

canGetMessageWaiting Yes

canSetDoNotDisturb Yes

canSetForwarding Yes

canSetMessageWaiting Yes

CallControlCallCapabilities canAddParty Yes

canConference Yes

canConsult Yes

canConsult(TerminalConnection)

Yes

canConsult(TerminalConnection, String)

Yes

canDrop Yes

canOffHook Yes

canSetConferenceController Yes

canSetConferenceEnable Yes

canSetTransferController Yes

canSetTransferEnable Yes

canTransfer Yes

canTransfer(Call) Yes

canTransfer(String) Yes

CallControlConnection Capabilities

canAccept Yes

B-11Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager Release 7.1(2)

OL-18531-01

Appendix B Cisco Unified JTAPI Classes and InterfacesCisco Unified JTAPI Version 1.2 Classes and Interfaces

Call Control Events PackageTable B-7 lists each JTAPI interface in the JTAPI Call Control Events Package followed by the associated method(s) and whether the classes are supported by the Cisco Unified JTAPI implementation.

canAddToAddress Yes

canPark Yes

canRedirect Yes

canReject Yes

CallControlTerminal Capabilities

canGetDoNotDisturb Yes

canPickup Yes

canPickup(Address, Address) Yes

canPickup(Connection, Address)

Yes

canPickup(TerminalConnection, Address)

Yes

canPickupFromGroup Yes

canPickupFromGroup(Address) Yes

canPickupFromGroup(String, Address)

Yes

canSetDoNotDisturb Yes

CallControlTerminal ConnectionCapabilities

canHold Yes

canJoin Yes

canLeave Yes

canUnhold Yes

Table B-6 Support for javax.telephony.callcontrol.capabilities (continued)

Table B-7 Support for javax.telephony.callcontrol.events

Class Names Method Names

Cisco Unified JTAPI Suppt Comments

CallCtlAddrDoNotDisturbEv

getDoNotDisturbState

CallCtlAddrEv

CallCtlAddrForwardEv getForwarding Yes

CallCtlAddrMessageWaitingEv

getMessageWaitingState

CallCtlCallEv getCalledState Yes

B-12Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager Release 7.1(2)

OL-18531-01

Appendix B Cisco Unified JTAPI Classes and InterfacesCisco Unified JTAPI Version 1.2 Classes and Interfaces

Capabilities PackageTable B-8 lists each JTAPI interface in the JTAPI Capabilities Package followed by the associated method(s) and whether the classes are supported by the Cisco Unified JTAPI implementation.

getCallingAddress Yes

getCallingTerminal Yes

getLastRedirectedAddress Yes

CallCtlConnAlertingEv Yes

CallCtlConnDialingEv getDigits Yes

CallCtlConnDisconnectedEv Yes

CallCtlConnEstablishedEv Yes

CallCtlConnEv Yes

CallCtlConnFailedEv Yes

CallCtlConnInitiatedEv Yes

CallCtlConnNetworkAlertingEv

Yes

CallCtlConnNetworkReachedEv

Yes

CallCtlConnOfferedEv Yes

CallCtlConnQueuedEv getNumberInQueue Yes

CallCtlConnUnknownEv Yes

CallCtlEv getCallControlCause Yes

CallCtlTermConnBridgedEv

CallCtlTermConnDroppedEv

Yes

CallCtlTermConnEv Yes

CallCtlTermConnHeldEv Yes

CallCtlTermConnInUseEv

CallCtlTermConnRingingEv Yes

CallCtlTermConnTalkingEv Yes

CallCtlTermConnUnknownEv

Yes

CallCtlTermDoNotDisturbEv

CallCtlTermEv

Table B-7 Support for javax.telephony.callcontrol.events (continued)

B-13Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager Release 7.1(2)

OL-18531-01

Appendix B Cisco Unified JTAPI Classes and InterfacesCisco Unified JTAPI Version 1.2 Classes and Interfaces

Events PackageTable B-9 lists each JTAPI interface in the JTAPI Events Package followed by the associated method(s) and whether the classes are supported by the Cisco Unified JTAPI Implementation.

Table B-8 Support for javax.telephony.capabilities

Class Names Method Names

Cisco Unified JTAPI Suppt Comments

AddressCapabilities isObservable Yes

CallCapabilities canConnect Yes

isObservable Yes

ConnectionCapabilities canDisconnect Yes

ProviderCapabilities isObservable Yes

TerminalCapabilities isObservable Yes

TerminalConnection Capabilities

canAnswer Yes

Table B-9 Support for javax.telephony.events

Class Names Method Names

Cisco Unified JTAPI Suppt Comments

AddrEv getAddress Yes

AddrObservationEndedEv Yes

CallActiveEv Yes

CallEv getCall Yes

CallInvalidEv Yes

CallObservationEndedEv getEndedObject Yes

ConnAlertingEv Yes

ConnConnectedEv Yes

ConnCreatedEv Yes

ConnDisconnectedEv Yes

ConnEv getConnection Yes

ConnFailedEv Yes

ConnInProgressEv Yes

ConnUnknownEv Yes

Ev getCause Yes

getID Yes

B-14Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager Release 7.1(2)

OL-18531-01

Appendix B Cisco Unified JTAPI Classes and InterfacesCisco Unified JTAPI Version 1.2 Classes and Interfaces

Media PackageTable B-10 lists each JTAPI interface from the JTAPI Media Package followed by the associated method(s) and whether the classes are supported by the Cisco Unified JTAPI implementation.

getMetaCode Yes

getObserved Yes

isNewMetaEvent Yes

ProvEv getProvider Yes

ProvInServiceEv Yes

ProvObservationEndedEv Yes

ProvOutOfServiceEv Yes

ProvShutdownEv Yes

TermConnActiveEv Yes

TermConnCreatedEv Yes

TermConnDroppedEv Yes

TermConnEvgetTerminal Connection

Yes

TermConnPassiveEv

TermConnRingingEv Yes

TermConnUnknownEv Yes

TermEv getTerminal Yes

TermObservationEndedEv Yes

Table B-9 Support for javax.telephony.events (continued)

Table B-10 Support for javax.telephony.media

Class Names Method Names

Cisco Unified JTAPI Suppt Comments

MediaCallObserver Yes

MediaTerminalConnection generateDtmf Yes

getMediaAvailability

getMediaState

setDtmfDetection Yes

startPlaying

startRecording

stopPlaying

stopRecording

useDefaultMicrophone

B-15Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager Release 7.1(2)

OL-18531-01

Appendix B Cisco Unified JTAPI Classes and InterfacesCisco Unified JTAPI Version 1.2 Classes and Interfaces

Media Capabilities PackageTable B-11 lists each JTAPI interface in the JTAPI Media Capabilities Package followed by the associated method(s) and whether the classes are supported by the Cisco Unified JTAPI implementation.

Media Events PackageTable B-12 lists each JTAPI interface in the JTAPI Media Events Package followed by the associated method(s) and whether the classes are supported by the Cisco Unified JTAPI implementation.

useDefaultSpeaker

usePlayURL

useRecordURL

Table B-10 Support for javax.telephony.media (continued)

Table B-11 Support for javax.telephony.media.capabilities

Class Names Method Names

Cisco Unified JTAPI Suppt Comments

MediaTerminalConnection Capabilities

canDetectDtmf Yes

canGenerateDtmf Yes

canStartPlaying Yes

canStartRecording Yes

canStopPlaying Yes

canStopRecording Yes

canUseDefaultMicrophone Yes

canUseDefaultSpeaker Yes

canUsePlayURL Yes

canUseRecordURL Yes

Table B-12 Support for javax.telephony.media.events

Class Names Method Names

Cisco Unified JTAPI Suppt Comments

MediaEv getMediaCause Yes

MediaTermConnAvailableEv

MediaTermConnDtmfEv getDtmfDigit Yes

B-16Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager Release 7.1(2)

OL-18531-01

Appendix B Cisco Unified JTAPI Classes and InterfacesCisco Unified JTAPI Extension Classes and Interfaces

Unsupported PackagesTable B-13 shows the JTAPI packages that are not supported by the Cisco Unified JTAPI implementation.

Cisco Unified JTAPI Extension Classes and Interfaces

Cisco Unified JTAPI Extension Classes

MediaTermConnEv Yes

MediaTermConnStateEv getMediaState

MediaTermConnUnavailableEv

Table B-12 Support for javax.telephony.media.events (continued)

Table B-13 Unsupported JTAPI Packages

Unsupported JTAPI Packages

JTAPI Phone Package

JTAPI Phone Capabilities Package

JTAPI Phone Events Package

JTAPI Private Data Package

JTAPI Private Data Capabilities Package

JTAPI Private Data Events Package

Table B-14 Cisco Unified JTAPI Extension Classes

Cisco Extension Classes Method Names

CiscoMediaCapability getMaxFramesPerPacket()

getPayloadType()

toString()

CiscoG711MediaCapability

CiscoG723MediaCapability getBitRate()

toString()

CiscoGSMMediaCapability

RegistrationException

UnregistrationException

B-17Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager Release 7.1(2)

OL-18531-01

Appendix B Cisco Unified JTAPI Classes and InterfacesCisco Unified JTAPI Extension Classes and Interfaces

Cisco Unified JTAPI Extension Interfaces

Table B-15 Cisco Unified JTAPI Extension Interfaces and Their Methods

Cisco Extension Interfaces Method Names

CiscoAddrCreatedEv getAddress()

CiscoAddress getType()

CiscoAddressObserver

CiscoAddrEv

CiscoAddrInService

CiscoAddrOutOfService

CiscoCall getCallID()

CiscoCallEv

CiscoCallID getCall()

intValue()

CiscoConferenceEndEv getConferenceCall()

getFinalCall()

getHeldConferenceController()

getTalkingConferenceController()

CiscoConferenceStartEv getConferenceCall()

getFinalCall()

getHeldConferenceController()

getTalkingConferenceController()

CiscoConnection getConnectionID()

getReason()

CiscoConnectionID getConnection()

intValue()

CiscoConsultCall getConsultingTerminalConnection()

CiscoConsultCallActiveEv getHeldTerminalConnection()

CiscoEv

CiscoJtapiPeer

CiscoMediaTerminal getRTPInputProperties()

getRTPOutputProperties()

register(InetAddress, int)

unregister()

CiscoProvEv

B-18Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager Release 7.1(2)

OL-18531-01

Appendix B Cisco Unified JTAPI Classes and InterfacesCisco Unified JTAPI Extension Classes and Interfaces

CiscoProvider getCallbackGuardEnabled()

getMediaTerminal()

getMediaTerminals()

setCallbackGuardEnabled()

CiscoProviderObserver

CiscoRouteSession getCall()

CiscoRTPInputProperties getBitRate()

getEchoCancellation()

getLocalAddress()

getLocalPort()

getPacketSize()

getPayloadType()

CiscoRTPInputStartedEv getRTPInputProperties()

CiscoRTPInputStoppedEv

CiscoRTPOutputProperties getBitRate()

getMaxFramesPerPacket()

getPacketSize()

getPayloadType()

getPrecedenceValue()

getRemoteAddress()

getRemotePort()

CiscoRTPOutputStartedEv getRTPOutputProperties()

CiscoRTPOutputStoppedEv

CiscoSynronousObserver

CiscoTermCreatedEv getTerminal()

CiscoTermEv

CiscoTerminal getRegistrationState()

CiscoTerminalConnection

CiscoTerminalObserver

CiscoTermInServiceEv

CiscoTermOutOfServiceEv

CiscoTransferEndEv getFinalCall()

getTransferController()

getTransferredCall()

Table B-15 Cisco Unified JTAPI Extension Interfaces and Their Methods (continued)

Cisco Extension Interfaces Method Names

B-19Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager Release 7.1(2)

OL-18531-01

Appendix B Cisco Unified JTAPI Classes and InterfacesCisco Trace Logging Classes and Interfaces

Cisco Trace Logging Classes and Interfaces

Cisco Trace Logging Classes

CiscoTransferStartEv getFinalCall()

getTransferController()

getTransferredCall()

ObjectContainer getObject()

setObject()

RTPBitRate

RTPPayload

Table B-16 Cisco Trace Logging Classes

Cisco Trace Logging Class Method Names

LogFileOutputStream close()

flush()

getCurrentFile()

getFileExtension()

getFileNameBase()

getMaxFiles()

getMaxFileSize()

write(byte[], int, int)

write(int)

NullTraceWriter close()

flush()

getEnabled()

print(String)

println(String)

Table B-15 Cisco Unified JTAPI Extension Interfaces and Their Methods (continued)

Cisco Extension Interfaces Method Names

B-20Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager Release 7.1(2)

OL-18531-01

Appendix B Cisco Unified JTAPI Classes and InterfacesCisco Trace Logging Classes and Interfaces

Cisco Trace Logging Interfaces

OutputStreamTraceWriter close()

flush()

getEnabled()

print(String)

println(String)

setOutputStream(OUputStream

TraceManagerFactory getModules()

registerModule(String)

registerModule(TraceModule)

registerModule(TraceModule, OutputStream)

Table B-17 Cisco Trace Logging Interfaces

Cisco Trace Logging Interfaces Method Names

ConditionalTrace disable()

enable()

Trace append(Object)

append(String)

getName()

isEnabled()

print(Object)

print(String)

print(String, Object)

print(String, String)

println(Object)

println(String)

println(String, Object)

println(String, String)

setDefaultMnemonic(String)

Table B-16 Cisco Trace Logging Classes (continued)

Cisco Trace Logging Class Method Names

B-21Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager Release 7.1(2)

OL-18531-01

Appendix B Cisco Unified JTAPI Classes and InterfacesCisco Trace Logging Classes and Interfaces

TraceManager disableAll()

disableTimeStamp()

enableAll()

enableTimeStamp()

getConditionalTrace(String)

getConditionalTrace(String, String)

getName()

getOutputStream()

getSubFacilities()

getTraces()

getTraceWriter()

getUnconditionalTrace(String)

getUnconditionalTrace(String, String)

removeTrace(String)

removeTrace(Trace)

setOutputStream(OutputStream)

setSubFacilities()

setTraceWriter()

TraceModule getTraceManager()

getTraceModuleName()

TRACETYPE

TraceWriter close()

flush()

getEnabled()

print(String)

println(String)

UnconditionalTrace

Table B-17 Cisco Trace Logging Interfaces (continued)

Cisco Trace Logging Interfaces Method Names

B-22Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager Release 7.1(2)

OL-18531-01

Cisco Unified JTAPI Developers Guide for Cisco UnifOL-18531-01

A

P P E N D I X C Troubleshooting Cisco Unified JTAPI

This appendix contains CTI Error Codes, CiscoEvent IDs, and other information to assist with troubleshooting efforts. It contains:

• CTI Error Codes, page C-1

• CiscoEventIDs, page C-10

• Reason Codes, page C-12

• Cause Codes, page C-13

• Additional Troubleshooting Information, page C-17

CTI Error Codes

Error Code Description

ASSOCIATED_LINE_NOT_OPEN This error indicates that the request is issued on a line, which is not open

CALL_ALREADY_EXISTS This error indicates that another call already exists on the line

CALL_DROPPED The call dropped after the feature request (hold, unhold, transfer, or conference) but before the request was completed.

CALLHANDLE_NOTINCOMINGCALL This error indicates that an attempt is made to answer a call that either does not exist or is not in the correct state

CALLHANDLE_UNKNOWN_TO_LINECONTROL This error indicates that attempt to redirect call that was unknown to line control

CANNOT_OPEN_DEVICE This error indicates that device open failed because the associated device is unregistering

CANNOT_TERMINATE_MEDIA_ON_PHONE This error indicates that media cannot be terminated by an application when the device is a physical phone (the phone always terminates the media)

CFWDALL_ALREADY_SET This error indicates that attempt to set CFWALL while it is already set

C-1ied Communications Manager Release 7.1(2)

Appendix C Troubleshooting Cisco Unified JTAPICTI Error Codes

CFWDALL_DESTN_INVALID This error indicates that attempt to CFWALL to an invalid destination

CLUSTER_LINK_FAILURE This error indicates that link to one of the cisco unified communications managers failed in the cluster (network error)

COMMAND_NOT_IMPLEMENTED_ON_DEVICE This error indicates that device does not support the command.

CONFERENCE_ALREADY_PRESENT This error indicates that attempt to conference a party that is already in conference

CONFERENCE_FAILED This error indicates that conference completion was not successful.

CONFERENCE_FULL This error indicates that all conference bridges are busy.

CONFERENCE_INACTIVE This error indicates that attempt to complete conference while consult conference is not active

CONFERENCE_INVALID_PARTICIPANT This error indicates that an attempt to conference to self or an invalid participant

CTIERR_ACCESS_TO_DEVICE_DENIED This error indicates that the access to device is denied.

CTIERR_APP_SOFTKEYS_ALREADY_CONTROLLED This error indicates that the application softkeys are already controlled by another application

CTIERR_APPLICATION_DATA_SIZE_EXCEEDED This error indicates that application data size has exceeded limit

CTIERR_BIB_NOT_CONFIGURED This error indicates built in bridge is not configured

CTIERR_BIB_RESOURCE_NOT_AVAILABLE This error indicates that built in bridge resource not available

CTIERR_CALL_MANAGER_NOT_AVAILABLE This error indicates that Communications Manager is not available currently

CTIERR_CALL_NOT_EXISTED This error indicates that call does not exist

CTIERR_CALL_PARK_NO_DN This error indicates no call park DN

CTIERR_CALL_REQUEST_ALREADY_OUTSTANDING This error indicates call request already outstanding

CTIERR_CALL_UNPARK_FAILED This error indicates that call unpark did not succeed

CTIERR_CAPABILITIES_DO_NOT_MATCH This error indicates that capabilities do not match

CTIERR_CLOSE_DELAY_NOT_SUPPORTED_WITH_ REG_TYPE

This error indicates that the close delay is not supported with this registration type

CTIERR_CONFERENCE_ALREADY_EXISTED This error indicates that conference already exists

CTIERR_CONFERENCE_NOT_EXISTED This error indicates that conference does not exist

CTIERR_CONNECTION_ON_INVALID_PORT This error indicates application is trying to connect to invalid port

CTIERR_CONSULT_CALL_FAILURE This error indicates consult call failure

CTIERR_CONSULTCALL_ALREADY_OUTSTANDING This error indicates that consult call already outstanding

CTIERR_CRYPTO_CAPABILITY_MISMATCH This error indicates that device registration failed as device crypto algorithms does not match with current device registration

Error Code Description

C-2Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager Release 7.1(2)

OL-18531-01

Appendix C Troubleshooting Cisco Unified JTAPICTI Error Codes

CTIERR_CTIHANDLER_PROCESS_CREATION_FAILED This error indicates that CTIHandler process creation failed

CTIERR_DB_INITIALIZATION_ERROR This error indicates DB initialization error

CTIERR_DEVICE_ALREADY_OPENED This error indicates that device is already opened

CTIERR_DEVICE_NOT_OPENED_YET This error indicates that device is not yet opened

CTIERR_DEVICE_OWNER_ALIVE_TIMER_STARTED This error indicates that there is a device registration failure

CTIERR_DEVICE_REGISTRATION_FAILED_NOT_ SUPPORTED_MEDIATYPE

This error indicates an invalid media type, CTIPort need to be registered with Dynamic media port registation if it has an intercom line

CTIERR_DEVICE_RESTRICTED This error indicates that the device is restricted

CTIERR_DEVICE_SHUTTING_DOWN This error indicates that device is shutting down

CTIERR_DIRECTORY_LOGIN_TIMEOUT This error indicates that there is a directory login time out

CTIERR_DUPLICATE_CALL_REFERENCE This error indicates duplicate call reference

CTIERR_DYNREG_IPADDRMODE_MISMATCH This indicates registration failure when Cisco Media/Route Tterminal is already registered with different Addressing mode

CTIERR_FAC_CMC_REASON_CMC_INVALID Client Matter Code (CMC) entered is invalid

CTIERR_FAC_CMC_REASON_CMC_NEEDED CMC is required to offer the call

CTIERR_FAC_CMC_REASON_FAC_CMC_NEEDED Forced Authorization Code (FAC) and CMC are required to offer call

CTIERR_FAC_CMC_REASON_FAC_INVALID FAC entered is invalid

CTIERR_FAC_CMC_REASON_FAC_NEEDED FAC is required to offer the call

CTIERR_FEATURE_ALREADY_REGISTERED This error indicates feature already registered

CTIERR_FEATURE_DATA_REJECT This error indicates feature data reject

CTIERR_FEATURE_SELECT_FAILED This error indicates that feature select failed

CTIERR_ILLEGAL_DEVICE_TYPE This error indicates that the device type is illegal

CTIERR_INCOMPATIBLE_AUTOINSTALL_PROTOCOL_ VERSION

This error indicates that auto install protocol version is incompatible

CTIERR_INCORRECT_MEDIA_CAPABILITY Device registration failed due to incorrect media capability

CTIERR_INFORMATION_NOT_AVAILABLE This error indicates that information is not available

CTIERR_INTERCOM_SPEEDDIAL_ALREADY_CONFIGURED

This error indicates that intercom target value is already configured, application is trying to make call with Intercom target DN

CTIERR_INTERCOM_SPEEDDIAL_ALREADY_SET This error indicates that intercom request failed as intercom target value is already set, application is trying to set again

CTIERR_INTERCOM_SPEEDDIAL_DESTN_INVALID This error indicates that intercomm request failed as intercom target value in not in the intercom group

Error Code Description

C-3Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager Release 7.1(2)

OL-18531-01

Appendix C Troubleshooting Cisco Unified JTAPICTI Error Codes

CTIERR_INTERCOM_TALKBACK_ALREADY_PENDING This error indicates that intercom talk back request is already pending

CTIERR_INTERCOM_TALKBACK_FAILURE This error indicates that talkback request failed for some reason

CTIERR_INTERNAL_FAILURE This error indicates there is a CTI internal failure

CTIERR_INVALID_CALLID This error indicates the call ID is invalid

CTIERR_INVALID_DEVICE_NAME This error indicates that the device name is not valid

CTIERR_INVALID_DTMFDIGITS Play DTMF request failed because it is an invalid DTMF digit

CTIERR_INVALID_FILTER_SIZE This error indicates that filter size is invalid

CTIERR_INVALID_MEDIA_DEVICE This error indicates that the media device is not valid

CTIERR_INVALID_MEDIA_PARAMETER This error indicates media parameter is invalid

CTIERR_INVALID_MEDIA_PROCESS This error indicates that there is an invalid media process

CTIERR_INVALID_MEDIA_RESOURCE_ID This error indicates media resource ID is not valid

CTIERR_INVALID_MESSAGE_HEADER_INFO This error indicates that the header info is not valid

CTIERR_INVALID_MESSAGE_LENGTH This error indicates that message length is invalid

CTIERR_INVALID_MONITOR_DESTN This error indicates monitoring request failed due to invalid monitoring destination

CTIERR_INVALID_MONITOR_DN_TYPE This error indicates an invalid monitor DN type

CTIERR_INVALID_MONITORMODE This error indicates monitor request failed due to an invalid monitor mode

CTIERR_INVALID_PARAMETER This error indicates that the parameter is not valid

CTIERR_INVALID_PARK_DN This error indicates that the DN is an invalid park DN

CTIERR_INVALID_PARK_REGISTRATION_HANDLE This error indicates that the handle is an invalid park registration handle

CTIERR_INVALID_RESOURCE_TYPE This error indicates an invalid resource type

CTIERR_IPADDRMODE_MISMATCH This indicates the registration failure due to IP Addressing Mode mismatch.

CTIERR_LINE_OUT_OF_SERVICE This error indicates that line is out of service.

CTIERR_LINE_RESTRICTED This er ror indicates that the line is restricted

CTIERR_MAXCALL_LIMIT_REACHED This error indicates that maximum call limit has reached

CTIERR_MEDIA_ALREADY_TERMINATED_DYNAMIC This error indicates that device registration failed as device is registered with Dynamic media termination

CTIERR_MEDIA_ALREADY_TERMINATED_NONE This error indicates that device registration failed as device is already registered with media termination none

CTIERR_MEDIA_ALREADY_TERMINATED_STATIC This error indicates that device registration failed as device is registered with Static media termination

Error Code Description

C-4Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager Release 7.1(2)

OL-18531-01

Appendix C Troubleshooting Cisco Unified JTAPICTI Error Codes

CTIERR_MEDIA_CAPABILITY_MISMATCH This error indicates that device registration failed as media capability of device does not match with current device registration

CTIERR_MEDIA_RESOURCE_NAME_SIZE_EXCEEDED This error indicates that media resource name size has exceeded limit

CTIERR_MEDIAREGISTRATIONTYPE_DO_NOT_MATCH This error indicates that media registration types do not match

CTIERR_MESSAGE_TOO_BIG This error indicates that message is too big

CTIERR_MORE_ACTIVE_CALLS_THAN_RESERVED This error indicates that there are more active calls than reserved

CTIERR_NO_EXISTING_CALLS This error indicates there are no existing calls

CTIERR_NO_EXISTING_CONFERENCE This error indicates that there is no existing conference

CTIERR_NO_RECORDING_SESSION This error indicates recording request failed as there is no recording session

CTIERR_NO_RESPONSE_FROM_MP This error indicates no response from media resource

CTIERR_NOT_PRESERVED_CALL This error indicates that the call is not preserved

CTIERR_OPERATION_FAILED_QUIETCLEAR This error indicates that feature unavailable for this call due to temporary failure

CTIERR_OPERATION_NOT_ALLOWED This error indicates that this operation is not allowed

CTIERR_OUT_OF_BANDWIDTH This error indicates out of bandwidth error

CTIERR_OWNER_NOT_ALIVE This error indicates a failure during registering the device

CTIERR_PENDING_ACCEPT_OR_ANSWER_REQUEST This error indicates that there is a pending accept or answer request

CTIERR_PENDING_START_MONITORING_REQUEST This error indicates there is a pending start monitoring request

CTIERR_PENDING_START_RECORDING_REQUEST This error indicates there is a pending start recording request

CTIERR_PENDING_STOP_RECORDING_REQUEST This error indicates there is a pending stop recording request

CTIERR_PRIMARY_CALL_INVALID This error indicates that primary call in monitoring request in invalid or gone idle

CTIERR_PRIMARY_CALL_STATE_INVALID This error indicates that primary call in monitoring request is in invalid state

CTIERR_RECORDING_ALREADY_INPROGRESS This error indicates recording request failed that recording is already in progress

CTIERR_RECORDING_CONFIG_NOT_MATCHING This error indicates recording configuration does not match

CTIERR_RECORDING_SESSION_INACTIVE This error indicates recording request failed because recording session is inactive

CTIERR_REDIRECT_UNAUTHORIZED_COMMAND_USAGE This error indicates a redirect unauthorized command usage

Error Code Description

C-5Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager Release 7.1(2)

OL-18531-01

Appendix C Troubleshooting Cisco Unified JTAPICTI Error Codes

CTIERR_REGISTER_FEATURE_ACTIVATION_FAILED This error indicates that register feature activation failed

CTIERR_REGISTER_FEATURE_APP_ALREADY_ REGISTERED

Register feature application was already registered

CTIERR_REGISTER_FEATURE_PROVIDER_NOT_ REGISTERED

Register feature provider was not registered.

CTIERR_RESOURCE_NOT_AVAILABLE This error indicates that resource is not available to fulfill the request

CTIERR_START_MONITORING_FAILED This error indicates that start monitoring request failed

CTIERR_START_RECORDING_FAILED This error indicates that start recording request failed

CTIERR_STATION_SHUT_DOWN This error indicates that there is a station shutdown

CTIERR_SYSTEM_ERROR This error indicates CTI system error

CTIERR_UDP_PASS_THROUGH_NOT_SUPPORTED This error indicates UDP data passthrough not supported

CTIERR_UNKNOWN_EXCEPTION This error indicates an unknown exception occured

CTIERR_UNSUPPORTED_CALL_PARK_TYPE This error indicates that call park type is not supported

CTIERR_UNSUPPORTED_CFWD_TYPE This error indicates that the call forward type is unsupported

CTIERR_USER_NOT_AUTH_FOR_SECURITY This error indicates user is not authorized for secure connection

DARES_INVALID_REQ_TYPE This error indicates that there is an internal call processing error: DaRes invalid request type

DATA_SIZE_LIMIT_EXCEEDED This error indicates that XML data object size is bigger than allowed.

DB_ERROR This error indicates that the device query contained an illegal device type

DB_ILLEGAL_DEVICE_TYPE This error indicates illegal device type in DB

DB_NO_MORE_DEVICES This error is no longer used.

DESTINATION_BUSY This error indicates that destination is busy

DESTINATION_UNKNOWN This error indicates that destination is not found

DEVICE_ALREADY_REGISTERED This error indicates that device registration attempt failed, because the device is already registered

DEVICE_NOT_OPEN This error indicates that an attempt to open a line failed, as the device is not opened or the device is not registered.

DEVICE_OUT_OF_SERVICE This error indicates that device is out of service.

DIGIT_GENERATION_ALREADY_IN_PROGRESS This error indicates that digit generation is already in progress.

DIGIT_GENERATION_CALLSTATE_CHANGED This error indicates that call state is invalid to continue.

DIGIT_GENERATION_WRONG_CALL_HANDLE This error indicates that call handle is invalid and call may be gone.

Error Code Description

C-6Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager Release 7.1(2)

OL-18531-01

Appendix C Troubleshooting Cisco Unified JTAPICTI Error Codes

DIGIT_GENERATION_WRONG_CALL_STATE This error indicates that call state is not valid to generate digits.

DIRECTORY_LOGIN_FAILED This error indicates that directory login failed: directory not initialized

DIRECTORY_LOGIN_NOT_ALLOWED This error indicates that directory login failed

DIRECTORY_TEMPORARY_UNAVAILABLE This error indicates that directory is temporarily unavailable.

EXISTING_FIRSTPARTY This error indicates that there is already a device controlling media.

HOLDFAILED This error indicates that the hold was rejected by line control or call control layers

ILLEGAL_CALLINGPARTY This error indicates that an attempt was made to originate call using a calling party that is not on the device

ILLEGAL_CALLSTATE This error indicates line is not in a legal state to invoke the request

ILLEGAL_HANDLE This error indicates the handle is not valid

ILLEGAL_MESSAGE_FORMAT This error indicates that there is a QBE protocol error

INCOMPATIBLE_PROTOCOL_VERSION This error indicates that JTAPI and CTI versions are not compatible : CTI Error Protocol version not supported

INVALID_LINE_HANDLE This error indicates that attempt to perform a line operation on an invalid line handle.

INVALID_RING_OPTION This error indicates that the ring option is invalid

LINE_GREATER_THAN_MAX_LINE This error indicates that line is greater than the maximum available lines on this device

LINE_INFO_DOES_NOT_EXIST This error indicates that line information does not exist in the database.

LINE_NOT_PRIMARY This error indicates that internal error returned from call control.

LINECONTROL_FAILURE This error indicates line control refuses to allow a new call to be initiated because of its current state.

MAX_NUMBER_OF_CTI_CONNECTIONS_REACHED The maximum number of CTI connections was reached.

MSGWAITING_DESTN_INVALID This error indicates that attempt to set message waiting lamp for an invalid DN; Message Waiting Destination not found.

NO_ACTIVE_DEVICE_FOR_THIRDPARTY This error indicates there is no active device for thirdparty

NO_CONFERENCE_BRIDGE This error indicates that no conference bridge available

NOT_INITIALIZED This error indicates that attempt is made to open a provider before CTI initialization completes

PROTOCOL_TIMEOUT Internal error returned from call control

Error Code Description

C-7Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager Release 7.1(2)

OL-18531-01

Appendix C Troubleshooting Cisco Unified JTAPICTI Error Codes

PROVIDER_ALREADY_OPEN This error indicates that an attempt is made to reopen provider

PROVIDER_CLOSED This error indicates an attempt to close provider while it is already closed

PROVIDER_NOT_OPEN This error indicates that device list incomplete or device list query timeout or query aborted

REDIRECT_CALL_CALL_TABLE_FULL This error indicates that internal error is returned from call control

REDIRECT_CALL_DESTINATION_BUSY This error indicates that the redirect destination is busy

REDIRECT_CALL_DESTINATION_OUT_OF_ORDER This error indicates that redirect destination is out of order

REDIRECT_CALL_DIGIT_ANALYSIS_TIMEOUT This error indicates a digit analyss time out, this is an internal error returned from call control

REDIRECT_CALL_DOES_NOT_EXIST This error indicates that an attempt is made to redirect a call that does not exist or is not longer active

REDIRECT_CALL_INCOMPATIBLE_STATE This error indicates that internal error is returned from call control

REDIRECT_CALL_MEDIA_CONNECTION_FAILED This error indicates media connection failure, this is an internal error returned from call control

REDIRECT_CALL_NORMAL_CLEARING This error indicates that redirect failed because of normal call clearing

REDIRECT_CALL_ORIGINATOR_ABANDONED This error indicates that far end hung up on the call being redirected

REDIRECT_CALL_PARTY_TABLE_FULL This error indicates that internal error is returned from call control

REDIRECT_CALL_PENDING_REDIRECT_TRANSACTION This error indicates that internal error is returned from call control

REDIRECT_CALL_PROTOCOL_ERROR This error indicates a protocol error, this is an internal error returned from call control

REDIRECT_CALL_UNKNOWN_DESTINATION This error indicates that an attempt is made to redirect to an unknown destination

REDIRECT_CALL_UNKNOWN_ERROR This error indicates that internal error is returned from call control

REDIRECT_CALL_UNKNOWN_PARTY This error indicates an unknown party is detected, this is an internal error returned from call control

REDIRECT_CALL_UNRECOGNIZED_MANAGER This error indicates that internal error is returned from call control

REDIRECT_CALLINFO_ERR This error indicates that internal error is returned from call control

REDIRECT_ERR This error indicates that internal error is returned from call control

RETRIEVEFAILED This error indicates that retrieval of call was rejected by line control or call control

Error Code Description

C-8Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager Release 7.1(2)

OL-18531-01

Appendix C Troubleshooting Cisco Unified JTAPICTI Error Codes

RETRIEVEFAILED_ACTIVE_CALL_ON_LINE This error indicates that error occurred in retrieving held call; because there is already another active call on the line

SSAPI_NOT_REGISTERED This error indicates that the redirect command was issued when the internal supporting interface was not initialized; either CTI has not yet finished its initialization or an internal error occurred

TIMEOUT This error indicates that the request has timed out.

TRANSFER_INACTIVE This error indicates that attempt to complete transfer, while consult tranfer is not there

TRANSFERFAILED This error indicates that the transfer failed probably because one of the call legs was hung up or disconnected from the far end

TRANSFERFAILED_CALLCONTROL_TIMEOUT This error indicates that expected response from call control not received during a transfer

TRANSFERFAILED_DESTINATION_BUSY This error indicates that an attempt is made to transfer call to a busy destination

TRANSFERFAILED_DESTINATION_UNALLOCATED This error indicates an attempt is made to to transfer call to a directory number that is not registered

TRANSFERFAILED_OUTSTANDING_TRANSFER This error indicates that existing transfer is still in progress

UNDEFINED_LINE This error indicates that the line that was specified, is not found on the device

UNKNOWN_GLOBAL_CALL_HANDLE This error indicates that the global call handle is unknown

UNRECOGNIZABLE_PDU This error indicates that there is a QBE protocol error

UNSPECIFIED This error indicates that an unspecified error has occurred.

Error Code Description

C-9Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager Release 7.1(2)

OL-18531-01

Appendix C Troubleshooting Cisco Unified JTAPICiscoEventIDs

CiscoEventIDsThis section includes the following events:

• Provider Events, page C-10

• Terminal Events, page C-10

• Address Events, page C-11

• Call Events, page C-11

• RTP Events, page C-12

• TermConn Events, page C-12

Provider Events

Terminal Events

Event Name Event Number

CiscoProvFeatureUnRegisteredEv 0x40000008

CiscoRestrictedEv 0x40000009

CiscoAddrRestrictedEv 0x40000010

CiscoTermRestrictedEv 0x40000011

CiscoAddrActivatedEv 0x40000012

CiscoTermActivatedEv 0x40000013

CiscoAddrActivatedOnTerminalEv 0x40000014

CiscoAddrRestrictedOnTerminalEv 0x40000015

CiscoProviderCapabilityChangedEv 0x40000016

CiscoProvTerminalCapabilityChangedEv 0x40000017

Event Name Event Number

CiscoTermCreatedEv 0x40001001

CiscoTermDataEv 0x40001002

CiscoTermInServiceEv 0x40001003

CiscoTermOutOfServiceEv 0x40001004

CiscoTermRemovedEv 0x40001005

CiscoTermDeviceActiveStatusEv 0x40001006

CiscoTermDeviceAlertingStatusEv 0x40001007

CiscoTermDeviceHoldStatusEv 0x40001008

CiscoTermDeviceIdleStatusEv 0x40001009

CiscoTermButtonPressedEv 0x40001010

C-10Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager Release 7.1(2)

OL-18531-01

Appendix C Troubleshooting Cisco Unified JTAPICiscoEventIDs

Address Events

Call Events

CiscoTermRegistraionFailedEv 0x40001011

CiscoTermDNDStatusChangedEv 0x40001014

CiscoTermDeviceStateWhisperEv 0x40001015

CiscoTermDNDOptionChangedEv 0x40001016

Event Name Event Number

CiscoAddrCreatedEv 0x40002001

CiscoAddrInServiceEv 0x40002002

CiscoAddrOutOfServiceEv 0x40002003

CiscoAddrRemovedEv 0x40002004

CiscoOutOfServiceEv 0x40002005

CiscoAddrAddedToTerminalEv 0x40002006

CiscoAddrRemovedFromTerminalEv 0x40002007

CiscoAddrAutoAcceptStatusChangedEv 0x40002008

CiscoAddrIntercomInfoChangedEv 0x40002009

CiscoAddrIntercomInfoRestorationFailedEv 0x40002010

CiscoAddrRecordingConfigChangedEv 0x40002011

CiscoAddrParkStatusEv 0x40002012

Event Name Event Number

CiscoProvCallParkEv 0x40003001

CiscoConferenceEndEv 0x40003002

CiscoConferenceStartEv 0x40003003

CiscoConsultCallActiveEv 0x40003004

CiscoTransferEndEv 0x40003005

CiscoTransferStartEv 0x40003006

CiscoToneChangedEv 0x40003007

CiscoCallChangedEv 0x40003008

CiscoConferenceChainAddedEv 0x40003009

CiscoConferenceChainRemovedEv 0x40003010

CiscoCallSecurityStatusChangedEv 0x40003011

Event Name Event Number

C-11Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager Release 7.1(2)

OL-18531-01

Appendix C Troubleshooting Cisco Unified JTAPIReason Codes

RTP Events

TermConn Events

Reason CodesThe following codes are defined in CiscoFeatureReason interface.

Event Name Event Number

CiscoRTPInputStartedEv 0x40004001

CiscoRTPInputStoppedEv 0x40004002

CiscoRTPOutputStartedEv 0x40004003

CiscoRTPOutputStoppedEv 0x40004004

CiscoMediaOpenLogicalChannelEv 0x40004005

CiscoRTPInputKeyEv 0x40004006

CiscoRTPOutputKeyEv 0x40004007

Event Name Event Number

CiscoTermConnPrivacyChangedEv 0x40005001

CiscoCallCtlTermConnHeldReversionEv 0x40005002

CiscoTermConnSelectChangedEv 0x40005003

CiscoTermConnRecordingStartEv 0x40005004

CiscoTermConnRecordingEndEv 0x40005005

CiscoTermConnMonitoringStartEv 0x40005006

CiscoTermConnMonitoringEndEv 0x40005007

CiscoTermConnRecordingTargetInfoEv 0x40005008

CiscoTermConnMonitorInitiatorInfoEv 0x40005009

CiscoTermConnMonitorTargetInfoEv 0x4000500A

Reason Code Name Reason Code

REASON_TRANSFER 2

REASON_FORWARDNOANWSER 3

REASON_FORWARDBUSY 4

REASON_FORWARDALL 5

REASON_REDIRECT 6

REASON_BLINDTRANSFER 7

REASON_CONFERENCE 9

C-12Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager Release 7.1(2)

OL-18531-01

Appendix C Troubleshooting Cisco Unified JTAPICause Codes

Cause Codes

REASON_PARK 10

REASON_CALLPICKUP 11

REASON_NORMAL 12

REASON_PARKREMINDER 15

REASON_UNPARK 16

REASON_BARGE 20

REASON_IMMDIVERT 21

REASON_FAC_CMC 22

REASON_QSIG_PR 23

REASON_REFER 24

REASON_REPLACE 25

REASON_CCM_REDIRECTION 26

REASON_DPARK_CALLPARK 27

REASON_DPARK_REVERSION 28

REASON_DPARK_UNPARK 29

REASON_SILENTMONITORING 31

REASON_MOBILITY 33

REASON_MOBILITY_IVR 34

REASON_MOBILITY_CELLPICKUP 35

REASON_MOBILITY_HANDIN 36

REASON_MOBILITY_HANDOUT 37

REASON_MOBILITY_FOLLOWME 38

REASON_CLICK_TO_CONFERENCE 39

REASON_FORWARD_NO_RETRIEVE 40

Cause Code Name Cause Code

CAUSE_NOERROR 0X00 (0)

CAUSE_UNALLOCATEDNUMBER 0X01 (1)

CAUSE_NOROUTETOTRANSITNET 0X02 (2)

CAUSE_NOROUTETODDESTINATION 0X03 (3)

CAUSE_CHANUNACCEPTABLE 0X06 (6)

CAUSE_CALLBEINGDELIVERED 0X07 (7)

CAUSE_CTIPREEMPTNOREUSE 0X08 (8)

CAUSE_CTIPREEMPTFORREUSE 0X09 (9)

Reason Code Name Reason Code

C-13Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager Release 7.1(2)

OL-18531-01

Appendix C Troubleshooting Cisco Unified JTAPICause Codes

CAUSE_NORMALCALLCLEARING 0X10 (16)

CAUSE_USERBUSY 0X11 (17)

CAUSE_NOUSERRESPONDING 0X12 (18)

CAUSE_NOANSWERFROMUSER 0X13 (19)

CAUSE_SUBSCRIBERABSENT 0X14 (20)

CAUSE_CALLREJECTED 0X15 (21)

CAUSE_NUMBERCHANGED 0X16 (22)

CAUSE_EXCHANGEROUTINGERROR 0X19 (25)

CAUSE_NONSELECTEDUSERCLEARING 0X1A (26)

CAUSE_DDESTINATIONOUTOFORDER 0X1B (27)

CAUSE_INVALIDNUMBERFORMAT 0X1C (28)

CAUSE_FACILITYREJECTED 0X1D (29)

CAUSE_RESPONSETOSTATUSENQUIRY 0X1E (30)

CAUSE_NORMALUNSPECIFIED 0X1F (31)

CAUSE_NOCIRCAVAIL 0X22 (34)

CAUSE_NETOUTOFORDER 0X26 (38)

CAUSE_TEMPORARYFAILURE 0X29 (41)

CAUSE_SWITCHINGEQUIPMENT CONGESTION

0X2A (42)

CAUSE_ACCESSINFORMATION DISCARDED

0X2B (43)

CAUSE_REQCIRCNAVIL 0X2C (44)

CAUSE_CTIPRECEDENCECALLBLOCKED 0X2E (46)

CAUSE_RESOURCESNAVAIL 0X2F (47)

CAUSE_QUALOFSERVNAVAIL 0X31 (49)

CAUSE_REQFACILITYNOTSUBSCRIBED 0X32 (50)

CAUSE_SERVOPERATIONVIOLATED 0X35 (53)

CAUSE_INCOMINGCALLBARRED 0X36 (54)

CAUSE_BCNAUTHORIZED 0X39 (57)

CAUSE_BCBPRESENTLYAVAIL 0X3A (58)

CAUSE_SERVNOTAVAILUNSPECIFIED 0X3F (63)

CAUSE_BEARERCAPNIMPL 0X41 (65)

CAUSE_CHANTYPENIMPL 0X42 (66)

CAUSE_REQFACILITYNIMPL 0X45 (69)

CAUSE_ONLYRDIVEARERCAPAVAIL 0X46 (70)

CAUSE_SERVOROPTNAVAILORIMPL 0X4F (79)

CAUSE_INVALIDCALLREFVALUE 0X51 (81 )

CAUSE_IDENTIFIEDCHANDOESNOTEXIST 0X52 (82)

Cause Code Name Cause Code

C-14Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager Release 7.1(2)

OL-18531-01

Appendix C Troubleshooting Cisco Unified JTAPICause Codes

CAUSE_SUSPCALLBUTNOTTHISONE 0X53 (83)

CAUSE_CALLIDINUSE 0X54 (84)

CAUSE_NOCALLSUSPENDED 0X55 (85)

CAUSE_REQCALLIDHASBEENCLEARED 0X56 (86)

CAUSE_INCOMPATABLEDDESTINATION 0X58 (88)

CAUSE_DESTNUMMISSANDDCNOTSUB 0X5A (90)

CAUSE_INVALIDTRANSITNETSEL 0X5B (91)

CAUSE_INVALIDMESSAGEUNSPECIFIED 0X5F (95)

CAUSE_MANDATORYIEMISSING 0X60 (96)

CAUSE_MSGTYPENIMPL 0X61 (97)

CAUSE_MSGTYPENCOMPATWCS 0X62 (98)

CAUSE_IENIMPL 0X63 (99)

CAUSE_INVALIDIECONTENTS 0X64 (100)

CAUSE_MSGNCOMPATABLEWCS 0X65 (101)

CAUSE_RECOVERYONTIMEREXPIRY 0X66 (102)

CAUSE_PROTOCOLERRORUNSPECIFIED 0X6F (111)

CAUSE_CTIPRECEDENCELEVEL EXCEEDED

0X7A (122)

CAUSE_CTIDEVICENOTPREEMPTABLE 0X7B (123)

CAUSE_OUTOFBANDWIDTH 0X7D (125)

CAUSE_INTERWORKINGUNSPECIFIED 0X7F (127)

CAUSE_CTIPRECEDENCEOUTOF BANDWIDTH

0X81 (129)

CAUSE_REDIRECTED 0XC9 (200)

CAUSE_INTERNALCAUSE 0X1F4 (500)

CAUSE_OUTBOUND_TRANSFER 0X1F5 (501)

CAUSE_OUTBOUND_CONFERENCE 0X1F6 (502)

CAUSE_INBOUND_TRANSFER 0X1F7 (503)

CAUSE_INBOUND_CONFERENCE 0X1F8 (504)

CAUSE_INBOUND_BLINDTRANSFER 0X1F9 (505)

CAUSE_CTIMANAGER_FAILURE 0x1FB (507)

CAUSE_CALLMANAGER_FAILURE 0x1FC (508)

CAUSE_BARGE 0x1FD(509)

CAUSE_FAC_CMC 0x1FE (510)

CAUSE_QSIG_PR 0x1FF (511)

CAUSE_DPARK 0x200 (512)

CAUSE_DPARK_UNPARK 0x201 (513)

CAUSE_DPARK_REMINDER 0x202 (514)

Cause Code Name Cause Code

C-15Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager Release 7.1(2)

OL-18531-01

Appendix C Troubleshooting Cisco Unified JTAPICause Codes

CAUSE_QUIET_CLEAR 0x203 (515)

CAUSE_CTICONFERENCEFULL 0X40000 + CAUSE_NOERROR

CAUSE_CALLSPLIT 0X60000 + CAUSE_NOERROR

CAUSE_CTIDROPCONFEREE 0X70000 + CAUSE_NOERROR

CAUSE_CTICCMSIP400BADREQUEST 0X1000000 + CAUSE_TEMPORARYFAILURE

CAUSE_CTICCMSIP401UNAUTHORIZED 0X2000000 + CAUSE_CALLREJECTED

CAUSE_CTICCMSIP402PAYMENT REQUIRED

0X3000000 + CAUSE_CALLREJECTED

CAUSE_CTICCMSIP403FORBIDDEN 0X4000000 + CAUSE_CALLREJECTED

CAUSE_CTICCMSIP404NOTFOUND 0X5000000 + CAUSE_UNALLOCATEDNUMBER

CAUSE_CTICCMSIP405METHODNOT ALLOWED

0X6000000 + CAUSE_SERVNOTAVAILUNSPECIFIED

CAUSE_CTICCMSIP406NOTACCEPTABLE 0X7000000 + CAUSE_SERVOROPTNAVAILORIMPL

CAUSE_CTICCMSIP407PROXYAUTHENTICATIONREQUIRED

0X8000000 + CAUSE_CALLREJECTED

CAUSE_CTICCMSIP408REQUESTTIMEOUT 0X9000000 + CAUSE_RECOVERYONTIMEREXPIRY

CAUSE_CTICCMSIP410GONE 0XB000000 + CAUSE_NUMBERCHANGED

CAUSE_CTICCMSIP411LENGTHREQUIRED 0XC000000 + CAUSE_INTERWORKINGUNSPECIFIED

CAUSE_CTICCMSIP413REQUESTENTITY TOOLONG

0XE000000 + CAUSE_INTERWORKINGUNSPECIFIED

CAUSE_CTICCMSIP414REQUESTURI TOOLONG

0XF000000 + CAUSE_INTERWORKINGUNSPECIFIED

CAUSE_CTICCMSIP415UNSUPPORTED MEDIATYPE

0X10000000 + CAUSE_SERVOROPTNAVAILORIMPL

CAUSE_CTICCMSIP416UNSUPPORTED URISCHEME

0X11000000 + CAUSE_INTERWORKINGUNSPECIFIED

CAUSE_CTICCMSIP420BADEXTENSION 0X15000000 + CAUSE_INTERWORKINGUNSPECIFIED

CAUSE_CTICCMSIP421EXTENSTION REQUIRED

0X16000000 + CAUSE_INTERWORKINGUNSPECIFIED

CAUSE_CTICCMSIP423INTERVALTOO BRIEF

0X18000000 + CAUSE_INTERWORKINGUNSPECIFIED

CAUSE_CTICCMSIP480TEMPORARILY UNAVAILABLE

0X40000000 + CAUSE_NOUSERRESPONDING

CAUSE_CTICCMSIP481CALLLEGDOESNOTEXIST

0X41000000 + CAUSE_TEMPORARYFAILURE

CAUSE_CTICCMSIP482LOOPDETECTED 0X42000000 + CAUSE_EXCHANGEROUTINGERROR

Cause Code Name Cause Code

C-16Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager Release 7.1(2)

OL-18531-01

Appendix C Troubleshooting Cisco Unified JTAPIAdditional Troubleshooting Information

Additional Troubleshooting Information

Viewing JTAPI Debug OutputTo view JTAPI debug output, use the JTPREFS application to change the trace settings. The JTPREFS application allows you to enable or disable various kinds of tracing.

CAUSE_CTICCMSIP483TOOMANYHOOPS 0X43000000 + CAUSE_EXCHANGEROUTINGERROR

CAUSE_CTICCMSIP484ADDRESS INCOMPLETE

0X44000000 + CAUSE_INVALIDNUMBERFORMAT

CAUSE_CTICCMSIP485AMBIGUOUS 0X45000000 + CAUSE_UNALLOCATEDNUMBER

CAUSE_CTICCMSIP486BUSYHERE 0X46000000 + CAUSE_USERBUSY

CAUSE_CTICCMSIP487REQUEST TERMINATED

0X47000000 + CAUSE_NORMALUNSPECIFIED

CAUSE_CTICCMSIP488NOTACCEPTABLE HERE

0X48000000 + CAUSE_NORMALUNSPECIFIED

CAUSE_CTICCMSIP491REQUESTPENDING 0X4B000000 + CAUSE_USERBUSY

CAUSE_CTICCMSIP493UNDECIPHERABLE 0X4D000000 + CAUSE_USERBUSY

CAUSE_CTICCMSIP500SERVERINTERNALERROR

0X54000000 + CAUSE_TEMPORARYFAILURE

CAUSE_CTICCMSIP501NOTIMPLEMENTED 0X55000000 + CAUSE_SERVOROPTNAVAILORIMPL

CAUSE_CTICCMSIP502BADGATEWAY 0X56000000 + CAUSE_NETOUTOFORDER

CAUSE_CTICCMSIP503SERVICE UNAVAILABLE

0X57000000 + CAUSE_TEMPORARYFAILURE

CAUSE_CTICCMSIP504SERVERTIMEOUT 0X58000000 + CAUSE_RECOVERYONTIMEREXPIRY

CAUSE_CTICCMSIP505SIPVERSIONNOT SUPPORTED

0X59000000 + CAUSE_INTERWORKINGUNSPECIFIED

CAUSE_CTICCMSIP513MESSAGETOO LARGE

0X5A000000 + CAUSE_INTERWORKINGUNSPECIFIED

CAUSE_CTICCMSIP600BUSY EVERYWHERE

0XA1000000 + CAUSE_USERBUSY

CAUSE_CTICCMSIP603DECLINE 0XA2000000 + CAUSE_CALLREJECTED

CAUSE_CTICCMSIP604DOESNOTEXIST ANYWHERE

0XA3000000 + CAUSE_UNALLOCATEDNUMBER

CAUSE_CTICCMSIP606NOTACCEPTABLE 0XA4000000 + CAUSE_NORMALUNSPECIFIED

Cause Code Name Cause Code

C-17Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager Release 7.1(2)

OL-18531-01

Appendix C Troubleshooting Cisco Unified JTAPIAdditional Troubleshooting Information

JTPREFS is installed in the %SystemRoot%\java\lib directory along with the JTAPI classes. Cisco JTAPI Preferences is installed by default in Program Files\JTAPITools.

To open the Cisco JTAPI Preferences utility, choose Start > Programs > Cisco JTAPI > JTAPI Preferences.

The following trace levels are defined:

• WARNING - warning events

• INFORMATIONAL - status events

• DEBUG - debugging events

If DEBUG is enabled, JTPREFS allows you to enable or disable various debugging levels.

The following debugging levels are defined:

• TAPI_DEBUGGING - to trace JTAPI methods and events

• TAPI_IMPLDEBUGGING - internal JTAPI implementation trace

• CTI_DEBUGGING - to trace Cisco Unified Communications Manager events that are sent to the JTAPI implementation

• CTIIMPL_DEBUGGING - internal CTICLIENT implementation trace

• PROTOCOL_DEBUGGING - full CTI protocol decoding

• MISC_DEBUGGING - miscellaneous low-level debug trace

Traces can be directed to a specific path and folder rather than to the application directory by default. The same trace folder could be used for successive or more than one simultaneous launch of JTAPI. Different launches of JTAPI would also send the traces to different folders. This allows simultaneous JTAPI instances to maintain independent trace destinations

Log Files For JTAPI Client InstallerIn order to detect the error which might occur during the installation and uninstallation process, two log files will be generated. These files will be in the same location from which the installer is executed.

• ismpInstall.log – to track events during installation.

• ismpUninstall.log – to track events during uninstallation.

The error messages will contain the information about the wizard beans that were executed as a part of the install procedure and if there were any exceptions.

Troubleshooting Tips for ISMP Installer

SN Problem Description Cause Solution

1 ISMP Uninstall does not remove the target directories installed.

Directory from which uninstaller is invoked.

The uninstaller needs to be invoked from at least one level above the install directory.

2 Proper language details are not displayed during installation

Locale Files not proper. Please report this problem immediately to the support personnel to suggest the change or error in message.

C-18Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager Release 7.1(2)

OL-18531-01

Appendix C Troubleshooting Cisco Unified JTAPIAdditional Troubleshooting Information

Unable to Create Provider Directory Login TimeoutThis error occurs when there is no authentication response from CTI for the ProviderOpenRequest. It could fail because of:

• LDAP connectivity problems

• Database delays

• The CTIManager being busy for some other reason and therefore unable to honor the request

The solution is that the application must try again. If the ProviderOpenRequest fails on repeated attempts, modify the ProviderOpenRequest.

3 Uninstaller/Installer throws error.

The JVM has been either removed or replaced with an incompatible version

The installer comes with a built in JVM which also gets installed if the target machine does not have a JVM. In case you face this error - manual removal of the files needs to be done.

4 Installer goes through fine, but the files have not been copied.

Permissions Ensure that proper write permissions are there for the destination folder. This problem can occur on UNIX platforms.

5 Installer/Uninstaller throws exception or crashes during the installation process.

version name problem / folder name problem.

Refer to the log files generated to get an idea of which step caused the error.

6 Upgrade does not show “upgrade” message during installation of an upgrade version.

.jtapiver.ini missing. This file is where the current jtapi install details are located. If this is accidently removed then, upgrade/reinstall will have display issues. In the case of an upgrade/reinstall or downgrade failure, the user will have to manually remove the files from the .jtapi/bin and .jtapi/lib folders and then try the installer in order to ensure proper installation during the next time.

C-19Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager Release 7.1(2)

OL-18531-01

Appendix C Troubleshooting Cisco Unified JTAPIAdditional Troubleshooting Information

C-20Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager Release 7.1(2)

OL-18531-01

Cisco Unified JTAPI Developers Guide for Cisco UnifOL-18531-01

A

P P E N D I X D Cisco Unified JTAPI Operations-by-Release

Table D-1 lists supported, unsupported, changed, and “under consideration or review” features for Cisco Unified JTAPI by Cisco Unified Communications Manager release. The details can be found in the Cisco Unified Communications Manager JTAPI Developers Guide at http://www.cisco.com/en/US/products/sw/voicesw/ps556/products_programming_reference_guides_ list.html.

Table Legend

Supported

Not Supported

Modified

UCR Under Consideration or Review

Table D-1 JTAPI Features by Cisco Unified Communications Manager Release

JTAPI Features 3.1 3.2 3.3 4.0 4.1 4.2 4.3 5.0 5.1 6.0 6.1 7.0 7.1.27.1.3 (UCR)

8.0 (UCR)

CTI Manager and Support for fault tolerance

Support for Cisco CallManager Extension Mobility

Blind Transfer (using Redirect)

Support for Forward

Reset the Original Called Party with Redirect

D-1ied Communications Manager Release 7.1(2)

Appendix D Cisco Unified JTAPI Operations-by-Release

CiscoAddrInServiceEv or CiscoAddrOutOFServiceEv

Localization / Internationalization

User Deletion from Directory

Park and Unpark

Monitoring Call Park Numbers

Call Reason Enhancements

Device Data Passthrough

CiscoJTAPI Auto Install

Multiple Calls per DN

Shared Line Support

Transfer

Direct Transfer

Conference

Join

Privacy Release

Barge and cBarge

Dynamic Port Registration

Media Termination at Route Points

Transfer to VoiceMail

Modifying Calling Number

Support for Presentation Indication

QSIG-PR

FAC/CMC Support

Table D-1 JTAPI Features by Cisco Unified Communications Manager Release

JTAPI Features 3.1 3.2 3.3 4.0 4.1 4.2 4.3 5.0 5.1 6.0 6.1 7.0 7.1.27.1.3 (UCR)

8.0 (UCR)

D-2Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager Release 7.1(2)

OL-18531-01

Appendix D Cisco Unified JTAPI Operations-by-Release

Device State Server

SuperProvider Functionality

Windows 2003 Support

Directed PARK

Forward on NoBandWidth and Unregister

VoiceMailBox Support

Privacy on Hold

Hold Reversion (4.2.1.SR1)

Support for MLPP (4.2.2)

Conference Enhancement-Add Participants to Conf by Non-controller (4.2.2)

Conference Chaining (4.2.2)

CiscoRTPHandle Interface (4.2.2)

CiscoTermRegistrationFailedEv- New Error Code (4.2.3)

Network events

BWC Enhancement

Hairpin Support

Unicode Support

SRTP support

Partition Support

Security (TLS) support

Alternate Script Support

SIP Features Refer/Replaces

Table D-1 JTAPI Features by Cisco Unified Communications Manager Release

JTAPI Features 3.1 3.2 3.3 4.0 4.1 4.2 4.3 5.0 5.1 6.0 6.1 7.0 7.1.27.1.3 (UCR)

8.0 (UCR)

D-3Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager Release 7.1(2)

OL-18531-01

Appendix D Cisco Unified JTAPI Operations-by-Release

SIP End Point Support

Change Notification of SuperProvider and CallParkDN Monitoring capability

3XX

Call Select Status

QoS support

Linux and Solaris Installer

Intercom Support

Secure Conferencing Support

Monitoring & Recording

Arabic and Hebrew Language Support

Do-Not_Disturb Support

Join AcrossLine (SCCP)

Certificate Download API Enhancement

Intercom Support for Extension Mobility

Join Across Line (SIP phone support)

Locale Infrastructure Enhancement

DND-CallReject (DND-R)

Call Party Normalization (CPN)

Click-To-Conference

IPv6 Support

Windows Vista Support

EMLogin UserName API

SetJtapiProperties API on CiscoJTAPIPeer

Table D-1 JTAPI Features by Cisco Unified Communications Manager Release

JTAPI Features 3.1 3.2 3.3 4.0 4.1 4.2 4.3 5.0 5.1 6.0 6.1 7.0 7.1.27.1.3 (UCR)

8.0 (UCR)

D-4Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager Release 7.1(2)

OL-18531-01

Appendix D Cisco Unified JTAPI Operations-by-Release

DropAnyParty from Conference

Swap/Cancel - Transfer/Conference Behavior Change

Direct Transfer Across Lines

Park Monitoring enhancements

Assisted DPark

Enhanced MWI

Logical Partitioning

Rollover Support

Address and Terminal Settings

(max calls, voice mail, busy trigger etc.)

End to End Call Tracing

Extension Mobility Cross Cluster

Hunt List Support

Table D-1 JTAPI Features by Cisco Unified Communications Manager Release

JTAPI Features 3.1 3.2 3.3 4.0 4.1 4.2 4.3 5.0 5.1 6.0 6.1 7.0 7.1.27.1.3 (UCR)

8.0 (UCR)

D-5Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager Release 7.1(2)

OL-18531-01

Appendix D Cisco Unified JTAPI Operations-by-Release

D-6Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager Release 7.1(2)

OL-18531-01

Cisco Unified JTAPI Developers Guide for Cisco UnifOL-18531-01

A

P P E N D I X E CTI Supported Devices

Table E-1 provides information about CTI supported devices.

Table legend:

: supported, : not supported, : modified, UCR: Under Condition Review.

Table E-1 CTI Supported Device Matrix

Device/Phone Model SCCP SIP Comments

Analog Phone

Cisco 12 S

Cisco 12 SP

Cisco 12 SP

Cisco 30 SP

Cisco 30 VIP

Cisco 3911 Not a CTI supported device

Cisco 7902

Cisco 7905

Cisco 7906

Cisco 7910

Cisco 7911

Cisco 7912

Cisco 7914 Sidecar

Cisco 7915 Sidecar UCR UCR

Cisco 7916 Sidecar UCR UCR

Cisco 7920

E-1ied Communications Manager Release 7.1(2)

Appendix E CTI Supported Devices

Cisco 7921

Cisco 7931 CTI supported only if rollover is disabled

Cisco 7935

Cisco 7936

Cisco 7937

Cisco 7940

Cisco 7941

Cisco 7941G-GE

Cisco 7942

Cisco 7945

Cisco 7960

Cisco 7961

Cisco 7961G-GE

Cisco 7962

Cisco 7965

Cisco 7970

Cisco 7971

Cisco 7975

Cisco 7985

Cisco ATA

Cisco IP Communicator CTI support when running in desktop mode depends on physical device; Softphone mode not yet tested

Cisco Unified Personal Communicator

Cisco VGC Phone

VG224

VG248

Table E-1 CTI Supported Device Matrix (continued)

Device/Phone Model SCCP SIP Comments

E-2Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager Release 7.1(2)

OL-18531-01

Appendix E CTI Supported Devices

CTI Port — — CTI supported virtual device that does not use SCCP or SIP

CTI Route Point — — CTI supported virtual device that does not use SCCP or SIP

CTI Route Point (Pilot Point)

— — CTI supported virtual device that does not use SCCP or SIP

ISDN BRI Phone — — Not a CTI supported device

Table E-1 CTI Supported Device Matrix (continued)

Device/Phone Model SCCP SIP Comments

E-3Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager Release 7.1(2)

OL-18531-01

Appendix E CTI Supported Devices

E-4Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager Release 7.1(2)

OL-18531-01

Cisco Unified JTAPI Developers Guide for Cisco UnifOL-18531-01

A

P P E N D I X F Constant Field Values

This appendix lists the static final fields and their values.

com.cisco.*

CiscoAddrActivatedEv

CiscoAddrActivatedOnTerminalEv

CiscoAddrAddedToTerminalEv

com.cisco.jtapi.extensions.CiscoAddrActivatedEv

public static final int ID 1073741842

com.cisco.jtapi.extensions.CiscoAddrActivatedOnTerminalEv

public static final int ID 1073741844

com.cisco.jtapi.extensions.CiscoAddrAddedToTerminalEv

public static final int ID 1073750022

F-1ied Communications Manager Release 7.1(2)

Appendix F Constant Field Valuescom.cisco.*

CiscoAddrAutoAcceptStatusChangedEv

CiscoAddrCreatedEv

CiscoAddress

com.cisco.jtapi.extensions.CiscoAddrAutoAcceptStatusChangedEv

public static final int ID 1073750024

com.cisco.jtapi.extensions.CiscoAddrCreatedEv

public static final int ID 1073750017

com.cisco.jtapi.extensions.CiscoAddress

public static final int APPLICATION_CONTROLLED_RECORDING

2

public static final int AUTO_RECORDING 1

public static final int AUTOACCEPT_OFF 0

public static final int AUTOACCEPT_ON 1

public static final int AUTOANSWER_OFF 0

public static final int AUTOANSWER_UNKNOWN 3

public static final int AUTOANSWER_WITHHEADSET 1

public static final int AUTOANSWER_WITHSPEAKERSET 2

public static final int EXTERNAL 2

public static final int EXTERNAL_UNKNOWN 3

public static final int IN_SERVICE 1

public static final int INTERNAL 1

public static final int MONITORING_TARGET 5

public static final int NO_RECORDING 0

public static final int OUT_OF_SERVICE 0

public static final int RINGER_DEFAULT 0

public static final int RINGER_DISABLE 1

public static final int RINGER_ENABLE 2

public static final int UNKNOWN 4

F-2Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager Release 7.1(2)

OL-18531-01

Appendix F Constant Field Valuescom.cisco.*

CiscoAddrInServiceEv

CiscoAddrIntercomInfoChangedEv

CiscoAddrIntercomInfoRestorationFailedEv

CiscoAddrOutOfServiceEv

CiscoAddrRecordingConfigChangedEv

CiscoAddrRemovedEv

com.cisco.jtapi.extensions.CiscoAddrInServiceEv

public static final int ID 1073750018

com.cisco.jtapi.extensions.CiscoAddrIntercomInfoChangedEv

public static final int ID 1073750025

com.cisco.jtapi.extensions.CiscoAddrIntercomInfoRestorationFailedEv

public static final int ID 1073750032

com.cisco.jtapi.extensions.CiscoAddrOutOfServiceEv

public static final int ID 1073750019

com.cisco.jtapi.extensions.CiscoAddrRecordingConfigChangedEv

public static final int ID 1073750033

com.cisco.jtapi.extensions.CiscoAddrRemovedEv

public static final int ID 1073750020

F-3Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager Release 7.1(2)

OL-18531-01

Appendix F Constant Field Valuescom.cisco.*

CiscoAddrRemovedFromTerminalEv

CiscoAddrRestrictedEv

CiscoAddrRestrictedOnTerminalEv

CiscoCall

com.cisco.jtapi.extensions.CiscoAddrRemovedFromTerminalEv

public static final int ID 1073750023

com.cisco.jtapi.extensions.CiscoAddrRestrictedEv

public static final int ID 1073741840

com.cisco.jtapi.extensions.CiscoAddrRestrictedOnTerminalEv

public static final int ID 1073741845

com.cisco.jtapi.extensions.CiscoCall

public static final int CALLSECURITY_AUTHENTICATED 2

public static final int CALLSECURITY_ENCRYPTED 3

public static final int CALLSECURITY_NOTAUTHENTICATED 1

public static final int CALLSECURITY_UNKNOWN 0

public static final int FEATUREPRIORITY_EMERGENCY 3

public static final int FEATUREPRIORITY_NORMAL 1

public static final int FEATUREPRIORITY_URGENT 2

public static final int PLAYTONE_BOTHLOCALANDREMOTE 2

public static final int PLAYTONE_LOCALONLY 0

public static final int PLAYTONE_NOLOCAL_OR_REMOTE 3

public static final int PLAYTONE_REMOTEONLY 1

public static final int SILENT_MONITOR 1

F-4Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager Release 7.1(2)

OL-18531-01

Appendix F Constant Field Valuescom.cisco.*

CiscoCallChangedEv

CiscoCallCtlTermConnHeldReversionEv

CiscoCallEv

com.cisco.jtapi.extensions.CiscoCallChangedEv

public static final int ID 1073754120

com.cisco.jtapi.extensions.CiscoCallCtlTermConnHeldReversionEv

public static final int ID 1073762306

com.cisco.jtapi.extensions.CiscoCallEv

public static final int CAUSE_ACCESSINFORMATIONDISCARDED

43

public static final int CAUSE_BARGE 509

public static final int CAUSE_BCBPRESENTLYAVAIL 58

public static final int CAUSE_BCNAUTHORIZED 57

public static final int CAUSE_BEARERCAPNIMPL 65

public static final int CAUSE_CALLBEINGDELIVERED 7

public static final int CAUSE_CALLIDINUSE 84

public static final int CAUSE_CALLMANAGER_FAILURE 508

public static final int CAUSE_CALLREJECTED 21

public static final int CAUSE_CALLSPLIT 393216

public static final int CAUSE_CHANTYPENIMPL 66

public static final int CAUSE_CHANUNACCEPTABLE 6

public static final int CAUSE_CTICCMSIP400BADREQUEST 16777257

public static final int CAUSE_CTICCMSIP401UNAUTHORIZED

33554453

public static final int CAUSE_CTICCMSIP402PAYMENTREQUIRED

50331669

public static final int CAUSE_CTICCMSIP403FORBIDDEN 67108885

public static final int CAUSE_CTICCMSIP404NOTFOUND 83886081

public static final int CAUSE_CTICCMSIP405METHODNOTALLOWED

100663359

public static final int CAUSE_CTICCMSIP406NOTACCEPTABLE

117440591

F-5Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager Release 7.1(2)

OL-18531-01

Appendix F Constant Field Valuescom.cisco.*

public static final int CAUSE_CTICCMSIP407PROXYAUTHENTICATIONREQUIRED

134217749

public static final int CAUSE_CTICCMSIP408REQUESTTIMEOUT

150995046

public static final int CAUSE_CTICCMSIP410GONE 184549398

public static final int CAUSE_CTICCMSIP411LENGTHREQUIRED

201326719

public static final int CAUSE_CTICCMSIP413REQUESTENTITYTOOLONG

234881151

public static final int CAUSE_CTICCMSIP414REQUESTURITOOLONG

251658367

public static final int CAUSE_CTICCMSIP415UNSUPPORTEDMEDIATYPE

268435535

public static final int CAUSE_CTICCMSIP416UNSUPPORTEDURISCHEME

285212799

public static final int CAUSE_CTICCMSIP420BADEXTENSION

352321663

public static final int CAUSE_CTICCMSIP421EXTENSTIONREQUIRED

369098879

public static final int CAUSE_CTICCMSIP423INTERVALTOOBRIEF

402653311

public static final int CAUSE_CTICCMSIP480TEMPORARILYUNAVAILABLE

1073741842

public static final int CAUSE_CTICCMSIP481CALLLEGDOESNOTEXIST

1090519081

public static final int CAUSE_CTICCMSIP482LOOPDETECTED

1107296281

public static final int CAUSE_CTICCMSIP483TOOMANYHOOPS

1124073497

public static final int CAUSE_CTICCMSIP484ADDRESSINCOMPLETE

1140850716

public static final int CAUSE_CTICCMSIP485AMBIGUOUS 1157627905

public static final int CAUSE_CTICCMSIP486BUSYHERE 1174405137

public static final int CAUSE_CTICCMSIP487REQUESTTERMINATED

1191182367

public static final int CAUSE_CTICCMSIP488NOTACCEPTABLEHERE

1207959583

public static final int CAUSE_CTICCMSIP491REQUESTPENDING

1258291217

public static final int CAUSE_CTICCMSIP493UNDECIPHERABLE

1291845649

public static final int CAUSE_CTICCMSIP500SERVERINTERNALERROR

1409286185

com.cisco.jtapi.extensions.CiscoCallEv

F-6Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager Release 7.1(2)

OL-18531-01

Appendix F Constant Field Valuescom.cisco.*

public static final int CAUSE_CTICCMSIP501NOTIMPLEMENTED

1426063439

public static final int CAUSE_CTICCMSIP502BADGATEWAY 1442840614

public static final int CAUSE_CTICCMSIP503SERVICEUNAVAILABLE

1459617833

public static final int CAUSE_CTICCMSIP504SERVERTIMEOUT

1476395110

public static final int CAUSE_CTICCMSIP505SIPVERSIONNOTSUPPORTED

1493172351

public static final int CAUSE_CTICCMSIP513MESSAGETOOLARGE

1509949567

public static final int CAUSE_CTICCMSIP600BUSYEVERYWHERE

-1593835503

public static final int CAUSE_CTICCMSIP603DECLINE -1577058283

public static final int CAUSE_CTICCMSIP604DOESNOTEXISTANYWHERE

-1560281087

public static final int CAUSE_CTICCMSIP606NOTACCEPTABLE

-1543503841

public static final int CAUSE_CTICONFERENCEFULL 262144

public static final int CAUSE_CTIDEVICENOTPREEMPTABLE 123

public static final int CAUSE_CTIDROPCONFEREE 458752

public static final int CAUSE_CTIMANAGER_FAILURE 507

public static final int CAUSE_CTIPRECEDENCECALLBLOCKED

46

public static final int CAUSE_CTIPRECEDENCELEVELEXCEEDED

122

public static final int CAUSE_CTIPRECEDENCEOUTOFBANDWIDTH

129

public static final int CAUSE_CTIPREEMPTFORREUSE 9

public static final int CAUSE_CTIPREEMPTNOREUSE 8

public static final int CAUSE_DESTINATIONOUTOFORDER 27

public static final int CAUSE_DESTNUMMISSANDDCNOTSUB

90

public static final int CAUSE_DPARK 512

public static final int CAUSE_DPARK_REMINDER 514

public static final int CAUSE_DPARK_UNPARK 513

public static final int CAUSE_EXCHANGEROUTINGERROR 25

public static final int CAUSE_FAC_CMC 510

public static final int CAUSE_FACILITYREJECTED 29

public static final int CAUSE_IDENTIFIEDCHANDOESNOTEXIST

82

com.cisco.jtapi.extensions.CiscoCallEv

F-7Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager Release 7.1(2)

OL-18531-01

Appendix F Constant Field Valuescom.cisco.*

public static final int CAUSE_IENIMPL 99

public static final int CAUSE_INBOUNDBLINDTRANSFER 505

public static final int CAUSE_INBOUNDCONFERENCE 504

public static final int CAUSE_INBOUNDTRANSFER 503

public static final int CAUSE_INCOMINGCALLBARRED 54

public static final int CAUSE_INCOMPATABLEDDESTINATION

88

public static final int CAUSE_INTERWORKINGUNSPECIFIED 127

public static final int CAUSE_INVALIDCALLREFVALUE 81

public static final int CAUSE_INVALIDIECONTENTS 100

public static final int CAUSE_INVALIDMESSAGEUNSPECIFIED

95

public static final int CAUSE_INVALIDNUMBERFORMAT 28

public static final int CAUSE_INVALIDTRANSITNETSEL 91

public static final int CAUSE_MANDATORYIEMISSING 96

public static final int CAUSE_MSGNCOMPATABLEWCS 101

public static final int CAUSE_MSGTYPENCOMPATWCS 98

public static final int CAUSE_MSGTYPENIMPL 97

public static final int CAUSE_NETOUTOFORDER 38

public static final int CAUSE_NOANSWERFROMUSER 19

public static final int CAUSE_NOCALLSUSPENDED 85

public static final int CAUSE_NOCIRCAVAIL 34

public static final int CAUSE_NOERROR 0

public static final int CAUSE_NONSELECTEDUSERCLEARING

26

public static final int CAUSE_NORMALCALLCLEARING 16

public static final int CAUSE_NORMALUNSPECIFIED 31

public static final int CAUSE_NOROUTETODDESTINATION 3

public static final int CAUSE_NOROUTETOTRANSITNET 2

public static final int CAUSE_NOUSERRESPONDING 18

public static final int CAUSE_NUMBERCHANGED 22

public static final int CAUSE_ONLYRDIVEARERCAPAVAIL 70

public static final int CAUSE_OUTBOUNDCONFERENCE 502

public static final int CAUSE_OUTBOUNDTRANSFER 501

public static final int CAUSE_OUTOFBANDWIDTH 125

public static final int CAUSE_PROTOCOLERRORUNSPECIFIED

111

public static final int CAUSE_QSIG_PR 511

com.cisco.jtapi.extensions.CiscoCallEv

F-8Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager Release 7.1(2)

OL-18531-01

Appendix F Constant Field Valuescom.cisco.*

CiscoCallSecurityStatusChangedEv

CiscoConferenceChainAddedEv

public static final int CAUSE_QUALOFSERVNAVAIL 49

public static final int CAUSE_QUIET_CLEAR 515

public static final int CAUSE_RECOVERYONTIMEREXPIRY 102

public static final int CAUSE_REDIRECTED 200

public static final int CAUSE_REQCALLIDHASBEENCLEARED

86

public static final int CAUSE_REQCIRCNAVIL 44

public static final int CAUSE_REQFACILITYNIMPL 69

public static final int CAUSE_REQFACILITYNOTSUBSCRIBED

50

public static final int CAUSE_RESOURCESNAVAIL 47

public static final int CAUSE_RESPONSETOSTATUSENQUIRY 30

public static final int CAUSE_SERVNOTAVAILUNSPECIFIED 63

public static final int CAUSE_SERVOPERATIONVIOLATED 53

public static final int CAUSE_SERVOROPTNAVAILORIMPL 79

public static final int CAUSE_SUBSCRIBERABSENT 20

public static final int CAUSE_SUSPCALLBUTNOTTHISONE 83

public static final int CAUSE_SWITCHINGEQUIPMENTCONGESTION

42

public static final int CAUSE_TEMPORARYFAILURE 41

public static final int CAUSE_UNALLOCATEDNUMBER 1

public static final int CAUSE_USERBUSY 17

com.cisco.jtapi.extensions.CiscoCallSecurityStatusChangedEv

public static final int ID 1073754129

com.cisco.jtapi.extensions.CiscoConferenceChainAddedEv

public static final int ID 1073754121

com.cisco.jtapi.extensions.CiscoCallEv

F-9Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager Release 7.1(2)

OL-18531-01

Appendix F Constant Field Valuescom.cisco.*

CiscoConferenceChainRemovedEv

CiscoConferenceEndEv

CiscoConferenceStartEv

CiscoConnection

com.cisco.jtapi.extensions.CiscoConferenceChainRemovedEv

public static final int ID 1073754128

com.cisco.jtapi.extensions.CiscoConferenceEndEv

public static final int ID 1073754114

com.cisco.jtapi.extensions.CiscoConferenceStartEv

public static final int ID 1073754115

com.cisco.jtapi.extensions.CiscoConnection

public static final int ADDRESS_SEARCH_SPACE 2

public static final int CALLED_ADDRESS_DEFAULT 0

public static final int CALLED_ADDRESS_SET_TO_PREFERREDCALLEDPARTY

2

public static final int CALLED_ADDRESS_SET_TO_REDIRECT_DESTINATION

1

public static final int CALLED_ADDRESS_UNCHANGED 0

public static final int CALLINGADDRESS_SEARCH_SPACE 1

public static final int DEFAULT_SEARCH_SPACE 0

public static final int REASON_DIRECTCALL 1

public static final int REASON_FORWARDALL 5

public static final int REASON_FORWARDBUSY 4

public static final int REASON_FORWARDNOANSWER 3

public static final int REASON_OUTBOUND 99

public static final int REASON_REDIRECT 6

public static final int REASON_TRANSFERREDCALL 2

public static final int REDIRECT_DROP_ON_FAILURE 1

public static final int REDIRECT_NORMAL 2

F-10Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager Release 7.1(2)

OL-18531-01

Appendix F Constant Field Valuescom.cisco.*

CiscoConsultCallActiveEv

CiscoFeatureReason

com.cisco.jtapi.extensions.CiscoConsultCallActiveEv

public static final int ID 1073754116

com.cisco.jtapi.extensions.CiscoFeatureReason

public static final int REASON_BARGE 20

public static final int REASON_BLINDTRANSFER 7

public static final int REASON_CALLPICKUP 11

public static final int REASON_CCM_REDIRECTION 26

public static final int REASON_CLICK_TO_CONFERENCE 39

public static final int REASON_CONFERENCE 9

public static final int REASON_DPARK_CALLPARK 27

public static final int REASON_DPARK_REVERSION 28

public static final int REASON_DPARK_UNPARK 29

public static final int REASON_FAC_CMC 22

public static final int REASON_FORWARDALL 5

public static final int REASON_FORWARDBUSY 4

public static final int REASON_FORWARDNOANSWER 3

public static final int REASON_IMMDIVERT 21

public static final int REASON_MOBILITY 33

public static final int REASON_MOBILITY_CELLPICKUP 35

public static final int REASON_MOBILITY_FOLLOWME 38

public static final int REASON_MOBILITY_HANDIN 36

public static final int REASON_MOBILITY_HANDOUT 37

public static final int REASON_MOBILITY_IVR 34

public static final int REASON_NORMAL 12

public static final int REASON_PARK 10

public static final int REASON_PARKREMAINDER 15

public static final int REASON_PARKREMINDER 15

public static final int REASON_QSIG_PR 23

public static final int REASON_REDIRECT 6

public static final int REASON_REFER 24

public static final int REASON_REPLACE 25

public static final int REASON_SILENTMONITORING 31

F-11Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager Release 7.1(2)

OL-18531-01

Appendix F Constant Field Valuescom.cisco.*

CiscoG711MediaCapability

CiscoG723MediaCapability

CiscoG729MediaCapability

CiscoGSMMediaCapability

public static final int REASON_TRANSFER 2

public static final int REASON_UNPARK 16

com.cisco.jtapi.extensions.CiscoG711MediaCapability

public static final int FRAMESIZE_SIXTY_MILLISECOND_PACKET 60

public static final int FRAMESIZE_THIRTY_MILLISECOND_PACKET 30

public static final int FRAMESIZE_TWENTY_MILLISECOND_PACKET 20

com.cisco.jtapi.extensions.CiscoG723MediaCapability

public static final int FRAMESIZE_SIXTY_MILLISECOND_PACKET 60

public static final int FRAMESIZE_THIRTY_MILLISECOND_PACKET 30

public static final int FRAMESIZE_TWENTY_MILLISECOND_PACKET 20

com.cisco.jtapi.extensions.CiscoG729MediaCapability

public static final int FRAMESIZE_SIXTY_MILLISECOND_PACKET 60

public static final int FRAMESIZE_THIRTY_MILLISECOND_PACKET 30

public static final int FRAMESIZE_TWENTY_MILLISECOND_PACKET 20

com.cisco.jtapi.extensions.CiscoGSMMediaCapability

public static final int FRAMESIZE_EIGHTY_MILLISECOND_PACKET 80

com.cisco.jtapi.extensions.CiscoFeatureReason

F-12Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager Release 7.1(2)

OL-18531-01

Appendix F Constant Field Valuescom.cisco.*

CiscoJtapiException

com.cisco.jtapi.extensions.CiscoJtapiException

public static final int ASSOCIATED_LINE_NOT_OPEN -1932787685

public static final int CALL_ALREADY_EXISTS -1932787705

public static final int CALL_DROPPED -1932787564

public static final int CALLHANDLE_NOTINCOMINGCALL -1932787702

public static final int CALLHANDLE_UNKNOWN_TO_LINECONTROL -1932787644

public static final int CANNOT_OPEN_DEVICE -1932787647

public static final int CANNOT_TERMINATE_MEDIA_ON_PHONE -1932787690

public static final int CFWDALL_ALREADY_SET -1932787597

public static final int CFWDALL_DESTN_INVALID -1932787596

public static final int CLUSTER_LINK_FAILURE -1932787612

public static final int COMMAND_NOT_IMPLEMENTED_ON_DEVICE -1932787559

public static final int CONFERENCE_ALREADY_PRESENT -1932787588

public static final int CONFERENCE_FAILED -1932787590

public static final int CONFERENCE_FULL -1932787642

public static final int CONFERENCE_INACTIVE -1932787587

public static final int CONFERENCE_INVALID_PARTICIPANT -1932787589

public static final int CTIERR_ACCESS_TO_DEVICE_DENIED -1932787688

public static final int CTIERR_APP_SOFTKEYS_ALREADY_CONTROLLED

-1932787679

public static final int CTIERR_APPLICATION_DATA_SIZE_EXCEEDED -1932787675

public static final int CTIERR_BIB_NOT_CONFIGURED -1932787476

public static final int CTIERR_BIB_RESOURCE_NOT_AVAILABLE -1932787489

public static final int CTIERR_CALL_MANAGER_NOT_AVAILABLE -1932787689

public static final int CTIERR_CALL_NOT_EXISTED -1932787533

public static final int CTIERR_CALL_PARK_NO_DN -1932787579

public static final int CTIERR_CALL_REQUEST_ALREADY_OUTSTANDING

-1932787577

public static final int CTIERR_CALL_UNPARK_FAILED -1932787583

public static final int CTIERR_CAPABILITIES_DO_NOT_MATCH -1932787518

public static final int CTIERR_CLOSE_DELAY_NOT_SUPPORTED_WITH_REG_TYPE

-1932787673

public static final int CTIERR_CONFERENCE_ALREADY_EXISTED -1932787535

public static final int CTIERR_CONFERENCE_NOT_EXISTED -1932787534

public static final int CTIERR_CONNECTION_ON_INVALID_PORT -1932787503

public static final int CTIERR_CONSULT_CALL_FAILURE -1932787576

F-13Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager Release 7.1(2)

OL-18531-01

Appendix F Constant Field Valuescom.cisco.*

public static final int CTIERR_CONSULTCALL_ALREADY_OUTSTANDING

-1932787640

public static final int CTIERR_CRYPTO_CAPABILITY_MISMATCH -1932787500

public static final int CTIERR_CTIHANDLER_PROCESS_CREATION_FAILED

-1932787515

public static final int CTIERR_DB_INITIALIZATION_ERROR -1932787494

public static final int CTIERR_DEVICE_ALREADY_OPENED -1932787552

public static final int CTIERR_DEVICE_NOT_OPENED_YET -1932787551

public static final int CTIERR_DEVICE_OWNER_ALIVE_TIMER_STARTED

-1932787517

public static final int CTIERR_DEVICE_REGISTRATION_FAILED_NOT_SUPPORTED_MEDIATYPE

-1932787490

public static final int CTIERR_DEVICE_RESTRICTED -1932787502

public static final int CTIERR_DEVICE_SHUTTING_DOWN -1932787558

public static final int CTIERR_DIRECTORY_LOGIN_TIMEOUT -1932787595

public static final int CTIERR_DUPLICATE_CALL_REFERENCE -1932787529

public static final int CTIERR_DYNREG_IPADDRMODE_MISMATCH -1932787468

public static final int CTIERR_FAC_CMC_REASON_CMC_INVALID -1932787506

public static final int CTIERR_FAC_CMC_REASON_CMC_NEEDED -1932787509

public static final int CTIERR_FAC_CMC_REASON_FAC_CMC_NEEDED

-1932787508

public static final int CTIERR_FAC_CMC_REASON_FAC_INVALID -1932787507

public static final int CTIERR_FAC_CMC_REASON_FAC_NEEDED -1932787510

public static final int CTIERR_FEATURE_ALREADY_REGISTERED -1932787575

public static final int CTIERR_FEATURE_DATA_REJECT -1932787565

public static final int CTIERR_FEATURE_SELECT_FAILED -1932787514

public static final int CTIERR_ILLEGAL_DEVICE_TYPE -1932787578

public static final int CTIERR_INCOMPATIBLE_AUTOINSTALL_PROTOCOL_VERSION

-1932787629

public static final int CTIERR_INCORRECT_MEDIA_CAPABILITY -1932787560

public static final int CTIERR_INFORMATION_NOT_AVAILABLE -1932787677

public static final int CTIERR_INTERCOM_SPEEDDIAL_ALREADY_CONFIGURED

-1932787475

public static final int CTIERR_INTERCOM_SPEEDDIAL_ALREADY_SET

-1932787493

public static final int CTIERR_INTERCOM_SPEEDDIAL_DESTN_INVALID

-1932787492

public static final int CTIERR_INTERCOM_TALKBACK_ALREADY_PENDING

-1932787474

public static final int CTIERR_INTERCOM_TALKBACK_FAILURE -1932787491

com.cisco.jtapi.extensions.CiscoJtapiException

F-14Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager Release 7.1(2)

OL-18531-01

Appendix F Constant Field Valuescom.cisco.*

public static final int CTIERR_INTERNAL_FAILURE -1932787568

public static final int CTIERR_INVALID_CALLID -1932787487

public static final int CTIERR_INVALID_DEVICE_NAME -1932787678

public static final int CTIERR_INVALID_DTMFDIGITS -1932787561

public static final int CTIERR_INVALID_FILTER_SIZE -1932787625

public static final int CTIERR_INVALID_MEDIA_DEVICE -1932787674

public static final int CTIERR_INVALID_MEDIA_PARAMETER -1932787554

public static final int CTIERR_INVALID_MEDIA_PROCESS -1932787519

public static final int CTIERR_INVALID_MEDIA_RESOURCE_ID -1932787557

public static final int CTIERR_INVALID_MESSAGE_HEADER_INFO -1932787627

public static final int CTIERR_INVALID_MESSAGE_LENGTH -1932787628

public static final int CTIERR_INVALID_MONITOR_DESTN -1932787486

public static final int CTIERR_INVALID_MONITOR_DN_TYPE -1932787580

public static final int CTIERR_INVALID_MONITORMODE -1932787473

public static final int CTIERR_INVALID_PARAMETER -1932787532

public static final int CTIERR_INVALID_PARK_DN -1932787582

public static final int CTIERR_INVALID_PARK_REGISTRATION_HANDLE

-1932787581

public static final int CTIERR_INVALID_RESOURCE_TYPE -1932787530

public static final int CTIERR_IPADDRMODE_MISMATCH -1932787469

public static final int CTIERR_LINE_OUT_OF_SERVICE -1932787594

public static final int CTIERR_LINE_RESTRICTED -1932787501

public static final int CTIERR_MAXCALL_LIMIT_REACHED -1932787516

public static final int CTIERR_MEDIA_ALREADY_TERMINATED_DYNAMIC

-1932787548

public static final int CTIERR_MEDIA_ALREADY_TERMINATED_NONE

-1932787550

public static final int CTIERR_MEDIA_ALREADY_TERMINATED_STATIC

-1932787549

public static final int CTIERR_MEDIA_CAPABILITY_MISMATCH -1932787553

public static final int CTIERR_MEDIA_RESOURCE_NAME_SIZE_EXCEEDED

-1932787676

public static final int CTIERR_MEDIAREGISTRATIONTYPE_DO_NOT_MATCH

-1932787567

public static final int CTIERR_MESSAGE_TOO_BIG -1932787626

public static final int CTIERR_MORE_ACTIVE_CALLS_THAN_RESERVED

-1932787531

public static final int CTIERR_NO_EXISTING_CALLS -1932787512

public static final int CTIERR_NO_EXISTING_CONFERENCE -1932787527

com.cisco.jtapi.extensions.CiscoJtapiException

F-15Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager Release 7.1(2)

OL-18531-01

Appendix F Constant Field Valuescom.cisco.*

public static final int CTIERR_NO_RECORDING_SESSION -1932787479

public static final int CTIERR_NO_RESPONSE_FROM_MP -1932787526

public static final int CTIERR_NOT_PRESERVED_CALL -1932787528

public static final int CTIERR_OPERATION_FAILED_QUIETCLEAR -1932787566

public static final int CTIERR_OPERATION_NOT_ALLOWED -1932787555

public static final int CTIERR_OUT_OF_BANDWIDTH -1932787498

public static final int CTIERR_OWNER_NOT_ALIVE -1932787547

public static final int CTIERR_PENDING_ACCEPT_OR_ANSWER_REQUEST

-1932787520

public static final int CTIERR_PENDING_START_MONITORING_REQUEST

-1932787485

public static final int CTIERR_PENDING_START_RECORDING_REQUEST

-1932787483

public static final int CTIERR_PENDING_STOP_RECORDING_REQUEST

-1932787482

public static final int CTIERR_PRIMARY_CALL_INVALID -1932787471

public static final int CTIERR_PRIMARY_CALL_STATE_INVALID -1932787470

public static final int CTIERR_RECORDING_ALREADY_INPROGRESS -1932787480

public static final int CTIERR_RECORDING_CONFIG_NOT_MATCHING

-1932787477

public static final int CTIERR_RECORDING_SESSION_INACTIVE -1932787478

public static final int CTIERR_REDIRECT_UNAUTHORIZED_COMMAND_USAGE

-1932787513

public static final int CTIERR_REGISTER_FEATURE_ACTIVATION_FAILED

-1932787585

public static final int CTIERR_REGISTER_FEATURE_APP_ALREADY_REGISTERED

-1932787523

public static final int CTIERR_REGISTER_FEATURE_PROVIDER_NOT_REGISTERED

-1932787524

public static final int CTIERR_RESOURCE_NOT_AVAILABLE -1932787536

public static final int CTIERR_START_MONITORING_FAILED -1932787484

public static final int CTIERR_START_RECORDING_FAILED -1932787481

public static final int CTIERR_STATION_SHUT_DOWN -1932787574

public static final int CTIERR_SYSTEM_ERROR -1932787525

public static final int CTIERR_UDP_PASS_THROUGH_NOT_SUPPORTED

-1932787638

public static final int CTIERR_UNKNOWN_EXCEPTION -1932787556

public static final int CTIERR_UNSUPPORTED_CALL_PARK_TYPE -1932787584

public static final int CTIERR_UNSUPPORTED_CFWD_TYPE -1932787511

public static final int CTIERR_USER_NOT_AUTH_FOR_SECURITY -1932787504

com.cisco.jtapi.extensions.CiscoJtapiException

F-16Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager Release 7.1(2)

OL-18531-01

Appendix F Constant Field Valuescom.cisco.*

public static final int DARES_INVALID_REQ_TYPE -1932787591

public static final int DATA_SIZE_LIMIT_EXCEEDED -1932787681

public static final int DB_ERROR -1932787691

public static final int DB_ILLEGAL_DEVICE_TYPE -1932787692

public static final int DB_NO_MORE_DEVICES -1932787694

public static final int DESTINATION_BUSY -1897005054

public static final int DESTINATION_UNKNOWN -1897005055

public static final int DEVICE_ALREADY_REGISTERED -1932787693

public static final int DEVICE_NOT_OPEN -1932787686

public static final int DEVICE_OUT_OF_SERVICE -1932787593

public static final int DIGIT_GENERATION_ALREADY_IN_PROGRESS -1932787610

public static final int DIGIT_GENERATION_CALLSTATE_CHANGED -1932787607

public static final int DIGIT_GENERATION_WRONG_CALL_HANDLE -1932787609

public static final int DIGIT_GENERATION_WRONG_CALL_STATE -1932787608

public static final int DIRECTORY_LOGIN_FAILED -1932787616

public static final int DIRECTORY_LOGIN_NOT_ALLOWED -1932787617

public static final int DIRECTORY_TEMPORARY_UNAVAILABLE -1932787618

public static final int EXISTING_FIRSTPARTY -1932787709

public static final int HOLDFAILED -1932787697

public static final int ILLEGAL_CALLINGPARTY -1932787706

public static final int ILLEGAL_CALLSTATE -1932787703

public static final int ILLEGAL_HANDLE -1932787708

public static final int ILLEGAL_MESSAGE_FORMAT -1932787630

public static final int INCOMPATIBLE_PROTOCOL_VERSION -1932787632

public static final int INVALID_LINE_HANDLE -1932787599

public static final int INVALID_RING_OPTION -1932787680

public static final int LINE_GREATER_THAN_MAX_LINE -1932787606

public static final int LINE_INFO_DOES_NOT_EXIST -1932787611

public static final int LINE_NOT_PRIMARY -1932787598

public static final int LINECONTROL_FAILURE -1932787704

public static final int MAX_NUMBER_OF_CTI_CONNECTIONS_REACHED

-1932787641

public static final int MSGWAITING_DESTN_INVALID -1932787592

public static final int NO_ACTIVE_DEVICE_FOR_THIRDPARTY -1932787710

public static final int NO_CONFERENCE_BRIDGE -1932787639

public static final int NOT_INITIALIZED -1932787613

public static final int PROTOCOL_TIMEOUT -1091584273

public static final int PROVIDER_ALREADY_OPEN -1932787614

com.cisco.jtapi.extensions.CiscoJtapiException

F-17Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager Release 7.1(2)

OL-18531-01

Appendix F Constant Field Valuescom.cisco.*

public static final int PROVIDER_CLOSED -559038737

public static final int PROVIDER_NOT_OPEN -1932787615

public static final int REDIRECT_CALL_CALL_TABLE_FULL -1932787662

public static final int REDIRECT_CALL_DESTINATION_BUSY -1932787649

public static final int REDIRECT_CALL_DESTINATION_OUT_OF_ORDER

-1932787648

public static final int REDIRECT_CALL_DIGIT_ANALYSIS_TIMEOUT -1932787659

public static final int REDIRECT_CALL_DOES_NOT_EXIST -1932787683

public static final int REDIRECT_CALL_INCOMPATIBLE_STATE -1932787654

public static final int REDIRECT_CALL_MEDIA_CONNECTION_FAILED

-1932787658

public static final int REDIRECT_CALL_NORMAL_CLEARING -1932787651

public static final int REDIRECT_CALL_ORIGINATOR_ABANDONED -1932787656

public static final int REDIRECT_CALL_PARTY_TABLE_FULL -1932787657

public static final int REDIRECT_CALL_PENDING_REDIRECT_TRANSACTION

-1932787653

public static final int REDIRECT_CALL_PROTOCOL_ERROR -1932787661

public static final int REDIRECT_CALL_UNKNOWN_DESTINATION -1932787660

public static final int REDIRECT_CALL_UNKNOWN_ERROR -1932787652

public static final int REDIRECT_CALL_UNKNOWN_PARTY -1932787655

public static final int REDIRECT_CALL_UNRECOGNIZED_MANAGER -1932787650

public static final int REDIRECT_CALLINFO_ERR -1932787664

public static final int REDIRECT_ERR -1932787663

public static final int RETRIEVEFAILED -1932787695

public static final int RETRIEVEFAILED_ACTIVE_CALL_ON_LINE -1932787600

public static final int SSAPI_NOT_REGISTERED -1932787684

public static final int TIMEOUT -1932787711

public static final int TRANSFER_INACTIVE -1932787586

public static final int TRANSFERFAILED -1932787698

public static final int TRANSFERFAILED_CALLCONTROL_TIMEOUT -1932787645

public static final int TRANSFERFAILED_DESTINATION_BUSY -1932787699

public static final int TRANSFERFAILED_DESTINATION_UNALLOCATED

-1932787701

public static final int TRANSFERFAILED_OUTSTANDING_TRANSFER -1932787646

public static final int UNDEFINED_LINE -1932787707

public static final int UNKNOWN_GLOBAL_CALL_HANDLE -1932787687

public static final int UNRECOGNIZABLE_PDU -1932787631

public static final int UNSPECIFIED 0

com.cisco.jtapi.extensions.CiscoJtapiException

F-18Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager Release 7.1(2)

OL-18531-01

Appendix F Constant Field Valuescom.cisco.*

CiscoLocales

com.cisco.jtapi.extensions.CiscoLocales

public static final int LOCALE_ARABIC_ALGERIA 47

public static final int LOCALE_ARABIC_BAHRAIN 48

public static final int LOCALE_ARABIC_EGYPT 49

public static final int LOCALE_ARABIC_IRAQ 50

public static final int LOCALE_ARABIC_JORDAN 51

public static final int LOCALE_ARABIC_KUWAIT 38

public static final int LOCALE_ARABIC_LEBANON 52

public static final int LOCALE_ARABIC_MOROCCO 53

public static final int LOCALE_ARABIC_OMAN 36

public static final int LOCALE_ARABIC_QATAR 54

public static final int LOCALE_ARABIC_SAUDI_ARABIA 37

public static final int LOCALE_ARABIC_TUNISIA 55

public static final int LOCALE_ARABIC_UNITED_ARAB_EMIRATES 35

public static final int LOCALE_ARABIC_YEMEN 56

public static final int LOCALE_BULGARIAN_BULGARIA 27

public static final int LOCALE_CATALAN_SPAIN 32

public static final int LOCALE_CHINESE_HONG_KONG 24

public static final int LOCALE_CROATIAN_CROATIA 28

public static final int LOCALE_CZECH_CZECH_REPUBLIC 26

public static final int LOCALE_DANISH_DENMARK 12

public static final int LOCALE_DUTCH_NETHERLAND 8

public static final int LOCALE_ENGLISH_UNITED_KINGDOM 33

public static final int LOCALE_ENGLISH_UNITED_STATES 1

public static final int LOCALE_FINNISH_FINLAND 22

public static final int LOCALE_FRENCH_FRANCE 2

public static final int LOCALE_GERMAN_GERMANY 3

public static final int LOCALE_GREEK_GREECE 16

public static final int LOCALE_HEBREW_ISRAEL 39

public static final int LOCALE_HUNGARIAN_HUNGARY 14

public static final int LOCALE_ITALIAN_ITALY 7

public static final int LOCALE_JAPANESE_JAPAN 13

public static final int LOCALE_KOREAN_KOREA 21

public static final int LOCALE_NORWEGIAN_NORWAY 9

public static final int LOCALE_POLISH_POLAND 15

public static final int LOCALE_PORTUGUESE_BRAZIL 23

F-19Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager Release 7.1(2)

OL-18531-01

Appendix F Constant Field Valuescom.cisco.*

CiscoMediaConnectionMode

CiscoMediaEncryptionAlgorithmType

CiscoMediaOpenLogicalChannelEv

public static final int LOCALE_PORTUGUESE_PORTUGAL 10

public static final int LOCALE_ROMANIAN_ROMANIA 30

public static final int LOCALE_RUSSIAN_RUSSIA 5

public static final int LOCALE_SERBIAN_REPUBLIC_OF_MONTENEGRO

41

public static final int LOCALE_SERBIAN_REPUBLIC_OF_SERBIA 40

public static final int LOCALE_SIMPLIFIED_CHINESE_CHINA 20

public static final int LOCALE_SLOVAK_SLOVAKIA 25

public static final int LOCALE_SLOVENIAN_SLOVENIA 29

public static final int LOCALE_SPANISH_SPAIN 6

public static final int LOCALE_SWEDISH_SWEDEN 11

public static final int LOCALE_THAI_THAILAND 42

public static final int LOCALE_TRADITIONAL_CHINESE_CHINA 19

com.cisco.jtapi.extensions.CiscoMediaConnectionMode

public static final int NONE 0

public static final int RECEIVE_ONLY 1

public static final int TRANSMIT_AND_RECEIVE 3

public static final int TRANSMIT_ONLY 2

com.cisco.jtapi.extensions.CiscoMediaEncryptionAlgorithmType

public static final int AES_128_COUNTER 1

com.cisco.jtapi.extensions.CiscoMediaOpenLogicalChannelEv

public static final int ID 1073758213

com.cisco.jtapi.extensions.CiscoLocales

F-20Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager Release 7.1(2)

OL-18531-01

Appendix F Constant Field Valuescom.cisco.*

CiscoMediaSecurityIndicator

CiscoOutOfServiceEv

CiscoPartyInfo

com.cisco.jtapi.extensions.CiscoMediaSecurityIndicator

public static final int MEDIA_ENCRYPT_KEYS_AVAILABLE 0

public static final int MEDIA_ENCRYPT_KEYS_UNAVAILABLE 2

public static final int MEDIA_ENCRYPT_USER_NOT_AUTHORIZED 1

public static final int MEDIA_NOT_ENCRYPTED 3

com.cisco.jtapi.extensions.CiscoOutOfServiceEv

public static final int CAUSE_CALLMANAGER_FAILURE 1001

public static final int CAUSE_CTIMANAGER_FAILURE 1007

public static final int CAUSE_DEVICE_FAILURE 1004

public static final int CAUSE_DEVICE_RESTRICTED 1008

public static final int CAUSE_DEVICE_UNREGISTERED 1005

public static final int CAUSE_LINE_RESTRICTED 1009

public static final int CAUSE_NOCALLMANAGER_AVAILABLE 1003

public static final int CAUSE_REHOME_TO_HIGHER_PRIORITY_CM 1002

public static final int CAUSE_REHOMING_FAILURE 1006

public static final int ID 1073750021

com.cisco.jtapi.extensions.CiscoPartyInfo

public static final int ABBREVIATED_NUMBER 6

public static final int INTERNATIONAL_NUMBER 1

public static final int NATIONAL_NUMBER 2

public static final int NET_SPECIFIC_NUMBER 3

public static final int RESERVED_FOR_EXTENSION 7

public static final int SUBSCRIBER_NUMBER 4

public static final int UNKNOWN_NUMBER 0

F-21Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager Release 7.1(2)

OL-18531-01

Appendix F Constant Field Valuescom.cisco.*

CiscoProvCallParkEv

CiscoProvFeatureID

CiscoProviderCapabilityChangedEv

CiscoProvTerminalCapabilityChangedEv

com.cisco.jtapi.extensions.CiscoProvCallParkEv

public static final int ID 1073754113

public static final int PARK_STATE_ACTIVE 2

public static final int PARK_STATE_IDLE 1

public static final int REASON_CALLPARK 1

public static final int REASON_CALLPARKREMAINDER 3

public static final int REASON_CALLPARKREMINDER 3

public static final int REASON_CALLUNPARK 2

com.cisco.jtapi.extensions.CiscoProvFeatureID

public static final int MONITOR_CALLPARK_DN 1234

com.cisco.jtapi.extensions.CiscoProviderCapabilityChangedEv

public static final int ID 1073741846

public static final int MODIFY_CGPN 32

public static final int MONITOR_PARKDN 64

public static final int SUPERPROVIDER 16

com.cisco.jtapi.extensions.CiscoProvTerminalCapabilityChangedEv

public static final int ID 1073741847

F-22Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager Release 7.1(2)

OL-18531-01

Appendix F Constant Field Valuescom.cisco.*

CiscoRestrictedEv

CiscoRouteSession

com.cisco.jtapi.extensions.CiscoRestrictedEv

public static final int CAUSE_UNKNOWN 0

public static final int CAUSE_UNSUPPORTED_DEVICE_CONFIGURATION

3

public static final int CAUSE_UNSUPPORTED_PROTOCOL 2

public static final int CAUSE_USER_RESTRICTED 1

public static final int ID 1073741833

com.cisco.jtapi.extensions.CiscoRouteSession

public static final int

public static final int CALLINGADDRESS_SEARCH_SPACE 1

public static final int CAUSE_CTIERR_FAC_CMC_REASON_CMC_INVALID

-1932787506

public static final int CAUSE_CTIERR_FAC_CMC_REASON_CMC_NEEDED

-1932787509

public static final int CAUSE_CTIERR_FAC_CMC_REASON_FAC_CMC_NEEDED

-1932787508

public static final int CAUSE_CTIERR_FAC_CMC_REASON_FAC_INVALID

-1932787507

public static final int CAUSE_CTIERR_FAC_CMC_REASON_FAC_NEEDED

-1932787510

public static final int DEFAULT_SEARCH_SPACE 0

public static final int DONOT_RESET_ORIGINALCALLED 0

public static final int ERROR_INVALID_STATE 7

public static final int ERROR_NO_CALLBACK 6

public static final int ERROR_NONE 4

public static final int ERROR_ROUTESELECT_TIMEOUT 5

public static final int RESET_ORIGINALCALLED 1

public static final int ROUTEADDRESS_SEARCH_SPACE 2

F-23Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager Release 7.1(2)

OL-18531-01

Appendix F Constant Field Valuescom.cisco.*

CiscoRouteTerminal

CiscoRTPBitRate

CiscoRTPInputKeyEv

CiscoRTPInputStartedEv

CiscoRTPInputStoppedEv

CiscoRTPOutputKeyEv

com.cisco.jtapi.extensions.CiscoRouteTerminal

public static final int DYNAMIC_MEDIA_REGISTRATION 2

public static final int NO_MEDIA_REGISTRATION 0

com.cisco.jtapi.extensions.CiscoRTPBitRate

public static final int R5_3 1

public static final int R6_4 2

com.cisco.jtapi.extensions.CiscoRTPInputKeyEv

public static final int ID 1073758214

com.cisco.jtapi.extensions.CiscoRTPInputStartedEv

public static final int ID 1073758209

com.cisco.jtapi.extensions.CiscoRTPInputStoppedEv

public static final int ID 1073758210

com.cisco.jtapi.extensions.CiscoRTPOutputKeyEv

public static final int ID 1073758215

F-24Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager Release 7.1(2)

OL-18531-01

Appendix F Constant Field Valuescom.cisco.*

CiscoRTPOutputStartedEv

CiscoRTPOutputStoppedEv

CiscoRTPPayload

com.cisco.jtapi.extensions.CiscoRTPOutputStartedEv

public static final int ID 1073758211

com.cisco.jtapi.extensions.CiscoRTPOutputStartedEv

public static final int ID 1073758212

com.cisco.jtapi.extensions.CiscoRTPPayload

public static final int ACTIVEVOICE 81

public static final int ACY_G729AASSN 15

public static final int DATA56 33

public static final int DATA64 32

public static final int G711ALAW56K 3

public static final int G711ALAW64K 2

public static final int G711ULAW56K 5

public static final int G711ULAW64K 4

public static final int G722_48K 8

public static final int G722_56K 7

public static final int G722_64K 6

public static final int G7231 9

public static final int G728 10

public static final int G729 11

public static final int G729ANNEXA 12

public static final int GSM 80

public static final int IS11172AUDIOCAP 13

public static final int IS13818AUDIOCAP 14

public static final int NONSTANDARD 1

public static final int WIDEBAND_256K 25

F-25Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager Release 7.1(2)

OL-18531-01

Appendix F Constant Field Valuescom.cisco.*

CiscoTermActivatedEv

CiscoTermButtonPressedEv

CiscoTermConnMonitoringEndEv

CiscoTermConnMonitoringStartEv

com.cisco.jtapi.extensions.CiscoTermActivatedEv

public static final int ID 1073741843

com.cisco.jtapi.extensions.CiscoTermButtonPressedEv

public static final int CHARA 10

public static final int CHARB 11

public static final int CHARC 12

public static final int CHARD 13

public static final int EIGHT 8

public static final int FIVE 5

public static final int FOUR 4

public static final int ID 1073745936

public static final int NINE 9

public static final int ONE 1

public static final int POUND 15

public static final int SEVEN 7

public static final int SIX 6

public static final int STAR 14

public static final int THREE 3

public static final int TWO 2

public static final int ZERO 0

com.cisco.jtapi.extensions.CiscoTermConnMonitoringEndEv

public static final int ID 1073762311

com.cisco.jtapi.extensions.CiscoTermConnMonitoringStartEv

public static final int ID 1073762310

F-26Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager Release 7.1(2)

OL-18531-01

Appendix F Constant Field Valuescom.cisco.*

CiscoTermConnMonitorInitiatorInfoEv

CiscoTermConnMonitorTargetInfoEv

CiscoTermConnPrivacyChangedEv

CiscoTermConnRecordingEndEv

CiscoTermConnRecordingStartEv

CiscoTermConnRecordingTargetInfoEv

com.cisco.jtapi.extensions.CiscoTermConnMonitorInitiatorInfoEv

public static final int ID 1073762313

com.cisco.jtapi.extensions.CiscoTermConnMonitorTargetInfoEv

public static final int ID 1073762314

com.cisco.jtapi.extensions.CiscoTermConnPrivacyChangedEv

public static final int ID 1073762305

com.cisco.jtapi.extensions.CiscoTermConnRecordingEndEv

public static final int ID 1073762309

com.cisco.jtapi.extensions.CiscoTermConnRecordingStartEv

public static final int ID 1073762308

com.cisco.jtapi.extensions.CiscoTermConnRecordingTargetInfoEv

public static final int ID 1073762312

F-27Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager Release 7.1(2)

OL-18531-01

Appendix F Constant Field Valuescom.cisco.*

CiscoTermConnSelectChangedEv

CiscoTermCreatedEv

CiscoTermDataEv

CiscoTermDeviceStateActiveEv

CiscoTermDeviceStateAlertingEv

CiscoTermDeviceStateHeldEv

com.cisco.jtapi.extensions.CiscoTermConnSelectChangedEv

public static final int ID 1073762307

com.cisco.jtapi.extensions.CiscoTermCreatedEv

public static final int ID 1073745921

com.cisco.jtapi.extensions.CiscoTermDataEv

public static final int ID 1073745922

com.cisco.jtapi.extensions.CiscoTermDeviceStateActiveEv

public static final int ID 1073745926

com.cisco.jtapi.extensions.CiscoTermDeviceStateAlertingEv

public static final int ID 1073745927

com.cisco.jtapi.extensions.CiscoTermDeviceStateHeldEv

public static final int ID 1073745928

F-28Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager Release 7.1(2)

OL-18531-01

Appendix F Constant Field Valuescom.cisco.*

CiscoTermDeviceStateIdleEv

CiscoTermDeviceStateWhisperEv

CiscoTermDNDOptionChangedEv

CiscoTermDNDStatusChangedEv

CiscoTerminal

com.cisco.jtapi.extensions.CiscoTermDeviceStateIdleEv

public static final int ID 1073745929

com.cisco.jtapi.extensions.CiscoTermDeviceStateWhisperEv

public static final int ID 1073745941

com.cisco.jtapi.extensions.CiscoTermDNDOptionChangedEv

public static final int ID 1073745942

com.cisco.jtapi.extensions.CiscoTermDNDStatusChangedEv

public static final int ID 1073745940

com.cisco.jtapi.extensions.CiscoTerminal

public static final int ASCII_ENCODING 2

public static final int DEVICESTATE_ACTIVE 1

public static final int DEVICESTATE_ALERTING 2

public static final int DEVICESTATE_HELD 3

public static final int DEVICESTATE_IDLE 0

public static final int DEVICESTATE_UNKNOWN 4

public static final int DEVICESTATE_WHISPER 5

public static final int DND_OPTION_CALL_REJECT 2

public static final int DND_OPTION_NONE 0

public static final int DND_OPTION_RINGER_OFF 1

public static final int IN_SERVICE 1

F-29Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager Release 7.1(2)

OL-18531-01

Appendix F Constant Field Valuescom.cisco.*

CiscoTerminalConnection

CiscoTerminalProtocol

CiscoTermInServiceEv

CiscoTermOutOfServiceEv

public static final int IP_ADDRESSING_MODE_IPV4 0

public static final int IP_ADDRESSING_MODE_IPV4_V6 2

public static final int IP_ADDRESSING_MODE_IPV6 1

public static final int IP_ADDRESSING_MODE_UNKNOWN 3

public static final int IP_ADDRESSING_MODE_UNKNOWN_ANATRED 4

public static final int NOT_APPLICABLE 1

public static final int OUT_OF_SERVICE 0

public static final int UCS2UNICODE_ENCODING 3

public static final int UNKNOWN_ENCODING 0

com.cisco.jtapi.extensions.CiscoTerminalConnection

public static final int CISCO_SELECTEDLOCAL 1

public static final int CISCO_SELECTEDNONE 0

public static final int CISCO_SELECTEDREMOTE 2

com.cisco.jtapi.extensions.CiscoTerminalProtocol

public static final int PROTOCOL_NONE 0

public static final int PROTOCOL_SCCP 1

public static final int PROTOCOL_SIP 2

com.cisco.jtapi.extensions.CiscoTermInServiceEv

public static final int ID 1073745923

com.cisco.jtapi.extensions.CiscoTermOutOfServiceEv

public static final int ID 1073745924

com.cisco.jtapi.extensions.CiscoTerminal

F-30Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager Release 7.1(2)

OL-18531-01

Appendix F Constant Field Valuescom.cisco.*

CiscoTermRegistrationFailedEv

CiscoTermRemovedEv

CiscoTermRestrictedEv

CiscoTermSnapshotCompletedEv

CiscoTermSnapshotEv

com.cisco.jtapi.extensions.CiscoTermRegistrationFailedEv

public static final int DB_INITIALIZATION_ERROR 15

public static final int ID 1073745937

public static final int IP_ADDRESSING_MODE_MISMATCH 19

public static final int MEDIA_ALREADY_TERMINATED_DYNAMIC 8

public static final int MEDIA_ALREADY_TERMINATED_NONE 6

public static final int MEDIA_ALREADY_TERMINATED_STATIC 7

public static final int MEDIA_CAPABILITY_MISMATCH 10

public static final int OWNER_NOT_ALIVE 11

public static final int UNKNOWN 0

com.cisco.jtapi.extensions.CiscoTermRemovedEv

public static final int ID 1073745925

com.cisco.jtapi.extensions.CiscoTermRestrictedEv

public static final int ID 1073741841

com.cisco.jtapi.extensions.CiscoTermSnapshotCompletedEv

public static final int ID 1073745939

com.cisco.jtapi.extensions.CiscoTermSnapshotCompletedEv

public static final int ID 1073745938

F-31Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager Release 7.1(2)

OL-18531-01

Appendix F Constant Field Valuescom.cisco.*

CiscoTone

CiscoToneChangedEv

CiscoTransferEndEv

CiscoTransferStartEv

CiscoUrlInfo

com.cisco.jtapi.extensions.CiscoTone

public static final int ZIPZIP 49

com.cisco.jtapi.extensions.CiscoToneChangedEv

public static final int CMC_REQUIRED 1

public static final int FAC_CMC_REQUIRED 2

public static final int FAC_REQUIRED 0

public static final int ID 1073754119

com.cisco.jtapi.extensions.CiscoTransferEndEv

public static final int ID 1073754117

com.cisco.jtapi.extensions.CiscoTransferStartEv

public static final int ID 1073754118

com.cisco.jtapi.extensions.CiscoUrlInfo

public static final int TRANSPORT_TYPE_TCP 1

public static final int TRANSPORT_TYPE_UDP 2

public static final int URL_TYPE_SIP 1

public static final int URL_TYPE_TEL 2

public static final int URL_TYPE_UNKNOWN 0

F-32Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager Release 7.1(2)

OL-18531-01

Appendix F Constant Field Valuescom.cisco.*

CiscoWideBandMediaCapability

Alarm

LogFileTraceWriter

com.cisco.jtapi.extensions.CiscoWideBandMediaCapability

public static final int FRAMESIZE_TEN_MILLISECOND_PACKET 10

com.cisco.services.alarm.Alarm

public static final int ALERTS 1

public static final int CRITICAL 2

public static final int DEBUGGING 7

public static final int EMERGENCIES 0

public static final int ERROR 3

public static final int HIGHEST_LEVEL 7

public static final int INFORMATIONAL 6

public static final int LOWEST_LEVEL 0

public static final int NO_SEVERITY -1

public static final int NOTIFICATION 5

public static final java.lang.String

UNKNOWN_MNEMONIC “UNK”

public static final int WARNING 4

com.cisco.services.tracing.LogFileTraceWriter

public static final java.lang.String

DEFAULT_FILE_NAME_BASE “trace”

public static final java.lang.String

DEFAULT_FILE_NAME_EXTENSION “log”

public static final char DIR_BASE_NAME_NUM_SEPERATOR 95

public static final int MIN_FILE_SIZE 10240

public static final int MIN_FILES 2

public static final int ROLLOVER_THRESHOLD 1024

F-33Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager Release 7.1(2)

OL-18531-01

Appendix F Constant Field Valuescom.cisco.*

Trace

com.cisco.services.tracing.Trace

public static final int ALERTS 1

public static final java.lang.String

ALERTS_TRACE_NAME “ALERTS”

public static final int CRITICAL 2

public static final java.lang.String

CRITICAL_TRACE_NAME “CRITICAL”

public static final int DEBUGGING 7

public static final java.lang.String

DEBUGGING_TRACE_NAME “DEBUGGING”

public static final int EMERGENCIES 0

public static final java.lang.String

EMERGENCIES_TRACE_NAME “EMERGENCIES”

public static final int ERROR 3

public static final java.lang.String

ERROR_TRACE_NAME “ERROR”

public static final int HIGHEST_LEVEL 7

public static final int INFORMATIONAL 6

public static final java.lang.String

INFORMATIONAL_TRACE_NAME “INFORMATIONAL”

public static final int LOWEST_LEVEL 0

public static final int NOTIFICATION 5

public static final java.lang.String

NOTIFICATION_TRACE_NAME “NOTIFICATION”

public static final int WARNING 4

public static final java.lang.String

WARNING_TRACE_NAME “WARNING”

F-34Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager Release 7.1(2)

OL-18531-01

Cisco Unified JTAPI Developers Guide for Cisco UnifOL-18531-01

A

P P E N D I X G Deprecated API

This appendix lists lists the APIs, fields, and methods that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.

Thi s appendix contains the following sections:

• Deprecated Interfaces, page G-1

• Deprecated Fields, page G-1

• Deprecated Methods, page G-2

Deprecated Interfaces

Deprecated Fields

Deprecated Interfaces

com.cisco.jtapi.extensions.CiscoRouteAddress

This interface has not been implemented.

Deprecated Fields

com.cisco.jtapi.extensions.CiscoProviderCapabilityChangedEv.MODIFY_CGPN

This constant is not returned by any interface, should not be used by application.

com.cisco.jtapi.extensions.CiscoProviderCapabilityChangedEv.MONITOR_PARKDN

This constant is not returned by any interface, should not be used by application.

com.cisco.jtapi.extensions.CiscoProvCallParkEv.REASON_CALLPARKREMAINDER

This interface is deprecated due to a spelling error. Use the new interface REASON_CALLPARKREMINDER.

G-1ied Communications Manager Release 7.1(2)

Appendix G Deprecated APIDeprecated Methods

Deprecated Methods

com.cisco.jtapi.extensions.CiscoFeatureReason.REASON_PARKREMAINDER

Use REASON_PARKREMINDER.

com.cisco.jtapi.extensions.CiscoProviderCapabilityChangedEv.SUPERPROVIDER

This constant is not returned by any interface, should not be used by application.

Deprecated Methods

com.cisco.jtapi.extensions.CiscoTermDataEv.getData()

Use byte[] getTermData

com.cisco.jtapi.extensions.CiscoJtapiException.getErrorDescription(int)

Use String getErrorDescription (); instead.

com.cisco.jtapi.extensions.CiscoJtapiException.getErrorName(int)

Use String getErrorName (); instead.

com.cisco.jtapi.extensions.CiscoConsultCallActiveEv.getHeldTerminalConnection()

Replaced by CiscoConsultCall.getConsultingTerminalConnection()

com.cisco.jtapi.extensions.CiscoCall.getLastRedirectingPartyInfo()

- use getLastRedirectedPartyInfo();

com.cisco.jtapi.extensions.CiscoAddress.getRegistrationState()

This method has been replaced by the getState() method.

com.cisco.jtapi.extensions.CiscoTerminal.getRegistrationState()

This method has been replaced by the getState() method.

com.cisco.jtapi.extensions.CiscoMediaTerminal.register(InetAddress, int)

com.cisco.jtapi.extensions.CiscoTerminal.sendData(String)

com.cisco.jtapi.extensions.CiscoJtapiProperties.setSecurityPropertyForInstance(String, String, String, String, String, String, String, String, boolean)

This method is replace by overloaded method setSecurityPropertyForInstance which takes an extra parameter certStorePassphrase, a passphrase for java key store. This method might have some security vulnerability.

com.cisco.services.tracing.TraceManager.setSubFacilities(String[])

and replaced with TraceManager.addSubFacilities method

com.cisco.services.tracing.implementation.TraceManagerImpl.setSubFacilities(String[])

replaced by addSubFacilties(String[])

com.cisco.services.tracing.TraceManager.setSubFacility(String)

and replaced with TraceManager.addSubFacility method

Deprecated Fields

G-2Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager Release 7.1(2)

OL-18531-01

Appendix G Deprecated APIDeprecated Methods

com.cisco.services.tracing.implementation.TraceManagerImpl.setSubFacility(String)

replaced by addSubFacility(String)

com.cisco.jtapi.extensions.CiscoJtapiProperties.updateCertificate(String, String, String, String, String, String, String, String)

This method is replace by overloaded method updateCertifcate which takes an extra parameter certStorePassphrase, a passphrase for java key store. This method might have some security vulnerability.

com.cisco.jtapi.extensions.CiscoJtapiProperties.updateServerCertificate(String, String, String, String, String)

This method is replace by overloaded method updateServerCertifcate which takes an extra parameter certStorePassphrase, a passphrase for java key store. This method might have some security vulnerability.

Deprecated Methods

G-3Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager Release 7.1(2)

OL-18531-01

Appendix G Deprecated APIDeprecated Methods

G-4Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager Release 7.1(2)

OL-18531-01

Cisco Unified JTAPI Developers Guide for CiscOL-18531-01

I N D E X

A

Actor.java

Cisco Unified CallManager JTAPI examples 8-3

addresses and terminals

unobserved 1-7

alarm services 1-12

AutoAccept support for CTIPort and RoutePoint 3-120

auto update of API 3-115

B

barge and privacy event notification 3-109

C

call forward 3-76

calling party IP address 3-31

call park 3-76

directed 3-33

reminder 3-77

retrieval 3-77

CallSelect and UnSelect event notification 3-109

CiscoJtapiExceptions 3-77

CiscoRTPHandle interface 3-35

CiscoTerminal filter and ButtonPressedEvents 3-117

CiscoTermRegistrationFailed event 3-121

Cisco Unified CallManager JTAPI

administering user information 4-19

classes and interfaces B-1

configuration settings

Language tab (figure) 4-18

configuring tracing 4-7

installing

Advanced configuration (table) 4-15

Advanced Tab (figure) 4-14

Cisco Unified CallManagers Tab (figure) 4-13

JTAPI Tracing Tab (figure) 4-8

Log Destination Tab (figure) 4-10

overview 4-3

verifying installation 4-6

install internationalization 3-78

JTAPI examples 8-1

Cisco Unified CallManager JTAPI examples

Actor.java 8-3

MakeCall.java 8-1

makecall.java 8-1

Originator.java 8-7

Receiver.java 8-10

running makecall 8-14

StopSignal.java 8-11

Trace.java 8-11

TraceWindow.java 8-12

Cisco Unified IP 7931G phone 3-30

clear calls interface 3-78

conference

adding parties 3-31

chaining 3-31

Cisco extensions 3-83

events 3-84

scenarios 3-83

secure 3-29

transfer and conference enhancement 3-84

conference and join 3-107

CTI supported devices E-1

IN-1o Unified Communications Manager Release 7.1(2)

Index

D

device recovery 3-78

CTI ports 3-78

CTIRoutePoint 3-78

phones 3-78

directed call park 3-33

directory change notification 3-79

display name interface 3-100

do not disturb 3-28

F

forwarding on no bandwidth and unregistered DN 3-33

G

getCurrentCallingParty() 3-35

H

hold reversion 3-35

I

intercom 3-26

invoking makecall 8-14

IP address of calling party 3-31

J

JTAPI

administering user information 4-19

configuration settings

Language tab (figure) 4-18

installing

Advanced configuration (table) 4-15

Advanced Tab (figure) 4-14

IN-2Cisco Unified JTAPI Developers Guide for Cisco Unified Communic

Cisco Unified CallManagers Tab (figure) 4-13

configuring preferences 4-7

JTAPI Tracing Tab (figure) 4-8

Log Destination Tab (figure) 4-10

overview 4-3

verifying installation 4-6

JTAPI, administering user information 4-19

JTAPI programming interface

addresses and terminals

relationship 1-6

CiscoConnectionID 1-11

Cisco Unified JTAPI and contact centers 1-2

Cisco Unified JTAPI and enterprises 1-2

Cisco Unified JTAPI applications 1-3

concepts

CiscoObjectContainer interface 1-4

connections 1-7

JtapiPeer and Provider 1-4

Jtprefs application 1-3

required software 1-13

JTAPI programming interface overview 1-1

L

languages

Arabic 3-27

Hebrew 3-27

M

MakeCall.java

Cisco Unified CallManager JTAPI Examples 8-1

makecall.java 8-1

media

CiscoMediaTerminal 3-88

endpoint model 3-86

initialization 3-87

media termination extensions 3-85

ations Manager Release 7.1(2)OL-18531-01

Index

payload and parameter negotiation 3-86

payload selection 3-87

receive channel allocation 3-87

receiving and responding to media flow events 3-91

starting transmission and reception 3-88

stopping transmission and reception 3-88

media termination at route point 3-111

message sequence charts A-1

MLPP 3-31

modifying calling number 3-118

monitoring 3-23

multiple calls per DN 3-104

N

new and changed information

from release 4.x to release 5.0 2-4

from release 5.0 to release 5.1(x) 2-4

from release 5.1(x) to release 6.0(1) 2-3

from release 6.0(1) to release 6.1(1) 2-3

no bandwidth forwarding 3-33

O

Originator.java

Cisco Unified CallManager JTAPI examples 8-7

P

presentation indicator (PI) for the call 3-124

privacy on hold 3-34

R

Receiver.java

Cisco Unified CallManager JTAPI examples 8-10

recording 3-23

redirect 3-92

Cisco Unified JTAPI Developers GuidOL-18531-01

redirect set original called ID 3-113

redundancy 3-96

cluster abstraction 3-96

CTIManager failure 3-100

CTIManagers 3-98

heartbeats 3-100

invoking CTIManager 3-99

server failure 3-98

ringer

enable or disable 3-79

routing 3-93

running makecall.java 8-14

S

secure conferencing 3-29

SelectRoute interface enhancement 3-123

SetMessageWaiting interface 3-101

shared line support 3-104

silent monitoring 3-23

single step transfer 3-114

SIP phones 3-49

StopSignal.java

Cisco Unified CallManager JTAPI examples 8-11

T

TerminalConnection 1-8

threaded callbacks 1-11

Trace.java

Cisco Unified CallManager JTAPI examples 8-11

TraceWindow.java

Cisco Unified CallManager JTAPI examples 8-12

transfer and conference

conference 3-82

consult without media 3-85

transfer and DirectTransfer 3-107

transformation masks 3-35

IN-3e for Cisco Unified Communications Manager Release 7.1(2)

Index

translation patterns 3-35

troubleshooting

Cisco Unified CallManager JTAPI C-1

U

unregistered DN forwarding 3-33

user information

administering for JTAPI 4-19

V

version format 3-31

voice mailboxes 3-34

X

xsi object pass through 3-103

IN-4Cisco Unified JTAPI Developers Guide for Cisco Unified Communic

ations Manager Release 7.1(2)

OL-18531-01