atg.svc.clicktoconnect
Class C2CWebServiceResponse

java.lang.Object
  atg.svc.clicktoconnect.C2CWebServiceResponse

public class C2CWebServiceResponse
extends java.lang.Object

Object to hold the information retrieved from the eStara API for cross-channel data passing.

Field Summary

static java.lang.String

CLASS_VERSION

Constructor Summary

C2CWebServiceResponse()
Constructs an instance of C2CWebServiceResponse

Method Summary

java.lang.String	getCallerIP() Returns the Internet Protocol address of the caller.
java.lang.String	getCallID() Returns the unique call ID for the call made.
java.lang.String	getCallServerIP() Returns the Internet Protocol address of the call server which handles the call.
java.lang.String	getCallType() Returns the call type.
java.lang.String	getClient() Returns the name of the eStara account holder.
java.lang.String	getClientID() Returns the eStara Account ID.
java.lang.String	getCobrowseURL() Returns the co-browse URL.
int	getCode() Returns the status code.
java.lang.String	getDelay() Returns the call delay defined by the customer when they wish to be called.
java.lang.String	getExtension() Returns the extension of the Agent
java.lang.String	getFTCallID() Returns the unique ID for the call related to the eStara click to call GUI.
java.lang.String	getGatewayIPAgent() Returns the GatewayIPAgent
java.lang.String	getLinkID() Returns the Link ID for the link that was clicked on.
java.lang.String	getReferrer() Returns URL of the page that spawned the click to call button.
java.lang.String	getSessionID() Returns the SessionID of the call.
java.lang.String	getStatus() Returns the status of the search for live call data.
java.lang.String	getTelephoneNumber() Returns the telephone number of the agent
java.lang.String	getTerminatedBy() Returns who terminated the call, the agent of the customer.
java.lang.String	getTimeInitiated() Returns the Time the call was initiated.
java.lang.String	getUserTelephoneNumber() Returns the telephone number of the customer who initiated the call.
java.lang.String	getVar1() Returns information defined for var1
java.lang.String	getVar10() Returns information defined for var10
java.lang.String	getVar2() Returns information defined for var2
java.lang.String	getVar3() Returns information defined for var3
java.lang.String	getVar4() Returns information defined for var4
java.lang.String	getVar5() Returns information defined for var5
java.lang.String	getVar6() Returns information defined for var6
java.lang.String	getVar7() Returns information defined for var7
java.lang.String	getVar8() Returns information defined for var8
java.lang.String	getVar9() Returns information defined for var9
void	setCallerIP(java.lang.String pCallerIP)
void	setCallID(java.lang.String pCallID)
void	setCallServerIP(java.lang.String pCallServerIP)
void	setCallType(java.lang.String pCallType)
void	setClient(java.lang.String pClient)
void	setClientID(java.lang.String pClientID)
void	setCobrowseURL(java.lang.String pCobrowseURL)
void	setCode(int pCode)
void	setDelay(java.lang.String pDelay)
void	setExtension(java.lang.String pExtension)
void	setFTCallID(java.lang.String pFTCallID)
void	setGatewayIPAgent(java.lang.String pGatewayIPAgent)
void	setLinkID(java.lang.String pLinkID)
void	setReferrer(java.lang.String pReferrer)
void	setSessionID(java.lang.String pSessionID)
void	setStatus(java.lang.String pStatus)
void	setTelephoneNumber(java.lang.String pTelephoneNumber)
void	setTerminatedBy(java.lang.String pTerminatedBy)
void	setTimeInitiated(java.lang.String pTimeInitiated)
void	setUserTelephoneNumber(java.lang.String pUserTelephoneNumber)
void	setVar1(java.lang.String pVar1)
void	setVar10(java.lang.String pVar10)
void	setVar2(java.lang.String pVar2)
void	setVar3(java.lang.String pVar3)
void	setVar4(java.lang.String pVar4)
void	setVar5(java.lang.String pVar5)
void	setVar6(java.lang.String pVar6)
void	setVar7(java.lang.String pVar7)
void	setVar8(java.lang.String pVar8)
void	setVar9(java.lang.String pVar9)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Constructor Detail

C2CWebServiceResponse

public C2CWebServiceResponse()

Constructs an instance of C2CWebServiceResponse

Method Detail

getStatus

public java.lang.String getStatus()

Returns the status of the search for live call data.

Returns:

String

setStatus

public void setStatus(java.lang.String pStatus)

getCode

public int getCode()

Returns the status code.

• Status code "0" is defined as a successful search.
• Status code "2" is defined as invalid login details.

Returns:

status code

setCode

public void setCode(int pCode)

getCallType

public java.lang.String getCallType()

Returns the call type.

• 'webcall' - defined as computer to phone call
• 'webcallback' - defined as phone to phone call

Returns:

call type

setCallType

public void setCallType(java.lang.String pCallType)

getCallID

public java.lang.String getCallID()

Returns the unique call ID for the call made.

Returns:

callID

setCallID

