ADAPI.Call Class Reference

The class represents the voice call. More...

Public Member Functions
override string	ToString ()
	Returns string representation of the object.
CallParty	party (string partyId)
	Returns the CallParty object for specified party ID.
void	drop ()
	Disconnect a call.
void	answer ()
	Answer inbound ringing call.
void	hold ()
	Place call on hold.
void	resume ()
	Resume held call.
void	mute ()
	Deactivate user's phone microphone.
void	unmute ()
	Reactivate user's phone microphone.
ResultCode	sstepTransfer (string dest)
	Initiate single step (blind) transfer of the call to specified destination.
ResultCode	sstepTransfer (string dest, KVList vars)
	Initiate single step (blind) transfer of the call to specified destination with parameters(variables).
ResultCode	sstepConference (string dest)
	Initiate single step (blind) conference with specified destination.
ResultCode	consultTransfer (Call consultCall)
	Complete the consult transfer of current call with specified consult call. The current call will be completed then.
ResultCode	mergeConference (List< Call > consultCalls)
	Merge specified consult calls with current call into conference. All consult calls will be completed once they are joined current call. The consult calls will become parties of the current call.
ResultCode	startRecording ()
	Start or continue recording of the call on the server.
ResultCode	stopRecording ()
	Stop recording of the call on the server.
ResultCode	muteRecording ()
	Mute recording of the call on the server.
ResultCode	unmuteRecording ()
	Resume (unmute) recording of the call on the server.
void	removeParty (CallParty party)
	Remove party from conference. Only parties which were added by this client can be removed.
void	endConference ()
	End conference call. This will destroy the conference completely. Use Call.drop() to leave the conference without destroying the entire call.
void	sendDtmf (string dtmf)
	Send the DTMF digit to all other parties in the call.

Properties
string	id [get]
	Unique call ID.
DateTime	startTime [get]
	Call start time.
string	itemId [get]
	ID of the Item associated with the call.
Item	item [get]
	Reference to the Item associated with the call.
Direction	direction [get]
	Call direction.
string	localNumber [get]
	Local phone number.
string	remoteNumber [get]
	Remote phone number.
string	remoteName [get, set]
	Remote party display name.
CallState	state [get]
	Call state.
bool	isMuted [get]
	Specifies if call is muted (the user's microphone is turned off).
bool	remoteHeld [get]
	Specifies if the call is placed on hold by remote party.
bool	isRecording [get]
	Specifies if call is being recorded on the server.
bool	isRecordingMuted [get]
	Specifies if call is being recorded but the actual sound is replaced with silence.
string	recordingPlaybackUrl [get]
	Specifies the URL postfix which can be used to download the recording. The full URL should be composed by joining the web server address with this postfix.
SortedDictionary< string, CallParty >	parties [get]
	Collection of call parties.
bool	isConference [get]
	Specifies if call is the conference (has more than two phone parties).

Detailed Description

The class represents the voice call.

Member Function Documentation

consultTransfer()

ResultCode ADAPI.Call.consultTransfer

(

Call

consultCall

)

Complete the consult transfer of current call with specified consult call. The current call will be completed then.

Parameters

consultCall

Reference to the consult call object.

Returns

Result code.

mergeConference()

ResultCode ADAPI.Call.mergeConference

(

List< Call >

consultCalls

)

Merge specified consult calls with current call into conference. All consult calls will be completed once they are joined current call. The consult calls will become parties of the current call.

Parameters

consultCalls

List of consult calls to be joined.

Returns

Result code.

muteRecording()

ResultCode ADAPI.Call.muteRecording

(

)

Mute recording of the call on the server.

Returns

Result code.

party()

CallParty ADAPI.Call.party

(

string

partyId

)

Returns the CallParty object for specified party ID.

Parameters

partyId

The ID of the party

Returns

CallParty object.

removeParty()

void ADAPI.Call.removeParty

(

CallParty

party

)

Remove party from conference. Only parties which were added by this client can be removed.

Parameters

party

Reference to the CallParty object representing the party to be removed

sendDtmf()

void ADAPI.Call.sendDtmf

(

string

dtmf

)

Send the DTMF digit to all other parties in the call.

Parameters

dtmf	The DTMF digit to be sent

sstepConference()

ResultCode ADAPI.Call.sstepConference

(

string

dest

)

Initiate single step (blind) conference with specified destination.

Parameters

dest	The phone number of the new party being invited to the conference

Returns

Result code.

sstepTransfer() [1/2]

ResultCode ADAPI.Call.sstepTransfer

(

string

dest

)

Initiate single step (blind) transfer of the call to specified destination.

Parameters

dest	Destination phone number

Returns

Result code.

sstepTransfer() [2/2]

ResultCode ADAPI.Call.sstepTransfer	(	string	dest,
		KVList	vars )

Initiate single step (blind) transfer of the call to specified destination with parameters(variables).

Parameters

dest	Destination phone number
vars	Parameters/variables to transfer

Returns

Result code.

startRecording()

ResultCode ADAPI.Call.startRecording

(

)

Start or continue recording of the call on the server.

Returns

Result code.

stopRecording()

ResultCode ADAPI.Call.stopRecording

(

)

Stop recording of the call on the server.

Returns

Result code.

unmuteRecording()

ResultCode ADAPI.Call.unmuteRecording

(

)

Resume (unmute) recording of the call on the server.

Returns

Result code.

---

The documentation for this class was generated from the following file:

• /Users/avl/projects/GitHub/BrightPattern/5.36.0/Client/AgentDesktopApi/ADAPI/AuxClasses.cs