Reference13r1:Concept App Service Contacts
The App Service Contacts is an App Service which can be installed on an innovaphone App Platform. It is used for information retrieval of a database of contact entries.
Features
Database for contact entries. A user interface for retrieval purposes is available.
- Import of comma-separated files
- API for other apps
Requirements
- innovaphone PBX and App Platform from on version 13r1
Details
Assign unique IDs for contacts entries
It is recommended to upload CSV files with an additional column extAnchor. The column extAnchor allows to identify individual entries uniquely and independent of renaming operations. The column extAnchor is supposed to contain an external unique database id, alike a guid. If extAnchor was provided the import procedure will perform an UPDATE of previously existing entries, instead of deleting and re-INSERTing the entries. Entries pinned on home are going to remain functional.
Upload Data by HTTP Post
A CSV file can be uploaded by means of an HTTP POST request.
The following powershell script aims to demonstrate this procedure with the help of CURL[1][2]
The required user and password content corresponds to the configuration underneath PBX Manager/AP Contacts/Configuration/User(HTTP Post) and Password(HTTP Post)
- csv.ps1
- Sample powershell script demonstrating how to HTTP POST a CSV file towards the Contacts App service.
- .\bin\curl must be present, e.g. from https://curl.haxx.se/download.html
- Examples:
- powershell -ExecutionPolicy Bypass -Command .\csv.ps1 -Dest 172.16.18.215 -File ".\myContacts.utf8" -User "contacts01" -Pw "pwd01" -Url "/example.com/contacts01/post/myContacts.utf8?op=csv"
param(
[Parameter(Mandatory=$false, HelpMessage="Destination host")]
[string]$Dest,
[Parameter(Mandatory=$false, HelpMessage="Name of file to be POSTed")]
[string]$File,
[Parameter(Mandatory=$false, HelpMessage="Authentication: User")]
[string]$User,
[Parameter(Mandatory=$false, HelpMessage="Authentication: Password")]
[string]$Pw,
[Parameter(Mandatory=$false, HelpMessage="URL, e.g.: /example.com/contacts01/post/myContacts.csv?op=csv&xml-stats=true")]
[string]$Url
)
Add-Type -AssemblyName System.Web
$Uri = "http://" + $Dest + $Url
function UploadToContacts {
# Ensure file's there and has content
if (!(Test-Path -Path $File)) {
echo $File+" not downloaded!"
exit 1
}
$lines = 0
Get-Content $File |%{ $lines++ }
echo "Lines of $File=$lines"
if($lines -le 2) {
echo "No Data to upload!"
exit 1
}
$auth = "${User}:${Pw}"
echo "POSTing towards $Uri"
.\bin\curl "--digest" -s -S --trace-time -u $auth -i -H "Content-Type:application/octet-stream" -X POST --data-binary "@${File}" "${Uri}"
echo "POSTed towards $Dest"
}
$timeStart = Get-Date
echo "===Begin: ${timeStart} ==="
UploadToContacts
$timeEnd = Get-Date
echo "===End: ${timeEnd} ==="
echo ""
App Services
- innovaphone-contacts
- The reqular app
- innovaphone-contacts-admin
- Features a menu (top-right) to manually upload a CSV file
- innovaphone-contacts-searchapi
- Provides a search API to other apps, e.g. for the Phone App
Troubleshooting
Related
Contacts on HomeScreen can't be open after modification on ContactsAPP
- ↑ For a windows distribution: e.g.: https://curl.haxx.se/download.html
- ↑ CURL is recommended(rather required), because it supports the simple POST mechanism with an initial tentative POST with the data length of 0, in order to get through the authentication phase