This is the main interface from which you can gain access to other Smartswitch entities. More...

defined in <Session.ice>

interface Session extends Glacier2::Session { ... }

Inheritance diagram for Smartswitch::Session:

Collaboration diagram for Smartswitch::Session:

Operations
Telephony::CallGeneration::Task *	addCallGenerationTask () throws AccessException
	Add a new Telephony::CallGeneration::Task. More...

Telephony::Queue *	addQueue (string name) throws AccessException, DuplicateException
	Add a new Queue. More...

void	callback (string callbackCallerName, string callbackCalleeNumber, string dialNumber, Telephony::CallbackMode mode)
	Initiate a 2-way calling. More...

HlrDipping::DippingResult	dipHlr (string number) throws EmptyArgumentException, GenericException
	Performs the dipping of a E.164 number in a HLR. More...

HlrDipping::BatchDippingResultSequence	dipHlrBatch (StringSequence numbers) throws GenericException
	Performs the dipping of a batch of E.164 numbers in a HLR. More...

LnpMnpDipping::DippingResult	dipLnpMnp (string numbers) throws EmptyArgumentException, GenericException
	Performs the dipping of a E.164 number in a LNP/MNP registry. More...

LnpMnpDipping::BatchDippingResultSequence	dipLnpMnpBatch (StringSequence numbers) throws GenericException
	Performs the dipping of E.164 numbers in a LNP/MNP registry. More...

Peer::Company *	findCompanyById (long id) throws AccessException
	Obtain the proxy to a Company by its unique ID. More...

Peer::Company *	findCompanyByName (string name) throws AccessException
	Obtain the proxy to a Company by its unique name. More...

Billing::Currency *	findCurrencyByName (string name) throws AccessException
	Obtain the proxy to a Currency by its name. More...

Peer::Gateway *	findGatewayById (int id) throws AccessException
	Obtain the proxy to a Gateway by its unique ID. More...

Peer::Originator *	findOriginatorById (int id) throws AccessException
	Obtain the proxy to an Originator by its unique ID. More...

Peer::GenericPeer *	findPeerById (Peer::PeerType peerType, int id) throws AccessException
	Obtain the proxy to a GenericPeer by its unique ID. More...

Telephony::Queue *	findQueueById (long id) throws AccessException
	Obtain the proxy to a Queue by its unique ID. More...

Telephony::Queue *	findQueueByName (string name) throws AccessException
	Obtain the proxy to a Queue by its unique name. More...

Billing::RefillVoucher *	findRefillVoucher (string code) throws AccessException
	Obtain the proxy to a RefillVoucher by its secret code. More...

Billing::Service *	findServiceById (long id) throws AccessException
	Obtain the proxy to a Service by its id. More...

Billing::Service *	findServiceByName (string name) throws AccessException
	Obtain the proxy to a Service by its name. More...

Peer::Terminator *	findTerminatorById (int id) throws AccessException
	Obtain the proxy to a Terminator by its unique ID. More...

Peer::User *	findUserById (int userId) throws AccessException
	Obtain the proxy to a User by its unique ID. More...

Peer::User *	findUserByLogin (string login) throws AccessException
	Obtain the proxy to a User by its login. More...

Peer::User *	findUserByName (string userName) throws AccessException
	Obtain the proxy to a User by its name. More...

Peer::UserGroup *	findUserGroupById (int id) throws AccessException
	Obtain the proxy to a UserGroup by its unique ID. More...

StringSequence	generateUsers (string profile, int groupId, int count, int attempts) throws AccessException, ArgumentException, Peer::UserGeneration::IntegerOverflowException, Peer::DescendantLimitReachedException, Peer::UserGeneration::DuplicateNameException, Peer::UserGeneration::WeakPasswordException
	Generate new users. More...

Peer::UserGeneration::UserInfoSequence	generateUsersWithInfo (string profile, int groupId, int count) throws AccessException, ArgumentException, Peer::UserGeneration::IntegerOverflowException, Peer::DescendantLimitReachedException, Peer::UserGeneration::DuplicateNameException, Peer::UserGeneration::WeakPasswordException
	Generate new users. More...

Telephony::CallGeneration::TaskSequence	getCallGenerationTasks (long offset) throws AccessException

Telephony::CdrSequence	getCdr (PeerDesc peerDesc, Telephony::CdrFilter filter, long offset) throws AccessException, DbQueryTooLongException
	Obtain Telephony::Cdr with specified filters applied. More...

