Class IppbxServerFacade

Namespace
SWConfigDataClientLib.Proxies.IppbxServer
Assembly
IpPbxCDSClientLib.dll

Facade class for IppbxServer

public class IppbxServerFacade : IppbxServerFacadeBase
Inheritance
SWCFProxy<IppbxServerFacadeClient, IIppbxServerFacade>
IppbxServerFacade
Inherited Members

Constructors

IppbxServerFacade()

Create instance of IppbxServerFacade. Ony used by Unmanaged Wrapper. To create an instance of this class use the LibManager.

public IppbxServerFacade()

Remarks

The connection will be established by the first remote call.

Properties

PoolMaxSize

depcreated

public static int PoolMaxSize { get; set; }

Property Value

int

PoolMinSize

depcreated

public static int PoolMinSize { get; set; }

Property Value

int

m_BaseUrl 

protected override string m_BaseUrl { get; }

Property Value

string

Methods

AddEditablePhoneBookEntry(string, string, string, string, bool)

Adds a new PhoneBookEntry (Global editable phonebook) directly into database.

public int AddEditablePhoneBookEntry(string Name, string Number, string SearchNumber, string Description, bool Hide)

Parameters

Name string

The name of the phone entry

Number string

The number

SearchNumber string

The search number is the canonical representation of the number. It will be generated by the CDS.

Description string

Mandatory description

Hide bool

When set to true the entry will not be shown in phonebook. It will be used to resolve the name for displaying current call informations.

Returns

int

The EntryID of the entry

AddNumberFormatProfileByID(NumberProfilePrimaryCollection, string)

Adds a NumberFormatProfile Entry from database to the given Collection. The Profile is identified by its id. If the profile is already contained by teh collection it will be replaced.

public NumberProfileEntry AddNumberFormatProfileByID(NumberProfilePrimaryCollection collection, string ProfileID)

Parameters

collection NumberProfilePrimaryCollection

The profile entry will be added to this collection.

ProfileID string

Thje id of the profile

Returns

NumberProfileEntry

The added profile will be returned.

AddPhoneCallbackRequest(int, int, string, string, int, SPCBState)

Adds a PhoneCallbackRequest to the given users PhoneCallbackRequest list.

public void AddPhoneCallbackRequest(int IpPbxPhoneCallID, int UserID, string CalledNumber, string CalledName, int CalledUserID, SPCBState State)

Parameters

IpPbxPhoneCallID int

The PhoneCallID same as used in CDR.

UserID int

The ID of the User

CalledNumber string

The called party number

CalledName string

The called party name

CalledUserID int

The called party UserID

State SPCBState

The state of the request

AddPortByLoginID(PortPrimaryCollection, Guid)

Adds or replaces a Port with a given PortID from database

public PortEntry AddPortByLoginID(PortPrimaryCollection collection, Guid gLoginID)

Parameters

collection PortPrimaryCollection

The retrieved entry will be added to this collection.

gLoginID Guid

Returns

PortEntry

Added port entry.

AddPortWithH323Alias(PortPrimaryCollection, string)

Adds or replaces a Port with a given H323 Alias from database

public PortEntry AddPortWithH323Alias(PortPrimaryCollection collection, string H323Alias)

Parameters

collection PortPrimaryCollection

The retrieved entry will be added to this collection.

H323Alias string

The H323 that identifies the entry.

Returns

PortEntry

The added port entry.

AddPortWithPortID(PortPrimaryCollection, int)

Adds or replaces a Port with a given PortID from database

public PortEntry AddPortWithPortID(PortPrimaryCollection collection, int PortID)

Parameters

collection PortPrimaryCollection

The retrieved entry will be added to this collection.

PortID int

The PortID that identifies the Port.

Returns

PortEntry

Added port entry.

AddPortWithSIPUserID(PortPrimaryCollection, string)

Adds or replaces a Port with a given SIPUserID from database

public PortEntry AddPortWithSIPUserID(PortPrimaryCollection collection, string SIPUserID)

Parameters

collection PortPrimaryCollection

The retrieved entry will be added to this collection.

SIPUserID string

The SIPUserID that identifies the entry.

Returns

PortEntry

The added port entry.

AddPortWithSIPUserName(PortPrimaryCollection, string)

Adds or replaces a Port with a given SIPUserName from database

public PortEntry AddPortWithSIPUserName(PortPrimaryCollection collection, string SIPUserName)

Parameters

collection PortPrimaryCollection

The retrieved entry will be added to this collection.

SIPUserName string

The SIPUserName that identifies the entry.

Returns

PortEntry

The added port entry.

CheckClientVersion()

Checks if the client version is supported by the server.

public void CheckClientVersion()

CheckVersion() 

public void CheckVersion()

ConfirmMessageTransport(int)

Confirms the tansport of a message. This method has to be invoked after ProcessIncommingSynchronizationMessage on the remote side has been called.

public void ConfirmMessageTransport(int TransportID)

Parameters

TransportID int

CreateClient(Binding, EndpointAddress) 

protected override IppbxServerFacadeClient CreateClient(Binding binding, EndpointAddress endpointAdrress)

Parameters

binding Binding
endpointAdrress EndpointAddress

Returns

IppbxServerFacadeClient

CreateFullSync() 

public void CreateFullSync()

DeleteEditablePhoneBookEntry(int)

Deletes an new PhoneBookEntry directly

public void DeleteEditablePhoneBookEntry(int EntryID)

Parameters

EntryID int

