ChatConnection Class Methods
The following are chatconnection class methods:
Syntax
answer(agentId,reason)
Description
Answer a chat request.
Parameters
|
Field or Control |
Definition |
|---|---|
| agent Id |
The Id of the agent answering the call. |
| reason |
The reason code for the answer request. |
Returns
Request number.
Syntax
attachUserData(userData,reason)
Description
Attach user data for the chat connection.
Parameters
|
Field or Control |
Definition |
|---|---|
| userData |
User data of the chat connection. |
| reason |
The reason code for the answer request. |
Returns
Request number.
Syntax
conference(agentId,reason)
Description
Conference a chat with another agent.
Parameters
|
Field or Control |
Definition |
|---|---|
| agent Id |
The Id of the agent invited to the conference. |
| reason |
The reason code for the conference request. |
Returns
Request number.
Syntax
forward(fromagentId,toagentId, qid, userdata, chatdata, reason)
Description
Forward chat to another agent or another queue.
Parameters
|
Field or Control |
Definition |
|---|---|
| fromagentid |
The agent id from whom task is forwarded. |
| toagentid |
The target agentid to whom task is forwarded. |
| qid |
The target queue to forward the task. |
| userdata |
The user data. |
| chatdata |
The chat data. |
| Reason |
The reason code to forward the task. |
Returns
Request number.
Syntax
gethistory(agentId,noofLines, reason)
Description
Request chat history by specifying number of lines of chat history needed.
Parameters
|
Field or Control |
Definition |
|---|---|
| agent Id |
The source agent ID. |
| noofLines |
Number of lines of history required. |
| reason |
The reason code for the history request. |
Returns
Request number.
Syntax
getUrl(defaultURL)
Description
Get the URL for screen popup.
Parameters
|
Field or Control |
Definition |
|---|---|
| defaultUrl |
The default popup URL. |
Returns
Returns a URL string.
Syntax
message(agentId,message, reason)
Description
Send a chat message while chatting.
Parameters
|
Field or Control |
Definition |
|---|---|
| agent Id |
The source agent ID. |
| message |
The message to send to other party. |
| reason |
The reason code for the message request. |
Returns
Request number.
Syntax
pushURL(URL)
Description
Request to push a URL to the customer.
Parameters
|
Field or Control |
Definition |
|---|---|
| URL |
URL to push. |
Returns
Request number.
Syntax
reject(agentId,reason)
Description
Reject a chat.
Parameters
|
Field or Control |
Definition |
|---|---|
| agent Id |
The source agent ID. |
| reason |
The reason code for reject. |
Returns
Request number.
Syntax
release(agentId,reason)
Description
Release a chat.
Parameters
|
Field or Control |
Definition |
|---|---|
| agent Id |
The source agent ID. |
| reason |
The reason code for release request. |
Returns
Request number.
Syntax
typing(agentId,reason)
Description
Indicates typing in a chat conversation by one party.
Parameters
|
Field or Control |
Definition |
|---|---|
| agent Id |
The source agent ID. |
| reason |
The reason code for typing. |
Returns
Request number.
Syntax
wrapup(agentid,message,tasknum,reason)
Description
Stores chat wrap up comments.
Parameters
|
Field or Control |
Definition |
|---|---|
| agentid |
The agent id who enters wrap up comments. |
| message |
Chat message. |
| tasknum |
Task number. |
| reason |
The reason code. |
Returns
Request number.