public void setCallID(java.lang.String pCallID)

getFTCallID

public java.lang.String getFTCallID()

Returns the unique ID for the call related to the eStara click to call GUI. If the same GUI is used for multiple calls the FTCall ID will remain the same, unless it is reloaded.

Returns:

ftCallID

setFTCallID

public void setFTCallID(java.lang.String pFTCallID)

getTimeInitiated

public java.lang.String getTimeInitiated()

Returns the Time the call was initiated.

Returns:

timeInitiated

setTimeInitiated

public void setTimeInitiated(java.lang.String pTimeInitiated)

getSessionID

public java.lang.String getSessionID()

Returns the SessionID of the call.

Returns:

sessionID

setSessionID

public void setSessionID(java.lang.String pSessionID)

getTerminatedBy

public java.lang.String getTerminatedBy()

Returns who terminated the call, the agent of the customer.

Returns:

terminatedBy

setTerminatedBy

public void setTerminatedBy(java.lang.String pTerminatedBy)

getCallerIP

public java.lang.String getCallerIP()

Returns the Internet Protocol address of the caller.

Returns:

callerIP

setCallerIP

public void setCallerIP(java.lang.String pCallerIP)

getCallServerIP

public java.lang.String getCallServerIP()

Returns the Internet Protocol address of the call server which handles the call.

Returns:

the node value for callServerIP

setCallServerIP

public void setCallServerIP(java.lang.String pCallServerIP)

getTelephoneNumber

public java.lang.String getTelephoneNumber()

Returns the telephone number of the agent

Returns:

telephoneNumber

setTelephoneNumber

public void setTelephoneNumber(java.lang.String pTelephoneNumber)

getClientID

public java.lang.String getClientID()

Returns the eStara Account ID.

Returns:

clientID

setClientID

public void setClientID(java.lang.String pClientID)

getLinkID

public java.lang.String getLinkID()

Returns the Link ID for the link that was clicked on.

Returns:

linkID

setLinkID

public void setLinkID(java.lang.String pLinkID)

getUserTelephoneNumber

public java.lang.String getUserTelephoneNumber()

Returns the telephone number of the customer who initiated the call.

Returns:

userTelephoneNumber

setUserTelephoneNumber

public void setUserTelephoneNumber(java.lang.String pUserTelephoneNumber)

getVar1

public java.lang.String getVar1()

Returns information defined for var1

Returns:

var1

setVar1

public void setVar1(java.lang.String pVar1)

getVar2

public java.lang.String getVar2()

Returns information defined for var2

Returns:

var2

setVar2

public void setVar2(java.lang.String pVar2)

getVar3

public java.lang.String getVar3()

Returns information defined for var3

Returns:

var3

setVar3

public void setVar3(java.lang.String pVar3)

getVar4

public java.lang.String getVar4()

Returns information defined for var4

Returns:

var4

setVar4

public void setVar4(java.lang.String pVar4)

getVar5

public java.lang.String getVar5()

Returns information defined for var5

Returns:

var5

setVar5

public void setVar5(java.lang.String pVar5)

getVar6

public java.lang.String getVar6()

Returns information defined for var6

Returns:

var6

setVar6

public void setVar6(java.lang.String pVar6)

getVar7

public java.lang.String getVar7()

Returns information defined for var7

Returns:

var7

setVar7

public void setVar7(java.lang.String pVar7)

getVar8

public java.lang.String getVar8()

Returns information defined for var8

Returns:

var8

setVar8

public void setVar8(java.lang.String pVar8)

getVar9

public java.lang.String getVar9()

Returns information defined for var9

Returns:

var9

setVar9

public void setVar9(java.lang.String pVar9)

getVar10

public java.lang.String getVar10()

Returns information defined for var10

Returns:

var10

setVar10

public void setVar10(java.lang.String pVar10)

getReferrer

public java.lang.String getReferrer()

Returns URL of the page that spawned the click to call button.

Returns:

referrer

setReferrer

public void setReferrer(java.lang.String pReferrer)

getGatewayIPAgent

public java.lang.String getGatewayIPAgent()

Returns the GatewayIPAgent

Returns:

gatewayIPAgent

setGatewayIPAgent

public void setGatewayIPAgent(java.lang.String pGatewayIPAgent)

getExtension

public java.lang.String getExtension()

Returns the extension of the Agent

Returns:

extension

setExtension

public void setExtension(java.lang.String pExtension)

getDelay

public java.lang.String getDelay()

Returns the call delay defined by the customer when they wish to be called.

Returns:

delay

setDelay

public void setDelay(java.lang.String pDelay)

getClient

public java.lang.String getClient()

Returns the name of the eStara account holder.

Returns:

client

setClient

public void setClient(java.lang.String pClient)

getCobrowseURL

public java.lang.String getCobrowseURL()

Returns the co-browse URL. Used for the eStara co-browse feature.

Returns:

cobrowseURL

setCobrowseURL

public void setCobrowseURL(java.lang.String pCobrowseURL)