The EntryID of the entry to be deleted.

DeleteGroupVoiceMessages(int) 

public void DeleteGroupVoiceMessages(int groupId)

Parameters

groupId int

DeletePhoneCallbackRequestByPeers(int, int)

Deletes all UserPhoneCallbackRequests where the UserID and the CalledUserID are UserID1 or UserID2

public void DeletePhoneCallbackRequestByPeers(int UserID1, int UserID2)

Parameters

UserID1 int

First UserID to fit

UserID2 int

Second UserID to fit

DeleteUserVoiceMessages(int) 

public void DeleteUserVoiceMessages(int userId)

Parameters

userId int

DeleteVoiceMessage(int) 

public void DeleteVoiceMessage(int callId)

Parameters

callId int

Dispose() 

public virtual void Dispose()

ForwardVoiceMessageToGroup(int, int, int, string, CallActionProcessedSubscription) 

public void ForwardVoiceMessageToGroup(int callId, int forwardToGroupId, int newCallId, string newCallingName, CallActionProcessedSubscription subscription)

Parameters

callId int
forwardToGroupId int
newCallId int
newCallingName string
subscription CallActionProcessedSubscription

ForwardVoiceMessageToUser(int, int, int, string, CallActionProcessedSubscription) 

public void ForwardVoiceMessageToUser(int callId, int forwardToUserId, int newCallId, string newCallingName, CallActionProcessedSubscription subscription)

Parameters

callId int
forwardToUserId int
newCallId int
newCallingName string
subscription CallActionProcessedSubscription

FreeForReuse() 

public override void FreeForReuse()

GetAllNumberFormatProfiles()

Retrieves a collection of NumberFormatProfileEntry objects containing all profiles.

public NumberProfilePrimaryCollection GetAllNumberFormatProfiles()

Returns

NumberProfilePrimaryCollection

Collection of NumberFormatProfileEntry objects.

GetAllPorts()

Retrieves all Ports including Link and Gateway information.

public PortPrimaryCollection GetAllPorts()

Returns

PortPrimaryCollection

Collection of all ports.

GetAllPortsMatchingPublicNumber(string)

Retrieves all Ports including Link and Gateway information, which matches with one or more of its numberranges to the given number

public PortPrimaryCollection GetAllPortsMatchingPublicNumber(string PublicNumber)

Parameters

PublicNumber string

The givwen public number in canonical form.

Returns

PortPrimaryCollection

Collection of PortEntries.

GetAllPresentityContexts() 

public TSiteContext[] GetAllPresentityContexts()

Returns

TSiteContext[]

GetAllProviderProfiles()

Retrieves all Provider Profiles

public ProviderProfilePrimaryCollection GetAllProviderProfiles()

Returns

ProviderProfilePrimaryCollection

Collection of ProviderProfileEntry objects.

GetCallDetailRecordFileMetaData() 

public CallDetailRecordFileMetaData GetCallDetailRecordFileMetaData()

Returns

CallDetailRecordFileMetaData

GetConnectedSite(Guid)

Retrieves the ConnectedSiteEntry for the given Site Guid

public ConnectedSiteEntry GetConnectedSite(Guid siteGuid)

Parameters

siteGuid Guid

Returns

ConnectedSiteEntry

GetConnectedSite(int)

Retrieves the ConnectedSiteEntry for the given Site Id

public ConnectedSiteEntry GetConnectedSite(int siteId)

Parameters

siteId int

Returns

ConnectedSiteEntry

GetConnectedSites()

Retrieves the all Connected Sites

public ConnectedSitePrimaryCollection GetConnectedSites()

Returns

ConnectedSitePrimaryCollection

GetCurrentServerType() 

public ServerType GetCurrentServerType()

Returns

ServerType

GetCurrentThreadOwner() 

public string GetCurrentThreadOwner()

Returns

string

GetCurrentUserID() 

public int GetCurrentUserID()

Returns

int

GetCurrentUserName() 

public string GetCurrentUserName()

Returns

string

GetCurrentUserName(ref string) 

public int GetCurrentUserName(ref string UserName)

Parameters

UserName string

Returns

int

GetDBEngineEdition()

Retrieves number describing the database engine edition.

public SQLEngine GetDBEngineEdition()

Returns

SQLEngine

Engine Edition

GetDBSchema()

Gets the current database schema version.

public int GetDBSchema()

Returns

int

Schema version.

GetDBSchemaDate()

Retrieves the date of the last database schema update.

public SDateTime GetDBSchemaDate()

Returns

SDateTime

Date of last schema update.

GetDcfRegisterFailedContent(string)

returns vendor specific content for failure registration.

public string GetDcfRegisterFailedContent(string hardwareId)

Parameters

hardwareId string

Returns

string

dcf device info objects

GetFastDialDestination(string)

Gets a destinaton number for the mem fast dial feature by mobileId. Only numbers set by the ClientRestAPI (NGClients) will be returned. Fast dial destination numbers will expire after one minute.

public string GetFastDialDestination(string mobileId)

Parameters

mobileId string

The reference id from the movbile phone

Returns

string

Number or emoty string

GetFreeStatusText(int) 

public string GetFreeStatusText(int iUserID)

Parameters

iUserID int

Returns

string

GetGroupVoiceMessages(int) 

public VoiceMessageList GetGroupVoiceMessages(int groupId)

Parameters

groupId int

Returns

VoiceMessageList

GetLocalSiteId()

Retrieves the ID of the local site

