Protocols

Protocol is a set of rules that allows UAD, systems etc. to communicate using a set standard.

Supported protocols are:

SIP

SIP (Session Initiated Protocol, or Session Initiation Protocol), is a signaling protocol for Internet conferencing, telephony, presence, events notification and instant messaging. The protocol initiates call setup, routing, authentication and other feature messages to end points within an IP domain.

General

Table 16.21. General

Field Description Example Field Type
Port: SIP bind port 5060, (default) [0-9]
Bind Address: SIP bind IP address 0.0.0.0, (default) [0-9]
SRR lookup: Enable DNS SRV lookups on outbound calls Disabling this option will disable SIP calls based on domain names between SIP users on the Internet Option buttons
Qualify: Timing interval in milliseconds at which a 'ping' is sent to a host in order to find out its status Set this field to 2000 for example. If more time then provided here is needed to reach the host, host is considered offline [0-9]
Context: Default context for incoming calls For security reasons it is recommended to keep this field set at 'invalid-context' [a-z][0-9]
Language: Default language settings for all users/peers Set this option to 'en' (English) for example [a-z]
Music on Hold: Set the default MOH (Music on Hold) class for all SIP calls Set 'default' for example to play 'default' MOH class to all SIP calls when placed on hold for example Select box
T.38 Passthru Fax support: Enables T.38 fax passthrough on SIP to SIP calls, provided both parties have T38 support enabled. Yes, No, N/A Option buttons
Allow Overlap Dialling: Allow overlap dialling. Yes, No, N/A Option buttons
Allow Transfer: Disable all transfers (unless enabled in peers or users). Default is enabled. Yes, No, N/A Option buttons


NAT

Table 16.22. NAT

Field Description Example Field Type
External IP: External IP/Public/Internet address system uses If your system is behind NAT set this option to Public/Internet IP address system uses when registering with other proxies over Internet [0-9]
External Host (DynDNS): DynDNS address system uses If your system is behind NAT, along with the External IP address you may use the DynDNS service as well. Set this field to DynDNS host [0-9]
External Host Refresh: How often to refresh External DynDNS host (if used) Time in seconds (e.g. 10) [0-9]
Match External IP Locally: Only substitute the externip or externhost setting if it matches your localnet setting. Yes, No, N/A Option buttons
Local network: If system is used in local network, set the local network address here 192.168.0.0/255.255.0.0 [0-9]
NAT: Global SIP NAT setting which affects all users/peers Set this option to 'Yes' if system is behind NAT Option buttons


Security

Table 16.23. Security

Field Description Example Field Type
Always Reject with 401:     Option buttons
Allow guest:     Option buttons
Allow External INVITEs:     Option buttons
Trust Remote-Party-ID:     Option buttons
Allow REDIR:     Option buttons


RTP

Table 16.24. RTP

Field Description Example Field Type
RTP timeout: Max RTP timeout All calls (if not on hold) will be terminated if there is no RTP activity for number of seconds set here (60 for example) [0-9]
RTP hold timeout: Max RTP hold timeout. NOTE: This field must be higher number then set under 'RTP timeout' All calls on hold will be terminated if there is no RTP activity for number of seconds set here (300 for example) [0-9]
RTP keep-alive: Send keepalives in the RTP stream to keep NAT open (default is off - zero).   [0-9]


DTMF

Table 16.25. DTMF

Field Description Example Field Type
DTMF Mode: Set the default DTMF mode rfc2833 Select box
Relax DTMF: Relax DTMF handling Set this field to 'Yes' if having problems with DTMF modes Option buttons


Misc

Table 16.26. Misc

Field Description Example Field Type
Pedantic checking: Enable slow, pedantic checking for Pingtel and multi-line formatted headers for strict SIP compatibility It is recommended to set this field to 'No' Option buttons
Generate inband ringing: Set whether the system generates in-bank ringing You're recommended to set this option to 'Never' Select box
Video support: Set whether the system generates in-bank ringing You're recommended to set this option to 'No' Option buttons
Max Call Bitrate: Maximum bitrate for video calls (default 384 kb/s). 512 [0-9]
Send Remote-Party-ID: Should 'Remote-Party-ID' be added to uri You're recommended to set this option to 'No' unless required otherwise Option buttons
Add ;user=phone: Should ';user=phone' be added ot uri You're recommended to set this option to 'No' unless required otherwise Option buttons
Compact Headers: Should compact SIP headers be sent You're recommended to set this option to 'No' unless required otherwise Option buttons
Manager events on SIP events: Should manager events be generated if SIP UAD/Phone performs some event (Hold for example) You're recommended to set this option to 'No' unless required otherwise Option buttons