Telephony::ChannelInfoSequence	getChannels () throws AccessException
	Obtain the currently active channels (active calls). More...

Billing::ServiceSequence	getServices ()
	Obtain the sequence of proxies to available Services. More...

Peer::User *	getUser ()
	Obtain the proxy to a User whoose credentials were used to log in. More...

void	hangupChannel (string channelId) throws AccessException

void	hangupChannels (StringSequence channelIds) throws AccessException
	Hangup the channels by their IDs. More...

void	pickupChannel (string channelName, string displayName) throws AccessException
	Picks up a channel. More...

Messaging::SendingResult	sendMessage (Messaging::Message message) throws ArgumentException, GenericException
	Sends a Message. More...

Messaging::BatchSendingResultSequence	sendMessageBatch (Messaging::MessageSequence messages) throws GenericException
	Sends a batch of messages. More...

void	spyChannel (string channelName, string displayName, SpyMode mode) throws AccessException
	Starts spying on a channel. More...

Operations inherited from Glacier2::Session
void	destroy ()

Detailed Description

This is the main interface from which you can gain access to other Smartswitch entities.

Operation Documentation

◆ addCallGenerationTask()

Telephony::CallGeneration::Task* addCallGenerationTask ( ) throws AccessException

Add a new Telephony::CallGeneration::Task.

You should configure the task and then start it.

Returns: Task, which is not yet active.

◆ addQueue()

Telephony::Queue* addQueue ( string name ) throws AccessException, DuplicateException

Add a new Queue.

Parameters

name	The name of the Queue.

Returns: The proxy to the newly added Queue.

◆ callback()

void callback	(	string	callbackCallerName,
		string	callbackCalleeNumber,
		string	dialNumber,
		Telephony::CallbackMode	mode
	)

Initiate a 2-way calling.

Smartswitch first dials the callback party.
When the callback party answers, Smartswitch dials the dial party.
When the dial party answers, Smartswitch bridges it with the callback party.

Parameters

callbackCallerName	The caller name to be used when dialing the `callback` party. This name is displayed on the phone of the `callback` party. It could be used to display some information regarding the `dial` party to the `callback` party.
callbackCalleeNumber	The number of the `callback` party which is dialed first.
dialNumber	The number of the `dial` party which is dialed second.
mode	The CallbackMode of dialing both parties.

◆ dipHlr()

HlrDipping::DippingResult dipHlr ( string number ) throws EmptyArgumentException, GenericException

Performs the dipping of a E.164 number in a HLR.

Parameters

number The E.164 number to dip.

Returns: The dipping result.

◆ dipHlrBatch()

HlrDipping::BatchDippingResultSequence dipHlrBatch ( StringSequence numbers ) throws GenericException

Performs the dipping of a batch of E.164 numbers in a HLR.

Parameters

numbers The sequence of E.164 numbers to dip.

Returns: The dipping result.

◆ dipLnpMnp()

LnpMnpDipping::DippingResult dipLnpMnp ( string numbers ) throws EmptyArgumentException, GenericException

Performs the dipping of a E.164 number in a LNP/MNP registry.

Parameters

number The E.164 number to dip.

Returns: The dipping result.

◆ dipLnpMnpBatch()

LnpMnpDipping::BatchDippingResultSequence dipLnpMnpBatch ( StringSequence numbers ) throws GenericException

Performs the dipping of E.164 numbers in a LNP/MNP registry.

Parameters

number The E.164 numbers to dip.

Returns: The dipping result.

◆ findCompanyById()

Peer::Company* findCompanyById ( long id ) throws AccessException

Obtain the proxy to a Company by its unique ID.

Parameters

id	The unique ID of the Company.

Returns: The proxy to the Company, if found.
NULL otherwise.

◆ findCompanyByName()

Peer::Company* findCompanyByName ( string name ) throws AccessException

Obtain the proxy to a Company by its unique name.

Parameters

name	The name of the Company.

Returns: The proxy to the Company, if found.
NULL otherwise.

◆ findCurrencyByName()

Billing::Currency* findCurrencyByName ( string name ) throws AccessException

Obtain the proxy to a Currency by its name.

Parameters

name	The name of a Currency (for example, "USD").

Returns: The proxy to the Currency, if found.
NULL otherwise.

◆ findGatewayById()