public int GetLocalSiteId()

Returns

int

GetLocationUndeliverableCallsNumberByID(int) 

public string GetLocationUndeliverableCallsNumberByID(int iLocationID)

Parameters

iLocationID int

Returns

string

GetMatchingNumberOwners(int, CallingPartyType, string, bool, bool, bool, bool, out int, out bool)

Retrieves a list of owners of the Number

public NumberOwnerListPrimaryCollection GetMatchingNumberOwners(int CallingPartyId, CallingPartyType CallingPartyType, string Number, bool IncludePublicNumbers, bool IncludeInternalNumbers, bool IncludeMobileNumbers, bool IncludeExternalNumbers, out int PossibleHits, out bool IsNumberConfiguredOnTrunk)

Parameters

CallingPartyId int

The Id of the CallingParty (UserID or PortID)

CallingPartyType CallingPartyType

The Type of the CallingParty

Number string

The number (starting fragment)

IncludePublicNumbers bool

true if the number should be searched in the list of public numbers

IncludeInternalNumbers bool

true if the number should be searched in the list of internal numbers

IncludeMobileNumbers bool

true if the number shaould searched in the the list of assigned mobile numbers

IncludeExternalNumbers bool

true if the number shaould searched in the the list of external numbers from users in connected sites

PossibleHits int

Returns the count of possible hits.

IsNumberConfiguredOnTrunk bool

Returns if the number is defined on one or mor trunks.

Returns

NumberOwnerListPrimaryCollection

Returns one list of matching users with additional informations. The list will contain no user, one user or all users of one group.

Remarks

Result will be cached for 20 sec.

GetMatchingNumberOwners(int, CallingPartyType, string, bool, bool, bool, bool, out int, out bool, out AddressResolutionContext)

Retrieves a list of owners of the Number

public NumberOwnerListPrimaryCollection GetMatchingNumberOwners(int CallingPartyId, CallingPartyType CallingPartyType, string Number, bool IncludePublicNumbers, bool IncludeInternalNumbers, bool IncludeMobileNumbers, bool IncludeExternalNumbers, out int PossibleHits, out bool IsNumberConfiguredOnTrunk, out AddressResolutionContext addrResolutionContext)

Parameters

CallingPartyId int

The Id of the CallingParty (UserID or PortID)

CallingPartyType CallingPartyType

The Type of the CallingParty

Number string

The number (starting fragment)

IncludePublicNumbers bool

true if the number should be searched in the list of public numbers

IncludeInternalNumbers bool

true if the number should be searched in the list of internal numbers

IncludeMobileNumbers bool

true if the number shaould searched in the the list of assigned mobile numbers

IncludeExternalNumbers bool

true if the number shaould searched in the the list of external numbers from users in connected sites

PossibleHits int

Returns the count of possible hits.

IsNumberConfiguredOnTrunk bool

Returns if the number is defined on one or mor trunks.

addrResolutionContext AddressResolutionContext

Returns an AddressResolutionContext

Returns

NumberOwnerListPrimaryCollection

Returns one list of matching users with additional informations. The list will contain no user, one user or all users of one group.

Remarks

Result will be cached for 20 sec.

GetMatchingNumberOwners(int, CallingPartyType, string, bool, bool, bool, out int, out bool)

Retrieves a list of owners of the Number

public NumberOwnerListPrimaryCollection GetMatchingNumberOwners(int CallingPartyId, CallingPartyType CallingPartyType, string Number, bool IncludePublicNumbers, bool IncludeInternalNumbers, bool IncludeMobileNumbers, out int PossibleHits, out bool IsNumberConfiguredOnTrunk)

Parameters

CallingPartyId int

The Id of the CallingParty (UserID or PortID)

CallingPartyType CallingPartyType

The Type of the CallingParty

Number string

The number (starting fragment)

IncludePublicNumbers bool

true if the number should be searched in the list of public numbers

IncludeInternalNumbers bool

true if the number should be searched in the list of internal numbers

IncludeMobileNumbers bool

true if the number shaould searched in the the list of assigned mobile numbers

PossibleHits int

Returns the count of possible hits.

IsNumberConfiguredOnTrunk bool

Returns if the number is defined on one or mor trunks.

Returns

NumberOwnerListPrimaryCollection

Returns one list of matching users with additional informations. The list will contain no user, one user or all users of one group.

Remarks

Result will be cached for 20 sec.

GetMatchingNumberOwners(int, CallingPartyType, string, bool, bool, out int, out bool)

Retrieves a list of owners of the Number

public NumberOwnerListPrimaryCollection GetMatchingNumberOwners(int CallingPartyId, CallingPartyType CallingPartyType, string Number, bool IncludePublicNumbers, bool IncludeInternalNumbers, out int PossibleHits, out bool IsNumberConfiguredOnTrunk)

Parameters

CallingPartyId int

The Id of the CallingParty (UserID or PortID)

CallingPartyType CallingPartyType

The Type of the CallingParty

Number string

The number (starting fragment)

IncludePublicNumbers bool

true if the number should be searched in the list of public numbers

IncludeInternalNumbers bool

true if the number should be searched in the list of internal numbers

PossibleHits int

Returns the count of possible hits.

IsNumberConfiguredOnTrunk bool

Returns if the number is defined on one or mor trunks.

Returns

NumberOwnerListPrimaryCollection

Returns one list of matching users with additional informations. The list will contain no user, one user or all users of one group.

Remarks

Result will be cached for 20 sec.

