Line Class Methods
The following are the Line class methods.
Syntax
alternate(reason)
Description
Alternate a call.
Parameters
Field or Control |
Definition |
---|---|
reason |
The reason to alternate a call. |
Returns
Request number.
Syntax
answer(reason)
Description
Answer a call.
Parameters
Field or Control |
Definition |
---|---|
reason |
The reason to answer a call. |
Returns
Request number.
Syntax
attachUserDate(userdata, reason)
Description
Attach user data to a call.
Parameters
Field or Control |
Definition |
---|---|
userdata |
The user data to attach to the call. |
reason |
The reason to attach the user data. |
Returns
Request number.
Syntax
clear(reason)
Description
Clear a conference call.
Parameters
Field or Control |
Definition |
---|---|
reason |
The reason to clear the conference. |
Returns
Request number.
Syntax
complete(reason)
Description
Complete the two-step transfer/conference.
Parameters
Field or Control |
Definition |
---|---|
reason |
The reason to complete the two-step transfer/conference. |
Returns
Request number.
Syntax
conference(destination, reason, userdata, calldata)
Description
Conference a call.
Parameters
Field or Control |
Definition |
---|---|
destination |
The destination being invited into the conference. |
reason |
The reason to conference. |
userdata |
The user data to be attached. |
calldata |
The call data to be modified. |
Returns
Request number.
Syntax
conferenceSingle(destination, reason, userdata, calldata)
Description
Single-step conference a call.
Parameters
Field or Control |
Definition |
---|---|
destination |
The destination being invited into the conference. |
reason |
The reason to conference. |
userdata |
The user data to be attached. |
calldata |
The call data to be modified. |
Returns
Request number.
Syntax
dial(number, reason, userdata)
Description
Dial out.
Parameters
Field or Control |
Definition |
---|---|
destination |
The destination being invited into the conference. |
reason |
The reason to conference. |
userdata |
The user data to be attached. |
Returns
Request number.
Syntax
dropParty(destination, reason)
Description
Drop a party in conference.
Parameters
Field or Control |
Definition |
---|---|
destination |
The destination being dropped from the conference. |
reason |
The reason to drop the party. |
Returns
Request number.
Syntax
getAni()
Description
Get the ANI.
Parameters
None.
Returns
Returns a string representing the ANI.
Syntax
getDescr()
Description
Get the description attached to the call on the line.
Parameters
None.
Returns
Returns a string.
Syntax
getDnis()
Description
Get the DNIS.
Parameters
None.
Returns
Returns a string.
Syntax
getPadvalue(key)
Description
Get the PAD value.
Returns
A string representing PAD value.
Syntax
getReferenceId()
Description
Get the reference ID attached to the call on the line.
Parameters
None.
Returns
Returns a string.
Syntax
getUrl(defaultUrl)
Description
Get the URL for screen pop-up.
Parameters
Field or Control |
Definition |
---|---|
defaultUrl |
The default pop-up URL. |
Returns
Returns a string.
Syntax
grabCall(destination, reason)
Description
Grab a call from the queue.
Parameters
Field or Control |
Definition |
---|---|
destination |
The destination to be grabbed. |
reason |
The reason for the grab. |
Returns
Request number.
Syntax
hold(reason)
Description
Hold a call.
Parameters
Field or Control |
Definition |
---|---|
reason |
The reason to hold the call. |
Returns
Request number.
Syntax
join(reason, conferenceId)
Description
Join an existing call/conference.
Parameters
Field or Control |
Definition |
---|---|
reason |
The reason to join the call. |
conferenceId |
Call id. |
Returns
Request number.
Syntax
mute(reason)
Description
Mute an extension.
Parameters
Field or Control |
Definition |
---|---|
reason |
The reason to mute the call. |
Returns
Request number.
Syntax
park(destination, reason)
Description
Park a call.
Parameters
Field or Control |
Definition |
---|---|
destination |
The destination on which the call will be parked. |
reason |
The reason to park the call. |
Returns
Request number.
Syntax
reconnect(reason)
Description
Reconnect to the original party during two-step transfer/conference.
Parameters
Field or Control |
Definition |
---|---|
reason |
The reason to reconnect. |
Returns
Request number.
Syntax
reject(reason)
Description
Reject an incoming call.
Parameters
Field or Control |
Definition |
---|---|
reason |
The reason to reject. |
Returns
Request number.
Syntax
release(reason)
Description
Release a call.
Parameters
Field or Control |
Definition |
---|---|
reason |
The reason to release the call. |
Returns
Request number.
Syntax
retrieve(reason)
Description
Retrieve a held call.
Parameters
Field or Control |
Definition |
---|---|
reason |
The reason to retrieve the call. |
Returns
Request number.
Syntax
Syntax
sendDTMF(reason,stringDTMF)
Description
Send DTMF tones to the switch.
Parameters
Field or Control |
Definition |
---|---|
reason |
The reason for requesting DTMF. |
stringDTMF |
DTMF tones string (0-9,*,#). |
Returns
Request number.
Syntax
setcallresult(result)
Description
Set call result.
Parameters
Field or Control |
Definition |
---|---|
result |
Result of the call. |
Returns
Request number.
Syntax
setcallresultDNC(number, reason)
Description
Do not call.
Parameters
Field or Control |
Definition |
---|---|
number |
The number not to be disturbed. |
reason |
The reason not to disturb. |
Returns
Request number.
Syntax
setcallresultReschedule(hour, minutes, day, month,year)
Description
Reschedule a call.
Parameters
Field or Control |
Definition |
---|---|
hour |
Hours |
Minutes |
Minutes |
Day |
Day |
Month |
Month |
Year |
Year |
Returns
Request number.
Syntax
transfer(destination, reason, userdata, calldata)
Description
Transfer a call.
Parameters
Field or Control |
Definition |
---|---|
destination |
The destination to which the call will be transferred. |
reason |
The reason to transfer. |
userdata |
The user data to be attached. |
calldata |
The call data to be modified. |
Returns
Request number.
Syntax
transferMute(destination, reason, userdata, calldata)
Description
Transfer mute a call.
Parameters
Field or Control |
Definition |
---|---|
destination |
The destination to which the call will be transferred. |
reason |
The reason to transfer. |
userdata |
The user data to be attached. |
calldata |
The call data to be modified. |
Returns
Request number.
Syntax
unmute(reason)
Description
Unmute a call.
Parameters
Field or Control |
Definition |
---|---|
reason |
The reason to unmute a call. |
Returns
Request number.
Syntax
updateCallData(calldata, reason)
Description
Update call data to a call.
Parameters
Field or Control |
Definition |
---|---|
calldata |
The call data to update. |
reason |
The reason to update. |
Returns
Request number.