Interface to modify caller ID replacement for a User. More...

defined in <UserCallerId.ice>

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

Inheritance diagram for Smartswitch::Peer::UserCallerId:

Collaboration diagram for Smartswitch::Peer::UserCallerId:

Operations
idempotent string	getCalleeIdPattern () throws AccessException
	Obtain the `callee ID pattern` (i.e. More...

idempotent string	getCallerName () throws AccessException
	Obtain the `caller name` which will be passed in the egress calls to the upstream provider for the ingress calls from the User. More...

idempotent string	getCallerNumber () throws AccessException
	Obtain the `caller number` which will be passed in the egress calls to the upstream provider for the ingress calls from the User. More...

idempotent long	getPriority () throws AccessException
	Obtain the `priority` of this replacement rule. More...

idempotent string	getRealCalleeIdPattern () throws AccessException
	Obtain the `real callee ID pattern` (i.e. More...

void	remove () throws AccessException
	Remove this caller ID replacement rule. More...

idempotent void	setCalleeIdPattern (string calleeIdPattern) throws AccessException, DuplicateException
	Set the `callee ID pattern` (i.e. More...

idempotent void	setCallerName (string callerName) throws AccessException
	Set the `caller name` which will be passed in the egress calls to the upstream provider for the ingress calls from the User. More...

idempotent void	setCallerNumber (string callerNumber) throws AccessException, DuplicateException
	Set the `caller number` which will be passed in the egress calls to the upstream provider for the ingress calls from the User. More...

idempotent void	setPriority (long priority) throws AccessException
	Set the `priority` of this replacement rule. More...

idempotent void	setRealCalleeIdPattern (string realCalleeIdPattern) throws AccessException, DuplicateException
	Set the `real callee ID pattern` (i.e. More...

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

Detailed Description

Interface to modify caller ID replacement for a User.

These settings are used by the Smartswitch to replace a caller number and caller name for the calls from the User.
This is needed to bind a specific A-number and A-name to the user, so that he won't be able to call using other user's caller information.
The latter is considered a crime in many countries and thus it's needed to use this function in a safe User configuration.

Operation Documentation

◆ getCalleeIdPattern()

idempotent string getCalleeIdPattern ( ) throws AccessException

Obtain the callee ID pattern (i.e.

a dialed number without a prefix) which should be matched for this caller ID substitution to activate.

This gives user the possibility to choose a caller ID to use based on the county code of dialed number.
It pattern is empty - it matches any callee ID.

See also: getCalleeIdPattern()

Returns: The real callee ID pattern.

◆ getCallerName()

idempotent string getCallerName ( ) throws AccessException

Obtain the caller name which will be passed in the egress calls to the upstream provider for the ingress calls from the User.

Returns: The User's caller name.

◆ getCallerNumber()

idempotent string getCallerNumber ( ) throws AccessException

Obtain the caller number which will be passed in the egress calls to the upstream provider for the ingress calls from the User.

Returns: The User's caller number.

◆ getPriority()

idempotent long getPriority ( ) throws AccessException

Obtain the priority of this replacement rule.

This gives user the possibility to set the order of evaluation of the replacement rules.
The rules are evaluated consequently with ascending order of the priority.
If some rules have same priority and all othem match - a caller ID is picked up randomly among them.

Returns: The priority of the caller ID replacement rule.

◆ getRealCalleeIdPattern()

idempotent string getRealCalleeIdPattern ( ) throws AccessException

Obtain the real callee ID pattern (i.e.

a dialed number with a prefix) which should be matched for this caller ID substitution to activate.

This gives user the possibility to choose a caller ID to use based on the prefix of dialed number.
It pattern is empty - it matches any callee ID.

Returns: The real callee ID pattern.

◆ remove()

void remove ( ) throws AccessException

Remove this caller ID replacement rule.

◆ setCalleeIdPattern()

idempotent void setCalleeIdPattern ( string calleeIdPattern ) throws AccessException, DuplicateException

Set the callee ID pattern (i.e.

a dialed number without a prefix) which should be matched for this caller ID substitution to activate.

See also: getCalleeIdPattern()

Parameters

calleeIDPattern The callee ID pattern.

◆ setCallerName()

idempotent void setCallerName ( string callerName ) throws AccessException

Set the caller name which will be passed in the egress calls to the upstream provider for the ingress calls from the User.

Parameters

callerName The User's caller name.

◆ setCallerNumber()

idempotent void setCallerNumber ( string callerNumber ) throws AccessException, DuplicateException

Set the caller number which will be passed in the egress calls to the upstream provider for the ingress calls from the User.

Parameters

callerNumber The User's caller number.

◆ setPriority()

idempotent void setPriority ( long priority ) throws AccessException

Set the priority of this replacement rule.

See also: getPriority()

Parameters

priority The priority of the caller ID replacement rule.

◆ setRealCalleeIdPattern()

idempotent void setRealCalleeIdPattern ( string realCalleeIdPattern ) throws AccessException, DuplicateException

Set the real callee ID pattern (i.e.

a dialed number with a prefix) which should be matched for this caller ID substitution to activate.

See also: getRealCalleeIdPattern()

Parameters

realCalleeIdPattern The real callee ID pattern.

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

/usr/ports/net/smartswitch/work/smartswitch-9.1.60971/ice/Peer/UserCallerId.ice

Operations

Detailed Description

Operation Documentation

◆ getCalleeIdPattern()

◆ getCallerName()

◆ getCallerNumber()

◆ getPriority()

◆ getRealCalleeIdPattern()

◆ remove()

◆ setCalleeIdPattern()

◆ setCallerName()

◆ setCallerNumber()

◆ setPriority()

◆ setRealCalleeIdPattern()