GetMatchingPublicNumber(int, int, int, string)

Retrieves a matching public for the given parameters.

public string GetMatchingPublicNumber(int UserID, int PortID, int PortBundleID, string InternalNumber)

Parameters

UserID int

The id of the user.

PortID int

ID of the Port where the call goes through

PortBundleID int

ID of the PortBundle corresponding to the Port

InternalNumber string

Internal Number of the user which is used for this call

Returns

string

One public number as a string

GetMatchingRoutedNumberEntries(string, string, int, CallingPartyType, string, SDateTime, bool, AddressResolutionContext, out int, out int, out string) 

public MatchingRoutedNumberPrimaryCollection GetMatchingRoutedNumberEntries(string DialedNumber, string NumberServerRepresentation, int callingPartyID, CallingPartyType callingPartyType, string callingPartyNumber, SDateTime dateTime, bool ReturnAllPossible, AddressResolutionContext cAddressResolutionContext, out int PossibleMatchingEntries, out int PossibleMatchingPrefixes, out string ResultingNumber)

Parameters

DialedNumber string
NumberServerRepresentation string
callingPartyID int
callingPartyType CallingPartyType
callingPartyNumber string
dateTime SDateTime
ReturnAllPossible bool
cAddressResolutionContext AddressResolutionContext
PossibleMatchingEntries int
PossibleMatchingPrefixes int
ResultingNumber string

Returns

MatchingRoutedNumberPrimaryCollection

GetMatchingRoutedNumberEntries(string, string, int, CallingPartyType, string, SDateTime, bool, out int, out int, out string)

This Method retrieves a list of best matching routed number entries for the starting number fragment defined in the parameter numbers. The list is empty when more than one routed numbers matches the number fragment and there is chance to get a better match with a longer starting fragment. If there is only one entry, which possibly match the number, the entry will bie returned. RoutedNumberEntries with retry > 0 will occur retry+1 times in the returning collection.

public MatchingRoutedNumberPrimaryCollection GetMatchingRoutedNumberEntries(string DialedNumber, string NumberServerRepresentation, int callingPartyID, CallingPartyType callingPartyType, string callingPartyNumber, SDateTime dateTime, bool ReturnAllPossible, out int PossibleMatchingEntries, out int PossibleMatchingPrefixes, out string ResultingNumber)

Parameters

DialedNumber string

The starting number fragment of thr dialed number. The number formatis [PortPrefix][+|PublicAccessPrefix]any*

NumberServerRepresentation string

This number is used for retrieving access rights. Can be emtpy. In this case the normalized dialed number will be used.

callingPartyID int

The calling party id is either an UserID or a PortID

callingPartyType CallingPartyType

User or Port

callingPartyNumber string

The number of the callig device. If the calling party is a user The internal number of the user device should be used. If the calling party is trunk a canonaical number or a SIP uri will be valid.

dateTime SDateTime

time of the call as a UTC datetime

ReturnAllPossible bool

When true the method returns a list of all possible hits otherwise it will return al list of matching hits

PossibleMatchingEntries int

returns the number of possible matching routed number entries

PossibleMatchingPrefixes int

returns the number of possible matching prefixes

ResultingNumber string

returns the number as an canonical number. Country- and AreaCode will be retrieved from the calling parties location.

Returns

MatchingRoutedNumberPrimaryCollection

Return a list of MatchingRoutedNumberEntry

Remarks

The returning list contains: RoutingAccessGranted: bool true if routing is granted (always true) Priority int: Priority of the routing entry (list is sorted by this column) NoFurtherRetries: PublicAccessPrefix: The PublicAccesPrefix found. If there is no one the default PublicAccessPrefix of the PortBundles Location will be returned. PortBundlePrefix: The PortBundleAccesPrefix found. MatchingType NumberAccessGranted bool: is true when calling party has permission to call the number otherwise false ItemID: PortBundleID

GetNameByNumberNew(string, int) 

public NamesByNumberPrimaryCollection GetNameByNumberNew(string number, int userId)

Parameters

number string
userId int

Returns

NamesByNumberPrimaryCollection

GetNamesByNumber(string)

Retrieves a collection of phonebook entries which matches with the given number. The system phonebook and the global editable phonebook will be searched.

public NamesByNumberPrimaryCollection GetNamesByNumber(string Number)

Parameters

Number string

Number

Returns

NamesByNumberPrimaryCollection

Collection of phonebook entries.

GetNamesByNumber(string, int)

Retrieves a collection of phonebook entries which matches with the given number. The users phonebook, the system phonebook and the global editable phonebook will be searched.

public NamesByNumberPrimaryCollection GetNamesByNumber(string Number, int UserID)

Parameters

Number string

Number

UserID int

The users ID.

Returns

NamesByNumberPrimaryCollection

Collection of phonebook entries.

GetNewOldPhoneCallCount(int, out int, out int)

Retrieves the new/old calls count pair to use in MWI subscription

public void GetNewOldPhoneCallCount(int userID, out int newCallCount, out int oldCallCount)

Parameters

userID int

User ID

newCallCount int

New calls count

oldCallCount int

Old calls count

GetNextRoutingChangeTime()

Returns the next time when a routing record schedule changes

public DateTime GetNextRoutingChangeTime()

Returns

DateTime

Date of next change.

GetNextRoutingChangeTime(int)

Returns the next time when a routing record of the port schedule changes

public DateTime GetNextRoutingChangeTime(int PortID)

Parameters