Authentication

Table 16.27. Authentication

Field Description Example Field Type
User Agent: Set the 'User Agent' string 'Custom string' for example [a-z][0-9]
Realm: Realm for digest authentication 'Custom string' for example [a-z][0-9]
Auth debugging: Should authentication be debugged Setting this option to 'Yes' will increase the amount of debugging traffic Option buttons


Registration

Table 16.28. Registration

Field Description Example Field Type
Length of i/o reg:     [0-9]
Def. Length of i/o reg:     [0-9]
Registration context: Should system dynamically create and destroy noop priority 1 extension for peer who (un)registers with us sipregistrations [a-z][0-9]
Registration timeout: Number of seconds after which registration times out Default value 20 [0-9]
Register attempts: Number of registration attemps One 'Register timeout' equals one 'Registration attempts'. Default value 10 [0-9]
Minimum roundtrip time for monitored hosts: Minimum roundtrip time for messages to monitored hosts. Defaults to 100 ms. 300 [0-9]


MWI

Table 16.29. MWI

Field Description Example Field Type
MWI Mime-type: Allow overriding of mime type Default value 'text/plain' [a-z]
Check MWI time: Default time between mailbox checks for peers Default value 10 [0-9]
Voicemail extension: Dialplan extension to reach mailbox. This option sets the 'Message-Account' in the MWI notify message Default value 'asterisk' [a-z][0-9]


Subscriptions

Table 16.30. Subscriptions

Field Description Example Field Type
Allow Subscriptions: Disable support for subscriptions. Default is Yes. Yes, No, N/A Option buttons
Subscribe Context: Set a specific context for SUBSCRIBE requests (Useful to limit subscriptions to local extensions)   [a-z][0-9]
Notify on RINGING: Notify subscriptions on RINGING state Yes, No, N/A Option buttons
Notify on HOLD: Disable support for subscriptions. Default is No. Yes, No, N/A Option buttons


Domains

Table 16.31. Domains

Field Description Example Field Type
Domain: Set default domain for this host If configured, Asterisk will only allow INVITE and REFER to non-local domains. Use 'sip show domains' to list local domains [a-z][0-9]
Auto Domain: Turn this on to have Asterisk add local host name and local IP to domain list. If system host name is set to 'my_system', with this feature set to 'On', 'my_system' will be automatically added to domain list Option buttons
From Domain: Change the 'From: ' headers Keep this field empty unless requested otherwise [a-z][0-9]
Allow External Domains: Should domains not serviced by this server be (dis)allowed   Option buttons


Codecs

Table 16.32. Codecs

Field Description Example Field Type
Disallow: Set the codecs extension is now allowed to use This field is very unique. In order to work properly, this setting is automatically set to 'Disallow All' and it cannot be modified Read only
Allow: Set the codecs extension is allowed to use Only the codecs set under 'Settings: Server' will be available to choose from Check box
Auto-Framing (RTP Packetization): If autoframing is turned on, system will choose packetization level based on remote ends preferences. Yes Option buttons
Non-standard G726: If the peer negotiates G726-32 audio, use AAL2 packing order instead of RFC3551 packing order. Yes, No, N/A Option buttons


Available Codecs:

  • ITU G.711 ulaw - 64 Kbps, sample-based, used in US

  • ITU G.711 alaw - 64 Kbps, sample-based, used in Europe

  • ITU G.723.1 - 5.3/6.3 Kbps, 30ms frame size

  • ITU G.726 - 16/24/32/40 Kbps

  • ITU G.729 - 8 Kbps, 10ms frame size

  • GSM - 13 Kbps (full rate), 20ms frame size

  • iLBC - 15Kbps,20ms frame size: 13.3 Kbps, 30ms frame size

  • Speex - 2.15 to 44.2 Kbps

  • LPC10 - 2.5 Kbps

  • H.261 Video - Used over ISDN lines with resolution of 352x288

  • H.263 Video - Low-bit rate encoding solution for video conferencing

  • H.263+ Video - Extension of H.263 that provides additional features that improve compression over packet switched networks.

Jitter Buffer

Table 16.33. Jitter Buffer