Peer::Gateway* findGatewayById ( int id ) throws AccessException

Obtain the proxy to a Gateway by its unique ID.

Parameters

id	The unique ID of the Gateway.

Returns: The proxy to the Gateway, if found.
NULL otherwise.

◆ findOriginatorById()

Peer::Originator* findOriginatorById ( int id ) throws AccessException

Obtain the proxy to an Originator by its unique ID.

Parameters

id	The unique ID of the Originator.

Returns: The proxy to the Originator, if found.
NULL otherwise.

◆ findPeerById()

Peer::GenericPeer* findPeerById	(	Peer::PeerType	peerType,
		int	id
	)		throws AccessException

Obtain the proxy to a GenericPeer by its unique ID.

Parameters

id	The unique ID of the GenericPeer.

Returns: The proxy to the GenericPeer, if found.
NULL otherwise.

◆ findQueueById()

Telephony::Queue* findQueueById ( long id ) throws AccessException

Obtain the proxy to a Queue by its unique ID.

Parameters

id	The unique ID of the Queue.

Returns: The proxy to the Queue, if found.
NULL otherwise.

◆ findQueueByName()

Telephony::Queue* findQueueByName ( string name ) throws AccessException

Obtain the proxy to a Queue by its unique name.

Parameters

name	The name of the Queue.

Returns: The proxy to the Queue, if found.
NULL otherwise.

◆ findRefillVoucher()

Billing::RefillVoucher* findRefillVoucher ( string code ) throws AccessException

Obtain the proxy to a RefillVoucher by its secret code.

Parameters

code	The secret code of the RefillVoucher.

Returns: The proxy to the RefillVoucher, if found.
NULL otherwise.

◆ findServiceById()

Billing::Service* findServiceById ( long id ) throws AccessException

Obtain the proxy to a Service by its id.

Parameters

id	The ID of a Service.

Returns: The proxy to the Service, if found.
NULL otherwise.

◆ findServiceByName()

Billing::Service* findServiceByName ( string name ) throws AccessException

Obtain the proxy to a Service by its name.

Parameters

name	The name of a Service.

Returns: The proxy to the Service, if found.
NULL otherwise.

◆ findTerminatorById()

Peer::Terminator* findTerminatorById ( int id ) throws AccessException

Obtain the proxy to a Terminator by its unique ID.

Parameters

id	The unique ID of the Terminator.

Returns: The proxy to the Terminator, if found.
NULL otherwise.

◆ findUserById()

Peer::User* findUserById ( int userId ) throws AccessException

Obtain the proxy to a User by its unique ID.

Returns: The proxy for an existing User.

◆ findUserByLogin()

Peer::User* findUserByLogin ( string login ) throws AccessException

Obtain the proxy to a User by its login.

Returns: The proxy for an existing User.

◆ findUserByName()

Peer::User* findUserByName ( string userName ) throws AccessException

Obtain the proxy to a User by its name.

Returns: The proxy for an existing User.

◆ findUserGroupById()

Peer::UserGroup* findUserGroupById ( int id ) throws AccessException

Obtain the proxy to a UserGroup by its unique ID.

Parameters

id	The unique ID of the UserGroup.

Returns: The proxy to the Gateway, if found.
NULL otherwise.

◆ generateUsers()

["deprecate:generateUsers() has been deprecated at 2018-10-01 and will be removed after 2021-10-01, use generateUsersWithInfo() instead"]

StringSequence generateUsers	(	string	profile,
		int	groupId,
		int	count,
		int	attempts
	)		throws AccessException, ArgumentException, Peer::UserGeneration::IntegerOverflowException, Peer::DescendantLimitReachedException, Peer::UserGeneration::DuplicateNameException, Peer::UserGeneration::WeakPasswordException

Generate new users.

param profile The name of a User generation profile. param groupId The unique ID of a UserGroup to which to push new users. param count The count of users to generate. param attempts The count of attempts to generate unique name for a User.
If unable to generate after that - DuplicateNameException is thrown.

Returns: The sequence of new User names.

See also: generateUsersWithInfo()

◆ generateUsersWithInfo()

Peer::UserGeneration::UserInfoSequence generateUsersWithInfo	(	string	profile,
		int	groupId,
		int	count
	)		throws AccessException, ArgumentException, Peer::UserGeneration::IntegerOverflowException, Peer::DescendantLimitReachedException, Peer::UserGeneration::DuplicateNameException, Peer::UserGeneration::WeakPasswordException