PortID int

The port

Returns

DateTime

Date of next change.

GetNextSynchronizationMessageFromQueue(SIntList, out int, out int, out string)

Retrieves a single message that has to be tranported by the link manager.

public bool GetNextSynchronizationMessageFromQueue(SIntList OnlinePortIDs, out int TransportID, out int PortID, out string Message)

Parameters

OnlinePortIDs SIntList

The ID of all online trunks.

TransportID int

A ID that have to be used to confirm the transport. Will be 0 if no message avaiable.

PortID int

The ID of the port that havwe to used for transport. Will be 0 if no message avaiable.

Message string

The compressed message itself. Will be null if no message avaiable.

Returns

bool

True if there are more messages in queue ready for transport

GetNumberFormatProfileByID(string)

Retrieves a collection of NumberFormatProfileEntry objects, containing one or no entry.

public NumberProfilePrimaryCollection GetNumberFormatProfileByID(string ProfileID)

Parameters

ProfileID string

The id of the profile to be returned.

Returns

NumberProfilePrimaryCollection

Collection of NumberFormatProfileEntry objects.

GetNumberPossibleHits(string, bool, bool, bool, bool)

Returns object with possible hits (for each number type) and an exact match flag for given number fragment

public NumberPossibleHitsResult GetNumberPossibleHits(string number, bool searchPublicNumbers, bool searchInternalNumbers, bool searchMobileNumbers, bool searchExternalNumbers)

Parameters

number string

Number fragment to search for

searchPublicNumbers bool

Search for hits in the public number table

searchInternalNumbers bool

Search for hits in the internal number table

searchMobileNumbers bool

Search for hits in the user table (mobile phone number are part of the user table)

searchExternalNumbers bool

Search for hits in the external number table

Returns

NumberPossibleHitsResult

Remarks

The given number fragment will NOT be modified (canonicalized) for searching.

GetPBXPhonebook(string, bool)

Retrieves a collection of PBXPhonebook entris matching the filter

public PBXPhonebookPrimaryCollection GetPBXPhonebook(string nameFilter, bool showHidden)

Parameters

nameFilter string

Name of entry. Can contain SQL Like delimters.

showHidden bool

Hidden entries will not be ignored

Returns

PBXPhonebookPrimaryCollection

Collection od PBXPhonebook objects.

GetParallelCalls(int)

Retrieves the list of configured parallel call numbers for the given user.

public SStringList GetParallelCalls(int UserID)

Parameters

UserID int

User sepecified by ID

Returns

SStringList

Parallel Call numbers as a StringList

GetPortSelection(int, int, CallingPartyType, string, string)

Gets a list of all usable ports of a the given PortBundle. The methods evaluates the number to be signaled (NonMatchingNumberBehaviour).

public PortSelectionPrimaryCollection GetPortSelection(int PortBundleID, int CallingPartyID, CallingPartyType CallingPartyType, string CallingNumber, string CalledNumber)

Parameters

PortBundleID int

The id of the port bundle.

CallingPartyID int

The id of the user or port which makes the call.

CallingPartyType CallingPartyType

Type of the calling party: 0=User, 1=Port

CallingNumber string

The calling number. Can an internal or a public number.

CalledNumber string

The called number.

Returns

PortSelectionPrimaryCollection

Collection of PortSelectionEntry objects

Remarks

The returned PortSelectionEntry contains additional flags indicating weather the called number is configured on this port. In that case the port should not be used. There is no ambigous test for SIP uris, the flag will be returning false for every sip uri.

GetPortSelection(int, int, CallingPartyType, string, string, AddressResolutionContext)

Gets a list of all usable ports of a the given PortBundle. The methods evaluates the number to be signaled (NonMatchingNumberBehaviour).

public PortSelectionPrimaryCollection GetPortSelection(int PortBundleID, int CallingPartyID, CallingPartyType CallingPartyType, string CallingNumber, string CalledNumber, AddressResolutionContext cContext)

Parameters

PortBundleID int

The id of the port bundle.

CallingPartyID int

The id of the user or port which makes the call.

CallingPartyType CallingPartyType

Type of the calling party: 0=User, 1=Port

CallingNumber string

The calling number. Can an internal or a public number.

CalledNumber string

The called number.

cContext AddressResolutionContext

Returns

PortSelectionPrimaryCollection

Collection of PortSelectionEntry objects

Remarks

The returned PortSelectionEntry contains additional flags indicating weather the called number is configured on this port. In that case the port should not be used. There is no ambigous test for SIP uris, the flag will be returning false for every sip uri.

GetPortSelectionEx(int, int, CallingPartyType, string, int, string, string, AddressResolutionContext, string)

Gets a list of all usable ports of a the given PortBundle. The methods determiners the number to be signaled on each trunk regarding the singalling template on each trunk.

public PortSelectionPrimaryCollection GetPortSelectionEx(int PortBundleID, int OriginatingPartyID, CallingPartyType OriginatingPartyType, string OriginatingNumber, int RedirectingUserID, string RedirectingNumber, string CalledNumber, AddressResolutionContext cContext, string NetworkSrcNumber)

Parameters

PortBundleID int

The id of the port bundle.

OriginatingPartyID int

The id of the user or port which makes the call.

OriginatingPartyType CallingPartyType

Type of the calling party: 0=User, 1=Port

OriginatingNumber string

The calling number. Can an internal or a public number.

RedirectingUserID int

The id of the redirector

RedirectingNumber string

