The class represents the voice call. More...

Public Member Functions
override string	ToString ()
	Returns string representation of the object. More...

CallParty	party (string partyId)
	Returns the CallParty object for specified party ID. More...

void	drop ()
	Disconnect a call. More...

void	answer ()
	Answer inbound ringing call. More...

void	hold ()
	Place call on hold. More...

void	resume ()
	Resume held call. More...

void	mute ()
	Deactivate user's phone microphone. More...

void	unmute ()
	Reactivate user's phone microphone. More...

ResultCode	sstepTransfer (string dest)
	Initiate single step (blind) transfer of the call to specified destination. More...

ResultCode	sstepConference (string dest)
	Initiate single step (blind) conference with specified destination. More...

ResultCode	consultTransfer (Call consultCall)
	Complete the consult transfer of current call with specified consult call. The current call will be completed then. More...

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. More...

ResultCode	startRecording ()
	Start or continue recording of the call on the server. More...

ResultCode	stopRecording ()
	Stop recording of the call on the server. More...

ResultCode	muteRecording ()
	Mute recording of the call on the server. More...

ResultCode	unmuteRecording ()
	Resume (unmute) recording of the call on the server. More...

void	removeParty (CallParty party)
	Remove party from conference. Only parties which were added by this client can be removed. More...

void	endConference ()
	End conference call. This will destroy the conference completely. Use Call.drop() to leave the conference without destroying the entire call. More...

void	sendDtmf (string dtmf)
	Send the DTMF digit to all other parties in the call. More...

Properties
string	id `[get]`
	Unique call ID. More...

DateTime	startTime `[get]`
	Call start time More...

string	itemId `[get]`
	ID of the Item associated with the call. More...

Item?	item `[get]`
	Reference to the Item associated with the call. More...

Direction	direction `[get]`
	Call direction. More...

string	localNumber `[get]`
	Local phone number. More...

string	remoteNumber `[get]`
	Remote phone number. More...

string	remoteName `[get, set]`
	Remote party display name. More...

CallState	state `[get]`
	Call state. More...

bool	isMuted `[get]`
	Specifies if call is muted (the user's microphone is turned off). More...

bool	remoteHeld `[get]`
	Specifies if the call is placed on hold by remote party. More...

bool?	isRecording `[get]`
	Specifies if call is being recorded on the server. More...

bool?	isRecordingMuted `[get]`
	Specifies if call is being recorded but the actual sound is replaced with silence. More...

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. More...

SortedDictionary< string, CallParty >	parties `[get]`
	Collection of call parties. More...

bool	isConference `[get]`
	Specifies if call is the conference (has more than two phone parties). More...

Detailed Description

The class represents the voice call.

Member Function Documentation

◆ answer()

void ADAPI.Call.answer ( )

Answer inbound ringing call.

◆ 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.

◆ drop()

void ADAPI.Call.drop ( )

Disconnect a call.

◆ endConference()

void ADAPI.Call.endConference ( )

End conference call. This will destroy the conference completely. Use Call.drop() to leave the conference without destroying the entire call.

◆ hold()

void ADAPI.Call.hold ( )

Place call on hold.

◆ 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.

◆ mute()

void ADAPI.Call.mute ( )

Deactivate user's phone microphone.

◆ 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

◆ resume()

void ADAPI.Call.resume ( )

Resume held call.

◆ 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()

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.

◆ 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.

◆ ToString()

override string ADAPI.Call.ToString ( )

Returns string representation of the object.

◆ unmute()

void ADAPI.Call.unmute ( )

Reactivate user's phone microphone.

◆ unmuteRecording()

ResultCode ADAPI.Call.unmuteRecording ( )

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

Returns: Result code.

Property Documentation

◆ direction

Direction ADAPI.Call.direction

get

Call direction.

◆ id

string ADAPI.Call.id

get

Unique call ID.

◆ isConference

bool ADAPI.Call.isConference

get

Specifies if call is the conference (has more than two phone parties).

◆ isMuted

bool ADAPI.Call.isMuted

get

Specifies if call is muted (the user's microphone is turned off).

◆ isRecording

bool? ADAPI.Call.isRecording

get

Specifies if call is being recorded on the server.

◆ isRecordingMuted

bool? ADAPI.Call.isRecordingMuted

get

Specifies if call is being recorded but the actual sound is replaced with silence.

◆ item

Item? ADAPI.Call.item

get

Reference to the Item associated with the call.

◆ itemId

string ADAPI.Call.itemId

get

ID of the Item associated with the call.

◆ localNumber

string ADAPI.Call.localNumber

get

Local phone number.

◆ parties

SortedDictionary<string, CallParty> ADAPI.Call.parties

get

Collection of call parties.

◆ recordingPlaybackUrl

string? ADAPI.Call.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.

◆ remoteHeld

bool ADAPI.Call.remoteHeld

get

Specifies if the call is placed on hold by remote party.

◆ remoteName

string ADAPI.Call.remoteName

getset

Remote party display name.

◆ remoteNumber

string ADAPI.Call.remoteNumber

get

Remote phone number.

◆ startTime

DateTime ADAPI.Call.startTime

get

Call start time

◆ state

CallState ADAPI.Call.state

get

Call state.

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

Branches/5.5.1/Client/AgentDesktopApi/ADAPI/AuxClasses.cs

Public Member Functions

Properties

Detailed Description

Member Function Documentation

◆ answer()

◆ consultTransfer()

◆ drop()

◆ endConference()

◆ hold()

◆ mergeConference()

◆ mute()

◆ muteRecording()

◆ party()

◆ removeParty()

◆ resume()

◆ sendDtmf()

◆ sstepConference()

◆ sstepTransfer()

◆ startRecording()

◆ stopRecording()

◆ ToString()

◆ unmute()

◆ unmuteRecording()

Property Documentation

◆ direction

◆ id

◆ isConference

◆ isMuted

◆ isRecording

◆ isRecordingMuted

◆ item

◆ itemId

◆ localNumber

◆ parties

◆ recordingPlaybackUrl

◆ remoteHeld

◆ remoteName

◆ remoteNumber

◆ startTime

◆ state