Generate new users.

param profile The name of a User generation profile. param groupId The unique ID of a UserGroup to which to push new users. param count The count of users to generate.

Returns: The sequence of UserInfo for the newly created Users.

◆ getCallGenerationTasks()

Telephony::CallGeneration::TaskSequence getCallGenerationTasks ( long offset ) throws AccessException

Parameters

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

Returns: 100 records starting from offset.

◆ getCdr()

Telephony::CdrSequence getCdr	(	PeerDesc	peerDesc,
		Telephony::CdrFilter	filter,
		long	offset
	)		throws AccessException, DbQueryTooLongException

Obtain Telephony::Cdr with specified filters applied.

Parameters

peerDesc	Determines CDRs of which peers to retrieve.
filter	The filter to apply when retrieving CDRs.
offset	Skip 'offset' records when retrieving. Use offset = 0 to get first 100 records.

Returns: 100 records starting from offset.

◆ getChannels()

Telephony::ChannelInfoSequence getChannels ( ) throws AccessException

Obtain the currently active channels (active calls).

Returns: The sequence of ChannelInfo.

◆ getServices()

Billing::ServiceSequence getServices ( )

Obtain the sequence of proxies to available Services.

Returns: The sequence of proxies to available Services.

◆ getUser()

Peer::User* getUser ( )

Obtain the proxy to a User whoose credentials were used to log in.

Returns: The proxy for an existing User.

◆ hangupChannel()

["deprecate:hangupChannel() has been deprecated at 2018-11-19 and will be removed after 2021-11-19, use hangupChannels() instead"]

void hangupChannel ( string channelId ) throws AccessException

◆ hangupChannels()

void hangupChannels ( StringSequence channelIds ) throws AccessException

Hangup the channels by their IDs.

The ID of a channel could be retrieved from ChannelInfo.

Parameters

channelIds The sequence of channel IDs.

◆ pickupChannel()

void pickupChannel	(	string	channelName,
		string	displayName
	)		throws AccessException

Picks up a channel.

Smartswitch dials the User under whose credentials the ICE Session has been established.
When the User answers, Smartswitch picks up a given channelName for this user.

Parameters

channelName	The channel to spy on.
displayName	The name to use to dial the User.

◆ sendMessage()

Messaging::SendingResult sendMessage ( Messaging::Message message ) throws ArgumentException, GenericException

Sends a Message.

Parameters

message The Message to send.

Returns: The Message sending result.

◆ sendMessageBatch()

Messaging::BatchSendingResultSequence sendMessageBatch ( Messaging::MessageSequence messages ) throws GenericException

Sends a batch of messages.

Parameters

messages The sequence of messages to send.

Returns: The results of sending the messages.

◆ spyChannel()

void spyChannel	(	string	channelName,
		string	displayName,
		SpyMode	mode
	)		throws AccessException

Starts spying on a channel.

Smartswitch dials the User under whose credentials the ICE Session has been established.
When the User answers, Smartswitch starts spying to the channelName for this user.

Parameters

channelName	The channel to spy on.
displayName	The name to use to dial the User.
mode	The SpyMode to use for the spying.

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

/usr/ports/net/smartswitch/work/smartswitch-9.1.60971/ice/Session.ice

Operations

Detailed Description

Operation Documentation

◆ addCallGenerationTask()

◆ addQueue()

◆ callback()

◆ dipHlr()

◆ dipHlrBatch()

◆ dipLnpMnp()

◆ dipLnpMnpBatch()

◆ findCompanyById()

◆ findCompanyByName()

◆ findCurrencyByName()

◆ findGatewayById()

◆ findOriginatorById()

◆ findPeerById()

◆ findQueueById()

◆ findQueueByName()

◆ findRefillVoucher()

◆ findServiceById()

◆ findServiceByName()

◆ findTerminatorById()

◆ findUserById()

◆ findUserByLogin()

◆ findUserByName()

◆ findUserGroupById()

◆ generateUsers()

◆ generateUsersWithInfo()

◆ getCallGenerationTasks()

◆ getCdr()

◆ getChannels()

◆ getServices()

◆ getUser()

◆ hangupChannel()

◆ hangupChannels()

◆ pickupChannel()

◆ sendMessage()

◆ sendMessageBatch()

◆ spyChannel()