The number of the redirector

CalledNumber string

The called number.

cContext AddressResolutionContext
NetworkSrcNumber string

The network source number

Returns

PortSelectionPrimaryCollection

Collection of PortSelectionEntry objects

Remarks

The result list is sorted by the MatchType. (Originator>Redirector>SpecificNumber>NoMatch) Furhter the returned PortSelectionEntries contains additional flags indicating weather the called number is configured on this port. In that case the port should not be used. There is no ambigous test for SIP uris, the flag will be returning false for every sip uri. If the OriginatingNumber or the RedirectingNumber are internal and they will replaced by public numbers in the retrieved result.

GetPortsByName(string)

Retrieves all Ports matching the given name

public PortPrimaryCollection GetPortsByName(string name)

Parameters

name string

The port name.

Returns

PortPrimaryCollection

Collection of ports filtered by name.

GetPossibleIpPbxUserNames()

Returns all possible IpPbx User Names of the current user. Can be more than one if the current user is a windows user and multiple IppPbxUser are assigned to his windows account.

public SStringList GetPossibleIpPbxUserNames()

Returns

SStringList

StringList

GetProviderProfileByPortBundleType(PortBundleType)

Retrieves all ProviderProfiles matching the PortBundleType sorted by ProviderProfileName

public ProviderProfilePrimaryCollection GetProviderProfileByPortBundleType(PortBundleType PortBundleType)

Parameters

PortBundleType PortBundleType

The type of the Provider

Returns

ProviderProfilePrimaryCollection

Collection of ProviderProfileEntry objects.

GetProviderProfileByProviderID(string)

Retrieves a Provider Profile

public ProviderProfilePrimaryCollection GetProviderProfileByProviderID(string ProviderID)

Parameters

ProviderID string

The ID of the Provider as it is defined int the ProviderFile

Returns

ProviderProfilePrimaryCollection

Collection of ProviderProfileEntry objects.

GetPublicNumberOwner(string, out bool, out bool, out int, out string)

Searches for the owner of a public number.

public void GetPublicNumberOwner(string publicNumber, out bool UserFound, out bool GroupFound, out int FoundEntryID, out string FoundName)

Parameters

publicNumber string
UserFound bool

Returns true if a user was found.

GroupFound bool

Returns true if a group was found.

FoundEntryID int

The id (user or group) of the owner.

FoundName string

The name of the owner.

GetRecordingCodecs() 

public RecordingCodecList GetRecordingCodecs()

Returns

RecordingCodecList

GetRootAndServerCertificate(out string) 

public bool GetRootAndServerCertificate(out string Certificates)

Parameters

Certificates string

Returns

bool

GetSchemaVersion(out string, out string, out int)

Retrieves schema informations from database.

public void GetSchemaVersion(out string SchemaVer, out string SchemaDate, out int OldVersions)

Parameters

SchemaVer string

Returns the SchemaVersion

SchemaDate string

Returns the date of the last schema update.

OldVersions int

GetServerRequestTimeout(IppbxServerFacadeClient) 

protected override TimeSpan GetServerRequestTimeout(IppbxServerFacadeClient client)

Parameters

client IppbxServerFacadeClient

Returns

TimeSpan

GetSimpleNumberOwnerList(string) 

public SIntList GetSimpleNumberOwnerList(string sInternalNumber)

Parameters

sInternalNumber string

Returns

SIntList

GetSiteGuid(int)

Retrieves the SiteGuid for the given SiteId

public Guid GetSiteGuid(int siteId)

Parameters

siteId int

Returns

Guid

GetSiteId(Guid)

Retrieves the SiteId for the given SiteGuid

public int GetSiteId(Guid siteGuid)

Parameters

siteGuid Guid

Returns

int

GetSupportedClientVersions() 

public SStringList GetSupportedClientVersions()

Returns

SStringList

GetSyncPortsView()

Retrieves a SyncPortsView

public SyncPortsViewPrimaryCollection GetSyncPortsView()

Returns

SyncPortsViewPrimaryCollection

GetThumbprints() 

public SStringList GetThumbprints()

Returns

SStringList

GetTrunkIDByLoginID(Guid)

Check if LoginID is valid and returns TrunksID

public int GetTrunkIDByLoginID(Guid LoginID)

Parameters

LoginID Guid

Guid

Returns

int

Trunk ID (int)

GetUserByVanitiyNumberAndExistingFile(string, string, PreDefinedFileCategory, bool, bool) 

public int[] GetUserByVanitiyNumberAndExistingFile(string VanityNumber, string FileName, PreDefinedFileCategory FileCategory, bool bIncludePrivateFiles, bool bIncludeHiddenFiles)

Parameters

VanityNumber string
FileName string
FileCategory PreDefinedFileCategory
bIncludePrivateFiles bool
bIncludeHiddenFiles bool

Returns

int[]

GetUserIDAndInvalidateLoginID(Guid) 

public int GetUserIDAndInvalidateLoginID(Guid LoginID)

Parameters

LoginID Guid

Returns

int

GetUserIDAndInvalidateLoginID(Guid, LoginIdType)

Check if LoginID is valid and return UserID On success LoginID will be removed

public int GetUserIDAndInvalidateLoginID(Guid LoginID, LoginIdType type)

Parameters

LoginID Guid

Guid

type LoginIdType

Type of the login id. (IpPbxSrv|UaCstaSrv)

Returns

int

User ID (int)

GetUserMINs(int)

