Annex
May 2025
Keyboard shortcuts on the phone
The following key combinations can be used on telephones that have been auto-provisioned via STARFACE to control various features and functions.
Keyboard shortcuts for general control
Key(s) | Additional input | Description of the |
---|---|---|
| Target number | Marks the call as private in the connection data analyses. |
| Group ID | Logging the user on to the group |
| Gruppen-ID | Logging the user off from the group |
| Speed dialling | Speed dialling from the address book is called |
| Login-ID | Logging the user on to the phone |
| Login-ID | Logging the user off from the phone |
| Logging all users off from the phone | |
| Internal phone number | Taking over the call for the user/group (call grabbing) |
| Random call pick-up (call grabbing) | |
| ID of the voicemail box | Querying and configuring a voicemail box |
| Digit | Call setup via the line with the line prefix digit |
e.g. ##2 | Entries after the first # are signalled to the provider unfiltered (requires the "Provider-side service features" right). It is recommended to use this key combination only in combination with a line prefix. |
Keyboard shortcuts during an active call
Key(s) | Additional input | Description |
---|---|---|
| Transfers the call to all of the user's phones (Call2Go) | |
| Start or stop the recording. Once the call has ended, the recording is sent as an e-mail attachment. | |
| Calling up the voice menu for a transfer with enquiry. The current call is put on hold. After consultation with the transfer target, the call partner on hold is transferred by hanging up. | |
| Starting a spontaneous conference call with the current call and all calls placed on hold | |
| Any DTMF tones can be transmitted for the next 10 seconds |
Keyboard shortcuts for additional service features
Key(s) | Additional input | Description |
---|---|---|
| Destination number | Always switch on forwarding to destination number (without group numbers) |
| Activates all already configured always redirects (without group numbers) | |
| Destination number | Switch off all always redirects (without group numbers) |
| Destination number | Switch on busy redirects to destination number |
| Activates all already configured busy redirects (without group numbers) | |
| Switch off all busy diversions | |
| Destination number | Switch on timeout forwarding to destination number |
| Activates all already configured timeout redirects (without group numbers) | |
| Switch off all timeout redirects | |
| Destination number | Switch on forwarding to destination number (without group numbers) |
| Deactivate all always redirects (without group numbers) | |
| Switch on callback on busy | |
| Switch off callback on busy | |
| + 00 to 99 (waiting place ID) | Park a held caller in a waiting area or retrieve them from the waiting area (Park and Orbit) |
| DND for the logged-in user | |
| Deactivate DND for the logged-in user |
Keyboard shortcuts for controlling conferences
Key(s) | Additional input | Description |
---|---|---|
Call up the language menu of the control options | ||
| Switching the mute function (microphone) on and off | |
| Speaking up when muted by the moderator | |
| Reduce the conference volume | |
| Resets the handset volume to the default value | |
| Increase conference volume | |
| Reduce microphone volume | |
| Reset the microphone volume to default value | |
| Increase microphone volume |
Overview of country-specific emergency numbers and special numbers
Certain internal phone numbers cannot be assigned to users, groups, etc. Which internal numbers cannot be assigned depends on the configured country setting on the SIP trunk.
The wildcard * stands for none or several arbitrary digits. The information in square brackets indicates a number range.
Land | Number | Emergency call | Special phone number | Description |
---|---|---|---|---|
Afghanistan | 112 | yes | Fire | |
Afghanistan | 119 | yes | Police/Ambulance | |
Andorra | [0-9]* | yes | Deactivation of number normalization | |
Australia | 106 | yes | Emergency Call | |
Australia | 1100 | yes | Community Service | |
Australia | 112 | yes | Emergency Call | |
Australia | 119[0-9] | yes | Community Service | |
Australia | 12[0-9]{2}[0-9]* | yes | Several Network Services | |
Australia | 13[0-9]{2}[0-9]* | yes | Local Rate Services | |
Australia | 18[0-9]{2}[0-9]* | yes | Free Phone Services | |
Australia | 180[0-9]* | yes | Free phone services | |
Australia | 189[0-9]{2} | yes | Calling Card Services | |
Australia | 19[0-9]{2}[0-9]* | yes | Premium Rate Services | |
Austria | 10[0-9]* | yes | Betreiberauswahl-Praefix | |
Austria | 111[0-9]* | yes | Öffentliche Kurzrufnummern für Telefonstörungsannahmestellen | |
Austria | 112[0-9]* | yes | Einheitliche europäische Notrufnummer | |
Austria | 116[0-9]* | yes | Öffentliche Kurzrufnummern fuer harmonisierte Dienste von sozialem Wert | |
Austria | 118[0-9]* | yes | Öffentliche Kurzrufnummern fuer Telefonauskunftsdienste | |
Austria | 120[0-9]* | yes | Pannendienste | |
Austria | 122[0-9]* | yes | Feuerwehrzentralen | |
Austria | 123[0-9]* | yes | Pannendienste | |
Austria | 128[0-9]* | yes | Notrufnummer bei Gasgebrechen | |
Austria | 130[0-9]* | yes | Landeswarnzentralen | |
Austria | 133[0-9]* | yes | Polizei | |
Austria | 140[0-9]* | yes | Bergrettung | |
Austria | 141[0-9]* | yes | Aerztenotdienst | |
Austria | 142[0-9]* | yes | Telefonseelsorge | |
Austria | 144[0-9]* | yes | Rettungsdienst | |
Austria | 1455[0-9]* | yes | Apothekendienste | |
Austria | 147[0-9]* | yes | Notrufdienst fuer Kinder und Jugendliche | |
Austria | 1484[0-9]* | yes | Krankentransporte | |
Belgium | 100 | yes | Emergency 100 | |
Belgium | 101 | yes | Emergency 101 | |
Belgium | 106 | yes | Emergency 106 | |
Belgium | 110 | yes | Emergency 110 Missing Children | |
Belgium | 112 | yes | Emergency 112 | |
Belgium | 116116 | yes | Harmonised services 116116 | |
Brazil | [0-9]* | yes | Deactivation of number normalization | |
Brazil | 100 | yes | Human Rights Secretariat | |
Brazil | 128 | yes | Standard Emergency Number | |
Brazil | 190 | yes | Military Police | |
Brazil | 191 | yes | Federal Highway Patrol | |
Brazil | 192 | yes | Ambulance | |
Brazil | 193 | yes | Firefighters | |
Brazil | 194 | yes | Federal Police | |
Brazil | 197 | yes | Civil Police | |
Brazil | 198 | yes | State Highway Patrol | |
Brazil | 199 | yes | Civil Defense | |
Bulgaria | 116 | yes | Police | |
Bulgaria | 150 | yes | Ambulance | |
Bulgaria | 160 | yes | Fire | |
Chile | [0-9]* | yes | Deactivation of number normalization | |
Komoren | [0-9]* | yes | Deactivation of number normalization | |
Croatia | 1\d{2}\d* | yes | Emergency | |
Cyprus | 1[0,4,6,8]{1}[0-9]{2} | yes | Emergency service 4 digit | |
Cyprus | 1[1-3,5,9]{1}[0-9]{1} | yes | Emergency service 3 digit | |
Cyprus | 10[0-9]{2} | yes | Carrier (pre-)selection codes | |
Cyprus | 112 | yes | Emergency Call (Police, Ambulance, Fire service) | |
Cyprus | 116[0-9]{3} | yes | Harmonized services of social value | |
Cyprus | 118[0-9]{2} | yes | Directory enquiry services | |
Cyprus | 16[0-9]{4} | yes | Call routing prefixes | |
Cyprus | 17[0-9]{3} | yes | Emergency service 5 digit | |
Cyprus | 199 | yes | Emergency Call (Police, Ambulance, Fire service) | |
Czech Republic | 10[0-9]{2,3} | yes | Carrier network selection | |
Czech Republic | 112 | yes | Emergency 112 | |
Czech Republic | 112[0-9]* | yes | Emergency 112 | |
Czech Republic | 116[0-9]{3} | yes | European harmonised numbers | |
Czech Republic | 118[0-9]{1} | yes | Directory enquiry services | |
Czech Republic | 12[0-9]{2,3} | yes | Social, health and assistance services | |
Czech Republic | 13[0-9]{3,4} | yes | Public service numbers of network providers | |
Czech Republic | 14[0-9]{3} | Ja | Social, healt, assistance and security services | |
Czech Republic | 15[0-9]{1} | Ja | National emergency call numbers 150 to 159 | |
Czech Republic | 150[0-9]* | Ja | Emergency 150 Fire | |
Czech Republic | 55[0-9]* | Ja | Emergency 155 Ambulance | |
Czech Republic | 158[0-9]* | Ja | Emergency 158 Police | |
Czech Republic | 16[0-9]{2} | yes | Global service routing | |
Czech Republic | 199 | yes | Special number for public service | |
Denmark | 10[0-9]{2} | yes | Carrier network selection | |
Denmark | 112[0-9]* | yes | Emergency 112 | |
Denmark | 114[0-9]* | yes | Emergency 114 (Police) | |
Denmark | 116[0-9]{3} | yes | Social services | |
Denmark | 16[0-9]{3} | yes | Carrier select code for data | |
Denmark | 18[0-9]{2} | yes | Service number such as directory enquiry | |
East Timur | [0-9]* | yes | Deactivation of number normalization | |
Finnland | 10[0-9][0-9]* | yes | Long distance operator prefixes | |
Finnland | 112[0-9]* | yes | Emergency 112 | |
Finnland | 116000 | yes | Hotline for missing children | |
Finnland | 116006 | yes | Helpline for victims of crime | |
Finnland | 116111 | yes | Child helplines | |
Finnland | 116111 | yes | Mannerheim League for Child Welfare | |
Finnland | 116117 | yes | Non-emergency medical on-call service | |
Finnland | 118 | yes | Service number of line providing telco | |
Finnland | 99[0-9][0-9]* | yes | International call-by-call operator prefixes | |
France | 10[0-9]* | yes | Services des operateurs de reseau (numeros a 4 chiffres) | |
France | 112[0-9]* | yes | Numero durgence europeen (permettant dacceder aux trois services ci-dessus) | |
France | 115[0-9]* | yes | Urgences sociales (ou SAMU social) | |
France | 116[0-9]* | yes | Services a valeur sociale harmonises | |
France | 118[0-9]* | yes | Services de renseignements telephoniques (numeros a 6 chiffres) | |
France | 119[0-9]* | yes | Enfance maltraitee | |
France | 15[0-9]* | yes | SAMU (Rettungsdienst) | |
France | 16[0-9]* | yes | Selection du transporteur (prefixes a 1 ou 4 chiffres) | |
France | 17[0-9]* | yes | Police ou Gendarmerie | |
France | 18[0-9]* | yes | Pompiers | |
France | 3[0-9][0-9][0-9][0-9]* | yes | ||
Georgia | 1\d{2}\d* | yes | Emergency | |
Germany | 11[0,2] | yes | 110, 112 Notruf | |
Germany | 115 | yes | 115 Einheitliche Behördenrufnummer | |
Germany | 116[0-9]* | yes | 116xyz EU-Rufnummern fuer Dienste von sozialem Wert | |
Germany | 118[0-9]* | yes | 118xy Rufnummern fuer Auskunfts- und Vermittlungsdienste | |
Greece | (00)?800[0-9]* | yes | Free phone services | |
Greece | 100[0-9]* | yes | Police | |
Greece | 108[0-9]* | yes | Coast Guard | |
Greece | 112[0-9]* | yes | Emergency | |
Greece | 116[0-9]* | yes | Social Numbers | |
Greece | 1591[0-9]* | yes | Forest Fire | |
Greece | 166[0-9]* | yes | Ambulance | |
Greece | 199[0-9]* | yes | Fire | |
Hongkong | [0-9]* | yes | Deactivation of number normalization | |
Italy | (00)?80[0,3][0-9]* | yes | Free phone services | |
Italy | 112[0-9]* | yes | Emergency | |
Italy | 113[0-9]* | yes | Carabinieri | |
Italy | 114[0-9]* | yes | Youth child helpline (treatment/abuse) | |
Italy | 115[0-9]* | yes | Fire Service (Vigili del Fuoco) | |
Italy | 116[0-9]* | yes | Harmonized numbers for hamonized services of social value | |
Italy | 117[0-9]* | yes | Guardia di Finanza | |
Italy | 118[0-9]* | yes | Ambulance | |
Italy | 15[0-9][0-9][0-9]* | yes | Other Emergency and Info Services | |
Italy | 19696[0-9]* | yes | Helpline for Children | |
Lettland | [0-9]* | yes | Deactivation of number normalization | |
Liechtenstein | 10[011020206699] | yes | Carrier Selection Code | |
Liechtenstein | 112 | yes | European Emergency Number | |
Liechtenstein | 1145 | yes | Blinds inquiry and exchange | |
Liechtenstein | 117 | yes | Police | |
Liechtenstein | 118 | yes | Fire department | |
Liechtenstein | 143 | yes | Die Dargebotene Hand charity | |
Liechtenstein | 144 | yes | Ambulance | |
Liechtenstein | 145 | yes | TOX-Center (Zurich) | |
Liechtenstein | 147 | yes | Helpline for children and juvenile in Liechtenstein | |
Liechtenstein | 150 | yes | Automatic alarm service | |
Liechtenstein | 181[18] | yes | Telephone directory service | |
Litauen | [0-9]* | yes | Deactivation of number normalization | |
Malta | 1\d\d\d* | yes | Others | |
Malta | 112 | yes | Emergency | |
Malta | 119 | yes | Criminal activity | |
Netherlands | 10[0-9][0-9][0-9][0-9][0-9]* | yes | Carrier Selection | |
Netherlands | Netherlands | yes | Standardized European Short Number Services | |
Netherlands | Netherlands | yes | Standardized European Short Number Services | |
Netherlands | 112[0-9]* | yes | Emergency | |
Netherlands | 113[0-9]* | yes | Standardized European Short Number Services | |
Netherlands | 114[0-9]* | yes | Standardized European Short Number Services | |
Netherlands | 115[0-9]* | yes | Standardized European Short Number Services | |
Netherlands | 116[0-9][0-9][0-9][0-9]* | yes | Harmonisierte Dienste von sozialem Wert | |
Netherlands | 12[0-9][0-9][0-9]* | yes | Standardized Carrier Service Codes | |
Netherlands | 14[0-9][0-9][0-9][0-9]* | yes | public authorities | |
Netherlands | 144[0-9]* | yes | Animal Rescue Service | |
Netherlands | 16[0-9][0-9][0-9]* | yes | Carrier Select Prefixes | |
Netherlands | 18[0-9][0-9][0-9]* | yes | Number Information | |
New Zealand | 1\d{2}\d* | yes | Emergency | |
Norway | 110 | yes | Emergency 110 | |
Norway | 112 | yes | Emergency 112 | |
Norway | 113 | yes | Emergency 113 | |
Norway | 116111 | yes | Harmonisierte Dienste 116111 | |
Norway | 116116 | yes | Harmonisierte Dienste 116116 | |
Polen | 112[0-9]* | yes | Emergency | |
Polen | 116[0-9][0-9][0-9][0-9]* | yes | Harmonisierte Dienste von Sozialem Wert | |
Polen | 118[0-9][0-9][0-9][0-9]* | yes | Auskunftsdienste | |
Polen | 984[0-9]* | yes | River rescue service | |
Polen | 985[0-9]* | yes | Mountain sea rescue service | |
Polen | 986[0-9]* | yes | Municipal police | |
Polen | 987[0-9]* | yes | Crisis management centers | |
Polen | 991[0-9]* | yes | Power stations brigade | |
Polen | 992[0-9]* | yes | Gas brigade | |
Polen | 993[0-9]* | yes | Heating brigade | |
Polen | 994[0-9]* | yes | Waterworks brigade | |
Polen | 995[0-9]* | yes | Child alert | |
Polen | 996[0-9]* | yes | Anti terrorist emergency number | |
Polen | 997[0-9]* | yes | Police | |
Polen | 998[0-9]* | Ja | Fire brigade | |
Polen | 999[0-9]* | yes | Ambulance | |
Portugal | (00)?800[0-9]* | yes | Free phone services | |
Portugal | [0-9]* | yes | yes | Deactivation of number normalization |
Portugal | 112[0-9]* | yes | Emergency 112 | |
Portugal | 117[0-9]* | yes | Emergency 117 | |
Singapur | [0-9]* | yes | Deactivation of number normalization | |
Slowenia | 1\d{2}\d* | yes | Emergency | |
South Africa | 101\d{2}\d* | yes | Emergency | |
Spain | (00)?800[0-9]* | yes | Free phone services | |
Spain | 1[0-9][0-9][0-9] | yes | Short Numbers | |
Spain | 10[3456][0-9]* | yes | Carrier Selection | |
Spain | 112[0-9]* | yes | Emergency Calling | |
Spain | 116[0-9]* | yes | Harmonised services of social value | |
Spain | 118[0-9]* | yes | Auskunftsdienste | |
Swasiland | [0-9]* | yes | Deactivation of number normalization | |
Sweden | 112[0-9]* | yes | Emergency 112 | |
Sweden | 11414[0-9]* | yes | Police - non emergency | |
Sweden | 116[0-9][0-9][0-9][0-9]* | yes | Harmonised services of social value | |
Schweden | 1177 | yes | Health care advice | |
Sweden | 118[0-9][0-9]* | yes | Number enquiries | |
Schweiz | 11[0,2][0-9]* | yes | Emergency | |
Schweiz | 115 | yes | Civil services | |
Schweiz | 116[0-9]* | yes | Social services | |
Schweiz | 118[0-9]* | yes | Directory service | |
TBR21 | 101 | yes | Emergency Fire | |
TBR21 | 102 | yes | Emergency Police | |
TBR21 | 103 | yes | Emergency Ambulance | |
TBR21 | 104 | yes | Emergency Ambulance | |
TBR21 | 104 | yes | Emergency Gas Leaks | |
TBR21 | 105 | yes | Emergency Fire | |
TBR21 | 107 | yes | Emergency Police | |
TBR21 | 112 | yes | Emergency | |
TBR21 | 112 | yes | Emergency Medical Help/Ambulance/Fire/Vet/Doctors | |
TBR21 | 112 | yes | Emergency Fire | |
TBR21 | 113 | yes | Emergency Police | |
Tunisia | [0-9]* | yes | Deactivation of number normalization | |
Türkiye | 110 | yes | Emergency 110 Police | |
Türkiye | 112 | yes | Emergency 112 Fire | |
Türkiye | 155 | yes | Emergency | |
Türkiye | 156 | yes | Emergency Gendarmerie | |
Türkiye | 158 | yes | Emergency Coast Guard | |
Türkiye | 177 | yes | Emergency Forest Fire | |
United Kingdom | 1[0-9][0-9][0-9]* | yes | Misc. Access Codes | |
United Kingdom | 100[0-9]* | yes | Operator Service | |
United Kingdom | 101[0-9]* | yes | Emergency | |
United Kingdom | 111[0-9]* | yes | Emergency | |
United Kingdom | 112[0-9]* | yes | Emergency | |
United Kingdom | 116[0-9][0-9][0-9][0-9]* | yes | Harmonised services of social value | |
United Kingdom | 118[0-9][0-9][0-9][0-9]* | yes | Enquiry services | |
United Kingdom | 123[0-9]* | yes | Speaking Clock | |
United Kingdom | 155[0-9]* | yes | Aufkunftsdienst | |
United Kingdom | 1800[0-9][0-9]* | yes | Access to Voice Text Services for the Deaf | |
United Kingdom | 195[0-9]* | yes | Access to Blind & Disabled Directory Enquiry Facilities | |
United Kingdom | 999[0-9]* | yes | Emergency | |
USA | (011)?1?8[00,55,66,77,88][0-9]* | yes | Free phone services | |
USA | 101\d\d\d\d\d* | yes | Used to select use of an alternative long-distance carrier | |
USA | 211 | yes | Local community information or social services (in some cities) | |
USA | 311 | yes | City government or non-emergency police matters | |
USA | 411 | yes | Local telephone directory service (Some telephone companies provide national directory assistance) | |
USA | 511 | yes | Traffic, road, and tourist information | |
USA | 611 | yes | Telephone line repair service (formerly 4104), mobile telephone company customer service (formerly 811) | |
USA | 711 | yes | Relay service for customers with hearing or speech disabilities | |
USA | 811 | yes | Dig safe pipe/cable location in the United States, non-urgent telehealth/teletriage services in Canada (formerly telephone company business office) | |
USA | 911 | yes | Emergency telephone number (fire department, ambulance, police) |
Configure new SIP provider profile
This documentation describes which configuration options are available when creating a new SIP provider.
- Kopfleiste
- SIP-Konfiguration
- Kopfzeilen für SIP REGISTER
- Einstellungen für Wählformat und Rufnummernanzeige
- Erweiterte Einstellungen
Es wird empfohlen nur verifizierte Providerprofile zu nutzen, da diese automatische gegen verschiedene Versionen der STARFACE getestet werden. Nur die mit „Profil bereitgestellt von STARFACE GmbH“ gekennzeichneten Profile werden durch den Support der Firma Starface abgedeckt.
Header bar
Various functions can be selected directly using the buttons of the same name:
- Copy profile
- Show previous version
- Import TLS certificate
SIP configuration
Example screenshot of SIP configuration
The following configuration fields are available:
type
type | |
---|---|
Description | Permitted connection types |
Syntax | Drop-down menu |
Remark | |
Options | |
friend | Incoming and outgoing calls can be set up. |
peer | Only outgoing calls can be set up. |
user | Only incoming calls can be received. |
dtmfmode
dtmfmode | |
---|---|
Description | Standard of the tone dialling procedure |
Syntax | Drop-down menu |
Remark | |
Options | |
auto | It is automatically determined whether "rfc2833" or "inband" is used. |
rfc2833 | Send DTMF tones according to RFC 2833 (RTP packets) |
inband | Send DTMF tones "inband" as audio |
info | Send DTMF tones as SIP INFO messages |
auth mode
auth mode | |
---|---|
Description | Authentication mode with the provider |
Syntax | Drop-down menu |
Remark | |
Options | |
Username/password | Authentication via user name and password |
IP address | Authentication via IP address |
auth user
auth user | |
---|---|
Description | Type of authentication user at the provider |
Syntax | Drop-down menu |
Remark | The "Authuser" field in the line configuration is only displayed after saving. |
Options | |
ohne | No authentication user is transferred. |
SIP-Benutzername | The entry in the "User name" field of the line configuration is transferred. |
Authuser | The entry in the "Authuser" field of the line configuration is transferred |
nat
nat | |
---|---|
Description | Specification of the NAT used |
Syntax | Drop-down menu |
Remark | It is recommended not to configure this field and to use the STARFACE network settings. |
Options | |
Default | |
yes | |
no | NAT is handled according to RFC3581. |
allow
allow | |
---|---|
Description | Specification of the permitted codec |
Syntax | Free text field / All information in lower case and comma separated |
Remark | The order of the entries determines the desired priority. |
Examples | |
<empty> | Allows the following 3 codecs "alaw", "ulaw" and "gsm" |
all | Allows all codecs |
alaw,ulaw | Allows the codec "alaw" and "ulaw" in this order |
insecure
insecure | |
---|---|
Description | Security settings for incoming and outgoing calls |
Syntax | Free text field / All information in lower case and comma separated |
Remark | Currently only the option "port,invite" is supported and must be entered! |
Options | |
port | Ignores the port from which the request comes |
invite | No authentication for incoming invites |
port,invite | Combination of the two options above |
port
port | |
---|---|
Description | An alternative SIP port can be configured here |
Syntax | Free text field |
Remark | The standard STARFACE SIP port is 5060 |
Examples | |
<empty> | Port 5060 if "transport" is "udp" / Port 5061 if "transport" is "tls" |
5080 | Example of a different port specification |
transport
transport | |
---|---|
Description | Selecting the network protocol |
Syntax | Drop-down menu |
Remark | |
Options | |
udp | Unencrypted transmission via UDP |
tcp | Unencrypted transmission via TCP |
tls | Encrypted transmission via TLS |
defaultip
defaultip | |
---|---|
Description | Default IP address when using a dynamic host |
Syntax | free field |
Remark | This field is currently ignored! |
Examples | |
rtpholdtimeout
rtpholdtimeout | |
---|---|
Description | Specification of the time until a held connection without RTP and RTPC data traffic is automatically closed |
Syntax | Free field / in seconds |
Remark | This entry must be greater than the entry for "rtptimeout" |
Examples | |
<empty> | The default value is 300 seconds |
fromdomain
fromdomain | |
---|---|
Description | Sets a domain that is signalled from the STARFACE |
Syntax | Free text field |
Remark | |
Examples | |
<empty> | Es wird "starface.de" (ohne Anführungszeichen) als Domain bei ausgehenden Rufen gesetzt. |
host
host | |
---|---|
Description | The IP address or DNS name of the provider server |
Syntax | Free text field |
Remark | Multiple entries are not possible! |
Examples | |
sip123.provider.com | Example of a DNS entry |
60.70.80.90 | Example for the entry of an IP address |
permit
permit | |
---|---|
Description | Specification of the IP address(es) with which the provider is authorised to report to STARFACE |
Syntax | Free field / Multiple entries comma separated without spaces |
Remark | |
Examples | |
Specification as IP address | 192.168.0.60 |
Specification as address space | 192.168.0.60/255.255.255.0 |
Address space in CIDR notation | 192.168.0.60/24 |
deny
deny | |
---|---|
Description | Specification of IP addresses with which the provider may not report to STARFACE |
Syntax | Free text field / Multiple entries comma-separated without spaces |
Remark | |
Examples | |
Entry as IP address | 192.168.0.60 |
Entry as address space | 192.168.0.60/255.255.255.0 |
Address space in CIDR notation | 192.168.0.60/24 |
canreinvite
canreinvite | |
---|---|
Description | This field is ignored in the current configuration. |
Syntax | Drop-down menu |
Remark | This field is ignored in the current configuration. |
Options | |
disallow
disallow | |
---|---|
Description | Specification of the unauthorised codec |
Syntax | Free field / All information in lower case and comma separated |
Remark | It is recommended to block all codecs and to enter the desired codec in the "allow" field. |
Examples | |
<empty> | Allow all codecs |
all | Blocks all codecs |
g722,g729 | Blocks the codec "g722" and "g729" |
outboundproxy
outboundproxy | |
---|---|
Description | Specification of the outbound proxy used |
Syntax | Free field / specification of IP address or DNS |
Remark | Multiple entries are not allowed! |
Beispiele | |
<empty> | No outbound proxy is used |
60.70.80.90 | Specification of an IP address |
test.starface.de | Example of a DNS record |
progressinband
progressinband | |
---|---|
Description | Configuration of the doorbell signalling |
Syntax | Free field |
Remark | |
Options | |
never | If the provider does not signal the ringing, this is done by the STARFACE |
no | The provider must generate the ringing |
yes | The telephone system always signals the ringing |
standard | Der Provider muss das Klingeln erzeugen |
qualify
qualify | |
---|---|
Description | Time specification of how long a response is waited for when SIP Options packets are sent to the provider |
Syntax | Drop-down menu |
Remark | A Qualify packet is sent from the telephone system every 60 seconds and this time cannot be changed. |
Options | |
yes | The system waits 2000ms for a response to the qualify requests to the provider. |
no | No qualify requests are sent to the provider. |
Standard | No qualify requests are sent to the próvider. |
Numerical value XXX | XXX is waiting for a response to the qualify enquiry about the provider. |
encryption
encryption | |
---|---|
Description | Configuration whether SRTP is used or not |
Syntax | Drop-down menu |
Remark | |
Options | |
yes | SRTP |
no | no SRTP |
rtptimeout
rtptimeout | |
---|---|
Description | Specification of the time until an active connection without RTP and RTPC data traffic is automatically closed |
Syntax | Free field / specification in seconds |
Remark | This entry must be lower than the entry for "rtpholdtimeout" |
Examples | |
<empty> | The default value is 60 seconds |
mask
mask | |
---|---|
Description | Specification of a network mask for the "deny" and "permit" fields |
Syntax | free field |
Remark | This field is currently ignored in the configuration! |
fromuser
fromuser | |
---|---|
Description | Sets a user who is signalled from the telephone system in the invite |
Syntax | free field |
Remark | |
Options | |
<empty> | The call number is signalled as the user |
??????? | The user name from the line settings is signalled |
MaxMustermann | MaxMustermann" (without inverted commas) is signalled as the user |
resolve host
resolve host | |
---|---|
Description | Specifies whether the entry from the "host" field is written to the configuration as an IP address or host name |
Syntax | Checkbox |
Remark | If the line is not or no longer registered, an attempt is made once a minute to re-resolve the host. |
Options | |
With hook | The host name is resolved to the IP address and the IP address is written to the configuration |
Without hook | The host name is not resolved and is written directly to the configuration |
Headers for SIP REGISTER
In the "Contact" drop-down menu, you must select which information is to be transferred to the provider in the SIP registration package. In the adjacent "Number format" drop-down menu, you can select the format in which the respective number is entered in the SIP registration package.
First number | The first number of the call number block is entered. | All |
Stammnummer | Only the master number is entered without the call number block. | All |
Benutzername | The configured user name of the line is entered. | No selection option |
Freitext | Any free text can be entered. | Free text field |
The number formats are structured as follows:
+11 (222) XXX | +49 721 15104 123 |
11 (222) XXX | 49 721 15104 123 |
0011 (222) XXX | 0049 721 15104 123 |
0 222 XXX | 0 721 15104 123 |
222 XXX | 721 15104 123 |
Without dialling code | 15104 123 |
No Screening | This value should not be used. |
Settings for dialling format and call number display
In this area, the dialling format and the display of incoming and outgoing numbers can be configured via the respective drop-down menus. The necessary settings must match the format expected by the provider and must also be specified by the provider.
The display of the phone number is dealt with in various RFCs for the SIP protocol. In addition to these RFCs, there are other setting options in the STARFACE, some of which have been added specifically for providers who do not operate within these standards.
custom | From: Name <Nummer> | From: ANONYMOUS <username> | |
dusnet | From: Name <Nummer> | From: ANONYMOUS <0> | |
hfotelecom | P-Preferred-Identity: Name <sip:Nummer@starface.de> | From: Name <Nummer> P-Preferred-Identity: anonymous <sip:PAINummer@starface.de> | |
isdn | From: Number | From: anonymous <0> | |
m-net | From: Numbmer <Number> | From: anonymous <Nummer> Privacy: id | Number is in e.164 format |
qscconnect | Same as sipconnect, only for call forwarding: | Number is in e.164 format | |
remoteparty | Remote-Party-ID: Name <sip:Nummer@starface.de> | ||
rfc3261 | From: Name <Nummer> | From: ANONYMOUS <0> | |
rfc3323 | XXX | XXX | This phone number display has some bugs in version 6.2 and should not be used. |
rfc3325 | From: Name <Nummer> | From: ANONYMOUS <0> | |
sipconnect | From: Nummer <Nummer> | From: <sip:anonymous@anonymous.invalid> | Number is in e.164format |
sipgate | From: Nummer <Username> | From: ANONYMOUS <0> | The call number is standardised and a leading "+" is removed. |
tcom | From: Nummer <Nummer> P-Asserted-Identity: <sip:nummer@domain> | From: Nummer | Number is in e.164 format |
tonline | From: Nummer <Nummer> | From: anonymous <0> | |
toplinkresale | P-Preferred-Identity: Name <sip:Nummer@starface.de> | Privacy: Id P-Asserted-Identity: <sip:Networknumber@starface.de> |
Advanced settings
In this area, the "Cross-line number recognition" checkbox can be used to configure that the STARFACE checks whether an incoming call also fits into the line context of another line configuration.
Description of the XML-RPC interface of the queue
The "queue" ringing strategy (see also"Configuring the queue" and"Configuring the evaluation for the queue") provides external applications with access to live data and history data. XML-RPC technology is used for both interfaces. The live data of an waiting loop is called up via the XML-RPC function "Queue.getLiveData", which expects an input parameter:
<name>queueName</name> <string>…</string>
This function returns the following values:
callersLiveData (LIST) - This return value is a list, which in turn contains maps as elements. Each map contains information (key -> value) about exactly one caller who is in the queue at that time. The list is sorted according to the position of the caller in the queue. Each map contains the following keys:
Callerid | String | The unique ID of the call (e.g.: 995624b0-7385-404d-a658-dc942a1cbfe9) |
CallerNumber | String | The telephone number of the caller |
CallerName | String | Name of the caller in the form "Dialled number: CallerName CallerNumber" (e.g.: 154813: Hans Mustermann 01238756) |
CallerChannel | String | The unique ID of the caller channel (this is not a call channel in the physical sense!) |
CallerPriority | Int | Priority of the call |
CallerTime | String | The Unix timestamp of the entry into the queue (e.g.: 1304682789341) |
CallerPosition | Int | Shows the current position of the caller in the queue. The position may deviate briefly from the actual position in the queue. If the call has already been put through, the value of the key is -1. |
CallerState | String | Ein Anruf kann einen von vier Zuständen haben:
|
AgentId | String | The login ID of the agent to whom the caller is connected (e.g.: 0013). This value is empty for caller status "CALLING" and "WAITING" |
AgentName | String | Name of the agent to whom the caller is connected. This value is empty for caller status "CALLING" and "WAITING". |
agentsLiveData (MAP) - This return parameter is a map, which in turn contains maps as elements. The key of the map is the login ID of the agent. Each element map contains information (key -> value) about an agent:
AgentId | String | Login ID of the agent |
AgentName | String | Name of the agent |
AgentGroupState | String | Indicates whether the agent is currently logged into the group or not. Possible values are
|
AgentUserState | String | Displays the user status of an agent. Possible values are:
|
AgentPhoneState | String | Shows the telephone availability (status) of an agent:
|
History interface
The historical data of a queue is called up via the XML-RPC function "Queue.getHistoryData". The input parameter for this is a "struct" with three values:
queueName | String | Name of the desired queue group |
from | dateTime.iso8601 | Start of the time period (must contain an XML-RPC-compliant time value) |
to | dateTime.iso8601 | End of time period (must contain an XML-RPC-compliant time value) |
This function has a return value:
queueHistoryData (LIST) - The elements of the list are maps and each map contains information about exactly one call. The list is sorted according to the timestamp of the calls. Each element in the list contains the following keys:
callId | String | ID of the call in the DB starting with 1. |
callStepId | Int | Merges several entries from different users if they belong to one call. |
callLegUUID | String | Unique ID of the CallLeg |
agentId | String | Login of the agent who has accepted the call / Empty field = call not accepted |
cdrAccountId | Int | Account ID of the user to whom the call list entry belongs. |
callerAccountId | Int | Account ID of the caller, if it was an internal user, otherwise empty. |
calledAccountId | Int | Account ID of the called party, if it was an internal user, otherwise empty. |
calledCallerId | String | Callerid as it is displayed on the phone. |
startTime | String | Start time of the call as Unix timestamp |
ringingtime | String | Start time of the ringing at the agent of the call as Unix timestamp |
linktime | String | Connected to the agent as a Unix timestamp |
callresulttime | String | The call was terminated as Unix Timestamp |
callresult | String | The result of the call section. |
callResultCauseBy | Int | Accountid of the user who triggered the result. |
lineid | Int | The line used |
lineName | String | Name of the line used |
callbacknumber | String | The callback number of the other party to whom the call list entry belongs |
answeredelswere | String | Only filled if the call was answered by someone else |
incoming | Boolean | True for an incoming call |
answered | Boolean | True for an answered call |
hasvoicemail | Boolean | True if a voicemail was recorded. |
hasmonitor | Boolean | True for a recording of the call |
callbacknumberextern | Boolean | True if the callback number is an external number |
Example
By post method:
http://IP-ADRESSE/xml-rpc?de.vertico.starface.auth=$LoginID:SHA512($LoginID*SHA512($Passwort))
The password is hashed with SHA512 in the first step. This hash is then hashed again with the LoginID as a prefix and the separator *. For a user with the following key data:
LoginID = 0001
Passwort = starface
IP-Adresse der STARFACE = 192.168.0.100
is the call URL for XML-RPC:
http://192.168.0.100/xml-rpc?de.vertico.starface.auth=0001:5273503e607e5b24eeb48a3f71c53eb50df6b6622839ecd7149e248893f627d05d8d4af88cf36b3d7d5cd5d1d559dfa1c10404067d8c0f37a138c6546dad7ef7
The body would then look like this, for example:
|
Description of the CSV file for "Export line utilisation data"
The evaluation data shows which lines were used within a call (e.g. which line was used for an outgoing call). The line data is output as a CSV file with the name "output.csv". The output file is structured as follows:
id | long | Consecutive list ID |
callid | long | ID of the call |
callleguuid | String (UUID) | ID of the call leg |
calleraccountid | int (id von Tabelle account, 0 für extern) | Internal user ID of the caller |
callerlogin | String | Login ID of the internal user (start) |
callernumber | String | Primary number of the calling user |
calledaccountid | int (id of Table account, 0 for external) | Internal user ID of the called party |
calledlogin | String | Login ID of the internal user (target) |
callednumber | String | Primary number of the called user |
starttime | String (format: dd.MM.yyyy HH:mm:ss) | Start time of the call |
ringingtime | String (format: dd.MM.yyyy HH:mm:ss) | Start time of ringing |
linktime | String (format: dd.MM.yyyy HH:mm:ss) | Acceptance time of the call |
hanguptime | String (format: dd.MM.yyyy HH:mm:ss) | End time |
callresult | String (CONNECTED or NOT_CONNECTED) | Status of the call |
lineid | int | ID of the provider line used |
linename | String | Name of the provider line used |
channelname | String | Asterisk Designation of the line |
incoming | Boolean | Incoming call via a line? (status field) |
answered | Boolean | Call accepted? (status field) |
duration | long | Duration of the call |