3CX v16/v18/v20 PowerShell Call Control API

Add-Type -Path "C:\Program files\3CX Phone System\Bin\3cxpscomcpp2.dll"
$PS = [TCX.Configuration.PhoneSystem]
$PS::CfgServerHost = "127.0.0.1"
$PS::CfgServerPort = 5485
$PS::CfgServerUser = "Username aus der INI-Datei"
$PS::CfgServerPassword = 'Passwort aus der INI-Datei'
$PS::ApplicationName = "ContactApp"

#until includung V18 the above worked
#$t = ($PS::Root)

#beginning with v20 we need to use Reset
$t = $PS::Reset($PS::ApplicationName, $PS::CfgServerHost, $PS::CfgServerPort, $PS::CfgServerUser, $PS::CfgServerPassword)

$t.WaitForConnect((New-TimeSpan -Seconds 30))
if ($t.Connected) {
	Write-Host "connection to call api established"
	$3CXTenant = $t.GetTenant()
	$PhoneBookEntries = $3CXTenant.GetPhoneBookEntries()
	Write-Host "Search for Entries being tagged with CustomContact"
	$OurTaggedPBEntries = $PhoneBookEntries | ? {$_.Tag -eq "CustomContact"}
	Write-Host "Found $($OurTaggedPBEntries.Count) Entries"
	if ($($OurTaggedPBEntries.Count) -gt 0) {
		Write-Host "Remove Entries beging tagged with LDAP"
		foreach ($OurTaggedPBEntry in $OurTaggedPBEntries) {
			$ContactDetail = "$($OurTaggedPBEntry.Firstname) $($OurTaggedPBEntry.Lastname) $($OurTaggedPBEntry.CompanyName)"
			try {
				Write-Host "Successfully removed Contact $ContactDetail"
				$OurTaggedPBEntry.Delete()
			} catch {
				Write-Error "Failed to remove Contact $ContactDetail"
			}
		}
	}

	Write-Host "Creating new Contacts"
	while ($x -le 50) {
		try {
			$NewContact =  $3CXTenant.CreatePhoneBookEntry()
			$NewContact.Firstname = "Herrmann$($x)"
			$NewContact.Lastname = "Mustermann$($x)"
			$NewContact.Phonenumber = "004444$($x)"
			$NewContact.Tag = "CustomContact"
			$NewContact.Save()
			$x++
		} catch {
			Write-Error "Failed to Add Contact. $($_.Exception.Message)"
		} 
	}
	$t.Disconnect()
} else {
	Write-Error "connection to call api failed"
}

Über den Autor

Thomas Windscheif arbeitet bei excITe Consulting und ist langjähriger Berater im Bereich IT-Infrastruktur und Groupware. Sowohl Kleinunternehmen z. B. im Handwerk als auch der größere fertigende Mittelstand gehören zu seinem Projektumfeld. Im Wesentlichen gehören die Planung von Infrastruktur-Migrationen, Cloud-Lösungen (Microsoft 365), Groupware-Umgebungen (z. B. Exchange) und deren Umsetzung zu seinen Aufgaben. Insbesondere im Umfeld hybrider Identitätsumgebungen mit Entra Connect und den Möglichkeiten zur Härtung der IT-Landschaft konnte er in vielen Projekten Erfahrungen sammeln. Neues begeistert ihn aber ebenso und so unterstützt Thomas Windscheif auch bei themenfremden IT-Systemen, überall da wo er helfen kann.

Sein Ziel: Die Mehrwerte der heutigen IT-Lösungen für einfacheres und modernes Arbeiten beim Kunden einbringen.