Retrieves the list of MobileIdentificationNumbers (MINs) for the current user.

public SStringList GetUserMINs(int UserID)

Parameters

UserID int

User sepecified by ID

Returns

SStringList

StringList

GetUserMessageCounts(int) 

public NumMessages GetUserMessageCounts(int userId)

Parameters

userId int

Returns

NumMessages

GetUserNumberMappings(int)

Retrieves a collection with all number mappings (internal public numbers) of a given user.

public NumberMappingPrimaryCollection GetUserNumberMappings(int UserID)

Parameters

UserID int

The id of the user.

Returns

NumberMappingPrimaryCollection

Collection of NumberMappingEntries

GetUserPresenceData(int, out bool, out bool) 

public void GetUserPresenceData(int iUserID, out bool bIsAway, out bool bDoNotDisturb)

Parameters

iUserID int
bIsAway bool
bDoNotDisturb bool

GetUserVoiceMessages(int) 

public VoiceMessageList GetUserVoiceMessages(int userId)

Parameters

userId int

Returns

VoiceMessageList

HasNextSynchronizationMessage()

Checks for ready messages for transport

public bool HasNextSynchronizationMessage()

Returns

bool

True if there are more messages in queue ready for transport

HasRole(BuildInRoles) 

public bool HasRole(BuildInRoles eRole)

Parameters

eRole BuildInRoles

Returns

bool

IncreaseVoicemail(int)

Increases the voicemail counter by one and returns the actual value

public int IncreaseVoicemail(int UserID)

Parameters

UserID int

Returns

int

actual voicemail counter

InitDatabase()

Inits the database while starting the IpPbxServer. The LgoinTime of all users will be set to null

public void InitDatabase()

IsCallAllowed(int, CallingPartyType, string, string) 

public bool IsCallAllowed(int iCallingPartyID, CallingPartyType eCallingPartyType, string sNumber, string sPublicAccessPrefix)

Parameters

iCallingPartyID int
eCallingPartyType CallingPartyType
sNumber string
sPublicAccessPrefix string

Returns

bool

IsPublicNumberConfiguredOnTrunk(string, out bool)

Checks if the given number is configured on a trunk.

public bool IsPublicNumberConfiguredOnTrunk(string PublicNumber, out bool Ambiguous)

Parameters

PublicNumber string

The number

Ambiguous bool

True if a longer number starting with the given public number may be configured.

Returns

bool

True or False

MessageTranportFailed(int)

Informs the CDS that the tranport of the message has been failed

public void MessageTranportFailed(int TransportID)

Parameters

TransportID int

The Tranport ID that of the message.

ModifyEditablePhoneBookEntry(int, string, string, string, string, bool)

Modifies a PhoneBookEntry directly

public void ModifyEditablePhoneBookEntry(int EntryID, string Name, string Number, string SearchNumber, string Description, bool Hide)

Parameters

EntryID int

The EntryID of the entry to be modified.

Name string

The name of the entry

Number string

The number

SearchNumber string

The search number is the canonical representation of the number. It will be generated by the CDS.

Description string

Mandatory description

Hide bool

When set to true the entry will not be shown in phonebook. It will be used to resolve the name for displaying current call informations.

ParseNumberFormatProfile(NumberProfileEntry)

Parses the XMLCode in the NumberProfileEntry.

public GenericNumberFormatProfile ParseNumberFormatProfile(NumberProfileEntry entry)

Parameters

entry NumberProfileEntry

The NumberProfileEntry to be parsed.

Returns

GenericNumberFormatProfile

GenereicNumberProfile or a derevied class.

ParseNumberFormatProfile(NumberProfileEntry, string, string)

Parses the XMLCode in the NumberProfileEntry.

public GenericNumberFormatProfile ParseNumberFormatProfile(NumberProfileEntry entry, string CountryCode, string AreaCode)

Parameters

entry NumberProfileEntry

The NumberProfileEntry to be parsed.

CountryCode string

Only matching rules will returned

AreaCode string

Only matching rules will returned

Returns

GenericNumberFormatProfile

GenereicNumberProfile or a derevied class.

ParseProviderProfile(ProviderProfileEntry)

Parses the XMLCode in the ProviderProfileEntry.

public GenericProviderProfile ParseProviderProfile(ProviderProfileEntry entry)

Parameters

entry ProviderProfileEntry

The ProviderProfileEntry to be parsed.

Returns

GenericProviderProfile

GenereicProviderProfile or a derevied class.

PingService(IppbxServerFacadeClient) 

protected override void PingService(IppbxServerFacadeClient cProxy)

Parameters

cProxy IppbxServerFacadeClient

ProcessIncommingSynchronizationMessage(int, string)

Process an incomming message from a remote LinkManager (side)

public void ProcessIncommingSynchronizationMessage(int IncommingPortID, string Message)

Parameters

IncommingPortID int

PortID of the trunk

Message string

The compressed Message

ResetDynamicPortPSK(int)

The current preshared key of the given port will be reseted at CDSService

public string ResetDynamicPortPSK(int PortID)

Parameters

PortID int

Returns

string

New PSK

Remarks

To acutalize the PSK in the local user entry, use IpPbxServerFacade.UserPrimaryCollection.PresharedKeyDynamic

ResetDynamicUserPSK(int)

The current preshared key of the given user will be reseted at CDSService

public string ResetDynamicUserPSK(int UserID)

Parameters

UserID int

The id of the given user

Returns

string

New PSK

Remarks

