This interface allows to modify a Task of call generation. More...

defined in <Task.ice>

interface Task extends Smartswitch::Destroyable { ... }

Inheritance diagram for Smartswitch::Telephony::CallGeneration::Task:

Collaboration diagram for Smartswitch::Telephony::CallGeneration::Task:

Operations
void	addCalleeId (string calleeId) throws AccessException
	Adds callee ID with CalleeIdStatus = eNone. More...

void	addCallerId (string callerId) throws AccessException
	Add a new caller ID to a Task. More...

TaskTimetable *	addTimetable () throws AccessException
	Add a new TaskTimetable entry to this Task. More...

AnswerPeer *	getAnswerPeer () throws AccessException
	Get currently configured AnswerPeer. More...

idempotent StateInterface	getAnswerPeerStateInterface () throws AccessException
	Get currently configured StateInterface. More...

idempotent CalleeIdInfoSequence	getCalleeIds (long offset) throws AccessException
	Get callee IDs, which will be used in this Task to dial a new call. More...

idempotent StringSequence	getCallerIds (long offset) throws AccessException
	Get caller IDs, which will be used in this Task. More...

idempotent Telephony::CdrSequence	getCdr (long offset)
	Get CDR for this Task. More...

idempotent string	getEndTime () throws AccessException
	Client can periodically poll this API in order to determine when the task has finished. More...

idempotent string	getStartTime () throws AccessException
	Task starts dialing when its `start time` comes. More...

TaskTimetableSequence	getTimetable () throws AccessException
	Get currently installed TaskTimetable for this Task. More...

idempotent bool	isEnabled () throws AccessException
	Disabled Task won't be dialing the callee ID list. More...

void	remove () throws AccessException
	Remove this Task. More...

idempotent void	setAnswerPeer (AnswerPeer *answerPeer) throws AccessException
	Set AnswerPeer, to which Smartswitch will forward a call after dialed user answers. More...

idempotent void	setAnswerPeerStateInterface (StateInterface stateInterface) throws AccessException
	Set new StateInterface. More...

idempotent void	setEnabled (bool enabled) throws AccessException
	Disabling tasks stops it if it's currently active. More...

idempotent void	setStartTime (string time) throws AccessException, ArgumentException
	Schedule time when this task will be activated. More...

Operations inherited from Smartswitch::Destroyable
void	destroy ()
	Destroy the proxy entity at the Smartswitch side. More...

Detailed Description

This interface allows to modify a Task of call generation.

You can fill it with caller and callee numbers
You can configure its start time if you want a delayed dialing process activation
You can configure TaskTimetable if you want periodic Task activation and deactivation
You can specify an AnswerPeer to which the answered calls will be forwarded
You can monitor the Task completion by polling the Task end time

Operation Documentation

◆ addCalleeId()

void addCalleeId ( string calleeId ) throws AccessException

Adds callee ID with CalleeIdStatus = eNone.

This callee ID will be dialed when the Task will be started.

◆ addCallerId()

void addCallerId ( string callerId ) throws AccessException

Add a new caller ID to a Task.

The Task will randomly pickup a caller ID for each newly generated call.
Duplicates are possble.
You can add more instances of a caller ID to increase it's probability to be used during call generation.

◆ addTimetable()

TaskTimetable* addTimetable ( ) throws AccessException

Add a new TaskTimetable entry to this Task.

Returns: newly added TaskTimetable entry.

◆ getAnswerPeer()

AnswerPeer* getAnswerPeer ( ) throws AccessException

Get currently configured AnswerPeer.

to which Smartswitch will forward a call after dialed user answers.

See also: setAnswerUser()

Returns: AnswerPeer proxy.

◆ getAnswerPeerStateInterface()

idempotent StateInterface getAnswerPeerStateInterface ( ) throws AccessException

Get currently configured StateInterface.

If the StateInterface is not None,
Smartswitch starts new call only when the AnswerPeer becomes available.
Use getAnswerPeer() to get the currently monitored AnswerPeer.

See also: setAnswerPeer(); setAnswerPeerStateInterface()

Returns: StateInterface.

◆ getCalleeIds()

idempotent CalleeIdInfoSequence getCalleeIds ( long offset ) throws AccessException

Get callee IDs, which will be used in this Task to dial a new call.

Parameters

offset Skip 'offset' records when retrieving.
Use offset = 0 to get first 100 records.

Returns: 100 records starting from offset.

◆ getCallerIds()

idempotent StringSequence getCallerIds ( long offset ) throws AccessException

Get caller IDs, which will be used in this Task.

The Task will randomly pickup a caller ID for each newly generated call.

Parameters

offset Skip 'offset' records when retrieving.
Use offset = 0 to get first 100 records.

Returns: 100 records starting from offset.

◆ getCdr()

idempotent Telephony::CdrSequence getCdr ( long offset )

Get CDR for this Task.

Parameters

offset Skip 'offset' records when retrieving. Use offset = 0 to get first 100 records.

Returns: 100 records starting from offset.

◆ getEndTime()

idempotent string getEndTime ( ) throws AccessException

Client can periodically poll this API in order to determine when the task has finished.

Returns: Non-empty string, containing finish time, if task has been finished.
Empty string otherwise.

◆ getStartTime()

idempotent string getStartTime ( ) throws AccessException

Task starts dialing when its start time comes.

Returns: Time at which this task will be started.

◆ getTimetable()

TaskTimetableSequence getTimetable ( ) throws AccessException

Get currently installed TaskTimetable for this Task.

Returns: All TaskTimetable entries for this Task.

◆ isEnabled()

idempotent bool isEnabled ( ) throws AccessException

Disabled Task won't be dialing the callee ID list.

Enabled Task may start dialing if all the conditions are met:

the start time is reached
the TaskTimetable is fired (if it's specified)

Returns: true, if this task is currently enabled.

◆ remove()

void remove ( ) throws AccessException

Remove this Task.

◆ setAnswerPeer()

idempotent void setAnswerPeer ( AnswerPeer * answerPeer ) throws AccessException

Set AnswerPeer, to which Smartswitch will forward a call after dialed user answers.

See also: getAnswerPeer()

Parameters

answerPeer AnswerPeer proxy

◆ setAnswerPeerStateInterface()

idempotent void setAnswerPeerStateInterface ( StateInterface stateInterface ) throws AccessException

Set new StateInterface.

If state interface differs from None,
Smartswitch starts new call only when the AnswerPeer becomes available.
Use setAnswerPeer() to specify the new AnswerPeer.

See also: setAnswerPeer(); getAnswerPeerStateInterface()

Parameters

stateInterface new state interface

◆ setEnabled()

idempotent void setEnabled ( bool enabled ) throws AccessException

Disabling tasks stops it if it's currently active.

Enabling task resumes its operation.

◆ setStartTime()

idempotent void setStartTime ( string time ) throws AccessException, ArgumentException

Schedule time when this task will be activated.

Parameters

time	Time at which to start this task.

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

/usr/ports/net/smartswitch/work/smartswitch-9.1.60971/ice/Telephony/CallGeneration/Task.ice

Operations

Detailed Description

Operation Documentation

◆ addCalleeId()

◆ addCallerId()

◆ addTimetable()

◆ getAnswerPeer()

◆ getAnswerPeerStateInterface()

◆ getCalleeIds()

◆ getCallerIds()

◆ getCdr()

◆ getEndTime()

◆ getStartTime()

◆ getTimetable()

◆ isEnabled()

◆ remove()

◆ setAnswerPeer()

◆ setAnswerPeerStateInterface()

◆ setEnabled()

◆ setStartTime()