Field Description Example Field Type
Enable Jitterbuffer: Enables the use of a jitterbuffer on the receiving side of a SIP channel. An enabled jitterbuffer will be used only if the sending side can create and the receiving side can not accept jitter. The SIP channel can accept jitter, thus a jitterbuffer on the receive SIP side will be used only if it is forced and enabled. Yes, No, N/A Option buttons
Force Jitter Buffer: Should we force jitter buffer (default value 10) Jitter buffer is usually handled by the UADs/Phones. But in case if these do this poorly jitter buffer can be enforced on PBXware side [0-9]
Max length (ms): Max length of the jitterbuffer in milliseconds. 300 [0-9]
Re-sync threshold: Resync the threshold for noticing a change in delay measured 1000 [0-9]
Implementation: Jitterbuffer implementation used on a receiving side of a SIP channel. Defaults to "fixed". adaptive Select box
Logging: Enables jitterbuffer frame logging. Defaults to "no". Yes, No, N/A Option buttons


SIP Debugging

Adjust options that affect SIP debugging on the system

Table 16.34. SIP Debugging

Field Description Example Field Type
SIP Debug: Should SIP Debug be turned on all the time You're recommended to set this option to 'No' unless required otherwise Option buttons
Record History: Should SIP history be recorded

Select 'Yes' to record SIP history. Example history information:

 * SIP Call
1. TxReqRel        INVITE / 102 INVITE
2. Rx              SIP/2.0 / 102 INVITE /100 Trying
3. CancelDestroy
4. Rx              SIP/2.0 / 102 INVITE /180 Ringing
5. CancelDestroy
6. Rx              SIP/2.0 / 102 INVITE /200 OK
7. CancelDestroy
8. Unhold          SIP/2.0
9. TxReq           ACK / 102 ACK
10. TxReqRel        INVITE / 103 INVITE
11. Rx              SIP/2.0 / 103 INVITE /200 OK
12. CancelDestroy
13. Unhold          SIP/2.0
14. TxReq           ACK / 103 ACK
Option buttons
Dump History: Dump SIP history at end of SIP dialogue. SIP history is output to the DEBUG logging channel. Yes, No, N/A Option buttons


Additional config

This option is used for providing additional config parameters for SIP configuration files. Values provided here will be written into these configuration files.

IAX

IAX (Inter asterisk exchange) is a simple, low overhead and low bandwidth VoIP protocol designed to allow multiple PBXwares to communicate with one another without the overhead of more complex protocols.

General

Table 16.35. General

Field Description Example Field Type
Port: IAX bind port 4569, (default) [0-9]
Bind Address: IAX bind IP address 0.0.0.0, (default) [0-9]
IAX compatible: Should layered switches or some other scenario be used Set to yes if you plan to use layered switches or some other scenario which may cause some delay when doing a lookup in the dialplan Select box
Language: Default language settings for all users/peers Set this option to 'en' (English) for example [a-z]
Bandwidth: Set the bandwidth to control which codecs are used in general Select between low, mid or high Select box
Maximum number of IAX helper threads: Establishes the number of extra dynamic threads that may be spawned to handle I/O. 150 [0-9]
Allow IAXy firmware download: Controls whether this host will serve out firmware to IAX clients which request it. Yes, No, N/A Option buttons


Jitterbuffer

Table 16.36. Jitterbuffer

Field Description Example Field Type
Jitter Buffer: Turn off jitter buffer for this peer Yes, No, N/A Option buttons
Force Jitter Buffer: Should we force jitter buffer (default value 10) Jitter buffer is usually handled by the UADs/Phones. But in case if these do this poorly jitter buffer can be enforced on PBXware side [0-9]
Max. jitterbuffer interpolations: The maximum number of interpolation frames the jitterbuffer should return in a row 1000 [0-9]
Max. Jitter buffer: A maximum size for the jitter buffer. Setting a reasonable maximum here will prevent the call delay from rising to silly values in extreme situations; you'll hear SOMETHING, even though it will be jittery. 1000 [0-9]
Resync Treshold: Resync the threshold for noticing a change in delay measured 1000 [0-9]


Billing

Table 16.37. Billing

Field Description Example Field Type
AMA Flags: These flags are used in the generation of call detail records (e.g 'default') Select between 'default', 'omit', 'billing' or 'documentation' Select box
Account code: Default account for CDRs (Call Detail Records) lars101 [a-z][0-9]


Authorization

Table 16.38. Authorization