To acutalize the PSK in the local user entry, use IpPbxServerFacade.UserPrimaryCollection.PresharedKeyDynamic

ResetGroupCallDeliveryDisabledFlags() 

public void ResetGroupCallDeliveryDisabledFlags()

ResetPortLoginID(int)

The current LoginID of the given port will be reseted at CDSService

public Guid ResetPortLoginID(int PortID)

Parameters

PortID int

The id of the given port

Returns

Guid

New LoginID

Remarks

To acutalize the LoginID in the local user entry, call IpPbxServerFacade.UserPrimaryCollection.SetLoginID

SetAllGroupVoiceMessageViewedAt(int, bool, int, string) 

public bool SetAllGroupVoiceMessageViewedAt(int groupId, bool viewed, int viewedByUserId, string viewedByFallback)

Parameters

groupId int
viewed bool
viewedByUserId int
viewedByFallback string

Returns

bool

SetAllUserVoiceMessageViewedAt(int, bool, int, string) 

public bool SetAllUserVoiceMessageViewedAt(int userId, bool viewed, int viewedByUserId, string viewedByFallback)

Parameters

userId int
viewed bool
viewedByUserId int
viewedByFallback string

Returns

bool

SetAutoLoginPhone(int, string)

Set the users AutoLoginPhone attribute direct

public bool SetAutoLoginPhone(int UserID, string AutoLoginPhone)

Parameters

UserID int

The users UserID

AutoLoginPhone string

Value of the attribute

Returns

bool

true if successfull

Remarks

This method is a remote one.

SetCallDetailRecordFileMetaData(CallDetailRecordFileMetaData) 

public void SetCallDetailRecordFileMetaData(CallDetailRecordFileMetaData data)

Parameters

data CallDetailRecordFileMetaData

SetConfigurationLoadConfirmation(string, bool) 

public void SetConfigurationLoadConfirmation(string service, bool withoutErrors)

Parameters

service string
withoutErrors bool

SetDefaultForwardingEnabled(int, bool) 

public void SetDefaultForwardingEnabled(int userID, bool value)

Parameters

userID int
value bool

SetDefaultForwardingNumber(int, string) 

public void SetDefaultForwardingNumber(int userID, string value)

Parameters

userID int
value string

SetEmailAddress(int, string) 

public void SetEmailAddress(int userID, string value)

Parameters

userID int
value string

SetForwardOnBusyEnabled(int, bool) 

public void SetForwardOnBusyEnabled(int userID, bool value)

Parameters

userID int
value bool

SetForwardOnBusyNumber(int, string) 

public void SetForwardOnBusyNumber(int userID, string value)

Parameters

userID int
value string

SetForwardOnNoAnswerEnabled(int, bool) 

public void SetForwardOnNoAnswerEnabled(int userID, bool value)

Parameters

userID int
value bool

SetForwardOnNoAnswerNumber(int, string) 

public void SetForwardOnNoAnswerNumber(int userID, string value)

Parameters

userID int
value string

SetForwardOnNoAnswerTimeout(int, int) 

public void SetForwardOnNoAnswerTimeout(int userID, int value)

Parameters

userID int
value int

SetForwardingConfiguration(int, ForwardingConfigParameters) 

public void SetForwardingConfiguration(int userID, ForwardingConfigParameters parameters)

Parameters

userID int
parameters ForwardingConfigParameters

SetFreeStatusText(int, string) 

public void SetFreeStatusText(int iUserID, string strFreeStatusText)

Parameters

iUserID int
strFreeStatusText string

SetLanPhonePin(int, string) 

public void SetLanPhonePin(int userID, string value)

Parameters

userID int
value string

SetNewVoicemailNum(int, int)

Sets the voicemail counter to a given value. The value can be 0. If the value is not 0 it can not be lower than the number in database. In this case the number in database will be increased by one

public int SetNewVoicemailNum(int userID, int number)

Parameters

userID int

The id of the user

number int

New number of voicemail

Returns

int

actual voicemail counter

SetParallelCalls(int, SStringList)

Set Parallel Call numbers for the given user

public void SetParallelCalls(int userID, SStringList numbers)

Parameters

userID int

Id of the User

numbers SStringList

Parallel Call numbers as a StringList

SetUserMINs(int, SStringList)

Sets the list of mobile idtenification numbers (MINs) for the given user.

public void SetUserMINs(int UserID, SStringList MINs)

Parameters

UserID int

User sepecified by ID

MINs SStringList

List of MINs

SetUserPresenceData(int, bool, bool, SDateTime) 

public void SetUserPresenceData(int iUserID, bool bIsAway, bool bDoNotDisturb, SDateTime dExpirationDate)

Parameters

iUserID int
bIsAway bool
bDoNotDisturb bool
dExpirationDate SDateTime

SetVoiceMailFile(int, string) 

public void SetVoiceMailFile(int userID, string value)

Parameters

userID int
value string

SetVoiceMailRecLen(int, int) 

public void SetVoiceMailRecLen(int userID, int value)

Parameters

userID int
value int

SetVoiceMessageViewedAt(int, bool, int, string) 

public bool SetVoiceMessageViewedAt(int callId, bool viewed, int viewedByUserId, string viewedByFallback)

Parameters

callId int
viewed bool
viewedByUserId int
viewedByFallback string

Returns

bool

WriteCallDetailRecord(CallDetailRecord) 

public void WriteCallDetailRecord(CallDetailRecord record)

Parameters

record CallDetailRecord