Field Description Example Field Type
Auth debugging: Should authentication be debugged Setting this option to 'Yes' will increase the amount of debugging traffic Option buttons
Max Auth requests: Maximum number of outstanding authentication requests waiting for replies. Any further authentication attempts will be blocked 10 [0-9]
Delay Reject: Set this option to 'Yes' for increased security against brute force password attacks Yes [0-9]


Registration

Table 16.39. Registration

Field Description Example Field Type
Registration context: If specified PBXware will dynamically create and destroy a NoOp priority 1 extension for a given peer who registers or unregisters with us iaxregistration [a-z][0-9]
Min Registration Expire: Minimum amounts of time that IAX peers can request as a registration expiration interval (in seconds). 60 [0-9]
Max Registration Expire: Maximum amounts of time that IAX peers can request as a registration expiration interval (in seconds). 60 [0-9]


Trunk

Table 16.40. Trunk

Field Description Example Field Type
Trunk frequency: How frequently to send trunk msgs (in ms) 20 [0-9]
Trunk Timestamps: Should we send timestamps for the individual sub-frames within trunk frames Yes Option buttons


Misc

Table 16.41. Misc

Field Description Example Field Type
Disable UDP checksums: Should checkums will be calculated Yes Option buttons
Auto-kill: If no response is received within 2000ms, and this option set to yes, cancel the whole thing Yes Option buttons


Codecs

Table 16.42. Codecs

Field Description Example Field Type
Codec Priority: This option controls the codec negotiation of an inbound IAX calls.
  • caller - Consider the callers preferred order ahead of the host's.

  • host - Consider the host's preferred order ahead of the caller's.

  • disabled - Disable the consideration of codec preference altogether (this is the original behaviour before preferences were added)

  • reqonly - Same as disabled, only do not consider capabilities if the requested format is not available the call will only be accepted if the requested form

Read only
Disallow: Set the codecs extension is now allowed to use This field is very unique. In order to work properly, this setting is automatically set to 'Disallow All' and it cannot be modified Read only
Allow: Set the codecs extension is allowed to use Only the codecs set under 'Settings: Server' will be available to choose from Check box


Available Codecs:

  • ITU G.711 ulaw - 64 Kbps, sample-based, used in US

  • ITU G.711 alaw - 64 Kbps, sample-based, used in Europe

  • ITU G.723.1 - 5.3/6.3 Kbps, 30ms frame size

  • ITU G.726 - 16/24/32/40 Kbps

  • ITU G.729 - 8 Kbps, 10ms frame size

  • GSM - 13 Kbps (full rate), 20ms frame size

  • iLBC - 15Kbps,20ms frame size: 13.3 Kbps, 30ms frame size

  • Speex - 2.15 to 44.2 Kbps

  • LPC10 - 2.5 Kbps

  • H.261 Video - Used over ISDN lines with resolution of 352x288

  • H.263 Video - Low-bit rate encoding solution for video conferencing

  • H.263+ Video - Extension of H.263 that provides additional features that improve compression over packet switched networks.

Additional config

This option is used for providing additional config parameters for IAX configuration files.

Values provided here will be written into these configuration files.

WOOMERA

WOOMERA is the protocol which is used ba Sangoma cards.

Table 16.43. WOOMERA

Field Description Example Field Type
WOOMERA Server: This is the remote IP address of the Woomera Server 192.168.0.13 [0-9]
WOOMERA Server Port: This is the remote port number of the Woomera Server 42420 [0-9]
WOOMERA Audio Server: IP address of remote SMG Audio Server 192.168.0.13 [0-9]
Default Context:

Incoming Context for Woomera Channels. All incoming calls will be forwared to defined context in extensions.conf

dids

[a-z][0-9]
Debug: Debug flag is used to enable/disable woomera channel debugging level. 2 [0-9]
Enable Incoming DTMF:

This option will enable Rx DTMF detection on each channel. The Tx DTMF is automatically enabled on SMG

Yes, No, N/A

Option buttons
Enable JitterBuffer:

Enable Jitterbuffer for this profile

Yes, No, N/A Option buttons
Enable Progress Messaging:

Enable Asterisk Progress Messaging used for Asterisk Early Audio with ZAP and SIP

Yes, No, N/A Option buttons
Coding:

Coding is necessary to identify ulaw/alaw

ulaw Select box
RX Gain:

Set RX gain

2 [0.0 - x.0]
TX Gain:

Set TX gain

2 [0.0 - x.0]
Language:

Set preffered language

en [a-z]