ZOIPER. Configuration File Documentation 2008

Transcription

1 ZOIPER Cnfiguratin File Dcumentatin 2008 Ziper.cm CONTENTS 1. Intrductin Structure Sectins general sip_ptins iax_ptins rtp_ptins stun_ptins audi prvisin diagnstics fax netwrk restrictins cdecs cdec accunt Example ZOIPER Cnfiguratin File Dcumentatin f 15

2 1. Intrductin Ziper hlds its cnfiguratin in an XML file with UTF-8 encding. The file is called 'ziper.cnf' and is lcated in the 'Installatin flder' with Ziper Free and in 'C:\Dcuments and Settings\Current Windws user\applicatin Data\ZiperBiz' with Ziper Biz. This dcument explains the structure and the tags used in the Ziper cnfiguratin file. 2. Structure The cnfiguratin is rganized in several sub ndes called 'sectins'. The indentatin f the sectins shws which sectin is cntained by a preceding sectin. <ptins> - the main cnfiguratin sectin (every XML file has a main tag like this). <general> - general ptins sectin. There shuld be nly ne sectin f that type. <sip_ptins> - SIP prtcl ptins sectin. There shuld be nly ne sectin f that type. <iax_ptins> - IAX prtcl ptins sectin. There shuld be nly ne sectin f that type. <rtp_ptins> - RTP prtcl ptins sectin. There shuld be nly ne sectin f that type. <stun_ptins> - default STUN server ptins sectin. There shuld be nly ne sectin f that type. <audi> - audi ptins sectin. There shuld be nly ne sectin f that type. <prvisin> - prvisin ptins sectin. There shuld be nly ne sectin f that type. <diagnstics> - diagnstics ptins sectin. There shuld be nly ne sectin f that type. <restrictins> - restrictins sectin. There shuld be nly ne sectin f that type. <cdecs> - sectin that cntains a set f cdec sectins. This sectin defines the default cdec sectins set that will be used with all the accunts unless a given accunt have it's wn cdec set. The ptins sectin shuld cntain nly ne sectin f that type. <cdec> - the sectin defining a cdec usage. <accunts> - a sectin with several sub-sectins defining the accunts used by Ziper. There shuld be nly ne sectin f that type. ZOIPER Cnfiguratin File Dcumentatin f 15

3 <accunt> - this sectin describes a single accunt and may cntain a sub-sectin defining a custm cdec set used by this accunt. <cdecs> - a sectin that cntains a set f cdec sectins. There shuld be nly ne sectin f that type. <cdec> - a sectin defining the usage and pririty f a particular cdec. 3. Sectins 3.1 general <recrd_calls> - this tag specifies if Ziper will be recrding calls. This tag is used in Ziper Biz nly. <recrd_path> - this tag defines the base recrd path used by Ziper t recrd calls. Subflders in this flder are created fr every single day and the filenames f recrdings include the time f recrding. It is used in Ziper Biz nly. <always_n_tp> - this tag specifies if Ziper will stay n tp f the ther applicatins. <autmatic_ppup_n_incming_call> - this tag specifies if Ziper will fcus itself n incming call. <ppup_menu_n_incming_call> - this tag specifies if Ziper will display the "Accept, Reject and Ignre" dialg bx n incming call. <user_data_visible> - nt used. <vlume_cntrls_visible> - nt used. <lg_visible> - nt used. <check_fr_updates> - this tag specifies if Ziper will check fr updates. <catch_prtcl_requests> - this tag specifies if Ziper will register fr "callt" and "ziper" brwser URL prtcl requests. It is used in Ziper Biz nly. <integrate_int_utlk> - this tag specifies if the phne will enable its Micrsft Outlk plugin. (An Outlk restart will be needed). This ptin des nt wrk if the "catch_prtcl_requests" ptin is nt enabled. It is used in Ziper Biz nly. ZOIPER Cnfiguratin File Dcumentatin f 15

4 <use_windws_dialing_rules> - this tag specifies if Ziper will use Windws Dialing Rules t translate the phne number that the user is trying t dial. The user must dial the number in cannical frm. (Outlk stres the phne numbers like this). This tag is used in Ziper Biz nly. <start_with_windws> - this tag is used t specify if Ziper will lad n Windws start up. <shw_hints> - nt used. <start_minimized> - this tag specifies if Ziper will start minimized. <frward_type> - this tag defines what kind f frwarding type was last used frm the user. 0 - instant frwarding; 1 - frwarding after number f secnds specified in the "frward_secnds" tag; 2 - instant aut-answer; 3 - aut-answer after a number f secnds, specified in the "autanswer_secnds" tag. This tag is used in Ziper Biz nly. <frward_secnds> - this tag defines the time after which frward after will frward the call. It is used in Ziper Biz nly. <frward_extensin> - this tag stres the last extensin that was used fr frwarding. It is used in Ziper Biz nly. <autanswer_secnds> - this tag defines the time after Ziper will autanswer the call. It is used in Ziper Biz nly. <play_sund_n_aut_answer> - this tag specifies if Ziper will play a specific sund when a call is aut-answered. It is used in Ziper Biz nly. <autmatic_url_pen> - this tag specifies if Ziper will prmpt the user t pen a URL sent frm the remte peer r server. If it is set t False, the user will be prmpted. It is used in Ziper Biz nly. <pen_url_n_style> - this tag defines the behavir f the "Open URL n:" feature. It is used in Ziper Biz nly. 0 - never pen URL; 1 - n call answer; 2 - n incming and utging call; 3 - n incming call answer; 4 - n incming call; 5 - n utging call answer; 6 - n utging call. <pen_url> - this tag defines the URL that will be pened using "pen_url_n_style" style. It is used in Ziper Biz nly. ZOIPER Cnfiguratin File Dcumentatin f 15

5 <number_f_lines> - this tag specifies the number f lines that Ziper will use. The minimum value is 1 and the maximum is 6. This tag is used in Ziper Biz nly. <strip_dial_chars> - this tag defines the character that will be stripped frm the "Phne t dial" field upn dialing. The characters, stripped by default are -()[]{}. This tag is used in Ziper Biz nly. <language> - this tag defines the language used by the Ziper GUI. If n language r invalid language is specified, the default ne will be used (English). The valid languages are: English, Nederlands, Deutsch, Français, Españl. <default_accunt> - this tag defines the default selected accunt in Ziper. <n_transfer_request_style> - this tag defines the actins that Ziper undertakes n cases when the ther side attempts t transfer a call. 0 - always accept; 1 - always reject; 2 - ask (a ppup windw appears). 3.2 sip_ptins <prt> - this tag specifies the prt that Ziper will use t accept incming calls and send utging SIP calls when UDP transprt is used. Fr the ther transprt types it is used nly fr incming calls. Default: iax_ptins <prt> - this tag specifies the prt that Ziper will use t accept incming calls and send utging IAX calls. Default: rtp_ptins <prt> - this tag specifies the starting prt f the prt range used frm Ziper fr RTP sessins. It shuld be an even number. Default: <sessin_name> - this tag specifies the RTP sessin name that will be used. It shuld nt cntain spaces. <url> - this tag specifies the RTP URL that will be used. It shuld nt cntain spaces. < > - this tag specifies the RTP that will be used. This tag shuld nt cntain spaces. ZOIPER Cnfiguratin File Dcumentatin f 15

6 3.5 stun_ptins <enable_stun> - this tag defines if the usage f the default STUN server is enabled. <stun_hst> - this tag specifies the STUN server hst address. <stun_prt> - this tag specifies the STUN server prt. Default: <stun_refresh_perid> - this tag specifies the STUN server refresh perid. 3.6 audi <input_device> - this tag specifies the input audi device name used by Ziper. If there is n device name specified r the device is nt present n the system, Ziper will use the system's default ne. <utput_device> - this tag specifies the audi utput device name used by Ziper. If there is n device name specified r the device is nt present n the system, Ziper will use the system default ne. <ringing_device> - this tag specifies the audi ringing device name used by Ziper. If there is n device name specified r the device is nt present n the system, Ziper will use the system default utput device. <use_ech_cancellatin> - this tag specifies if the ech cancellatin filter will be used. <use_audi_enhancement> - this tag specifies if audi enhancement and cmpensatin will be used. <ring_tne_file> - this tag specifies a file that will be used fr custm ringing. The file shuld be a WAV file cntaining 8000 Hz 16-bit mn audi data. This tag is used in Ziper Biz nly. <mic_bst> - this tag specifies if the micrphne bst feature will be turned n fr the selected input audi device. <pc_speaker_ring> - this tag defines if Ziper will make ringing sund thrugh the PC speaker. It is used in Ziper Biz nly. <mute_n_early_media> - this tag enables the phne t mute itself when early media is detected. This tag is used in Ziper Biz nly. In Ziper Free it is always False. <ring_when_talking> - this tag specifies if Ziper will make ringing sunds if the user have busy line. ZOIPER Cnfiguratin File Dcumentatin f 15

7 It is used in Ziper Biz nly. In Ziper Free it is always True; <input_vlume> - the input audi vlume is represented by this tag. Its value can vary frm 0(min) t 1(max). <utput_vlume> - the utput audi vlume is represented by this tag. Its value can vary frm 0(min) t 1(max). <disable_dtmf_sunds> - this tag specifies if Ziper will play DTMF sunds when they are sent ut f band. 3.7 prvisin <remember_username_passwrd> - this tag specifies if the prvisin username and passwrd will be saved in this cnfig file. <lgin_autmatically> - this tag spеcifies if the stred prvisin username and passwrd are feeded right away t the prvisin server. This tag desn't have effect if the "remember_username _passwrd" is nt set t True. <username> - this tag cntains the stred prvisin username. <passwrd> - this tag cntains the stred prvisin passwrd. It culd be encded r be plain text. 3.8 diagnstics <enable_debug_lg> - this tag enables the diagnstic lgging. The lg files generated by Ziper are lcated in the Ziper Installatin flder and are generated immediately upn executin f the phne. 3.9 fax <fax_enabled> - this tag enables receiving f T.38 faxes. Received faxes are stred as.tiff files in the chsen destinatin flder. <destinatin_flder> - this tag defines the path t the flder, used by Ziper t stre faxes. <custm_cmmand> - this tag deals with incming faxes using a certain applicatin. Fr example it may pen a prgram, assciated with.tiff files. $(FAX_FILENAME) - when this parameter is used, Ziper replaces it with the actual filename f the received.tiff file. ZOIPER Cnfiguratin File Dcumentatin f 15

8 <autmatic_display> - this tag autmatically pens the applicatin that.tiff files are assciated with. If n applicatin is assciated with.tiff files, the user will be prmpted t chse a prgram frm a list. <autmatic_print> - this tag enables Ziper t autmatically print the received.tiff files, using the current default printer netwrk <signal_dscp> - this tag defines the values, assigned t the signaling (SIP) netwrk packets ; 10 - AF11; 12 - AF12; 14 - AF13; 18 - AF21; 20 - AF22; 22 - AF23; 26 - AF31; 28 - AF32; 30 - AF33; 34 - AF41; 36 - AF42; 38 - AF43; 46 - EF. <media_dscp> - this tag defines the values, assigned t the media (RTP, IAX) netwrk packets ; 10 - AF11; 12 - AF12; 14 - AF13; 18 - AF21; 20 - AF22; 22 - AF23; 26 - AF31; 28 - AF32; 30 - AF33; 34 - AF41; 36 - AF42; 38 - AF43; 46 - EF restrictins The "restrictins" sectin hlds identifiers, separated by cmma (,). If a particular identifier is present, the restrictin will be applied. The valid identifiers and their descriptins are as fllws: ptins_sip_accunts - n SIP accunts can be added, edited, deleted and displayed in the Optins windw. ZOIPER Cnfiguratin File Dcumentatin f 15

9 ptins_iax_accunts - n IAX accunts can be added, edited, deleted and displayed in the Optins windw. ptins_sip_new_accunt - n SIP accunts can be added. ptins_iax_new_accunt - n IAX accunts can be added. ptins_audi_general - n General Audi Optins will be displayed in the Optins windw. ptins_audi_devices - n Audi Devices Optins will be displayed in the Optins windw. ptins_audi_cdecs - n Audi Cdecs Optins will be displayed in the Optins windw. ptins_general - n General Optins will be displayed in the Optins windw. ptins_call_events - n General Call Events Optins will be displayed in the Optins windw. ptins_integratin - n General Integratin/Autmatin Optins will be displayed in the Optins windw. ptins_prvisin - n Prvisin Optins will be displayed in the Optins windw. ptins_sip - n SIP Optins will be displayed in the Optins windw. ptins_iax - n IAX Optins will be displayed in the Optins windw. ptins_rtp - n RTP Optins will be displayed in the Optins windw. ptins_stun - n Default STUN Optins will be displayed in the Optins windw. ptins_diagnstics - n Diagnstics Optins will be displayed in the Optins windw. ptins_netwrk - n Netwrk Optins will be displayed in the Optins windw. ptins_fax - n Fax Optins will be displayed in the Optins windw. hld - the Hld buttn in the main windw will be disabled. frwarding_autanswer - the Frwarding/Aut-answer buttn in the main windw will be disabled. transfer - the Transfer buttn in the main windw will be disabled. addressbk - the Addressbk buttn in the main windw will be disabled. histry - the Histry buttn in the main windw will be disabled. ZOIPER Cnfiguratin File Dcumentatin f 15

10 cnference - the Cnference buttn in the main windw will be disabled. check_vic - the Vic buttn in the main windw will be disabled. ptins - the Optins buttn in the main windw will be disabled. dtmf - the Shw DTMF Panel buttn in the main windw will be disabled. quick_dial - the Shw Quick Dial Panel buttn in the main windw will be disabled. accunt_selectin - the Accunt selectin cmb bx in the main windw will be disabled. register - the Register buttn in the main windw will be disabled. mute - the Mute Input and Output buttns in the main windw will be disabled. vlume - the Input and Output Vlume sliders in the main windw will be disabled cdecs <use_default_speex_settings> - this tag is nt used. <enhance_decding> - this tag is nt used. <quality> - this tag is nt used. <bitrate> - this tag is nt used. <variable_bit_rate> - this tag is nt used. <average_bit_rate> - this tag is nt used. <cmplexity> - this tag is nt used. Apart frm these tags the "cdecs" sectin shuld cntain a number f "cdec" sub-sectins cdec <name> - the name f the cdec. <cdec_id> - the cdec ID. 0 - ulaw; 1 - GSM; 2 - ilbc30; 6 - alaw; 24 - Speex NB. <pririty> - this tag specifies the cdec pririty. 1 is the highest pririty. ZOIPER Cnfiguratin File Dcumentatin f 15

11 <selected> - this tag specifies if the cdec will be used accunt All <accunt> sub-sectins are situated in the <accunts> sectin. <tech> - this tag indicates what technlgy is used. 0 - fr SIP; 1 - fr IAX. <name> - the name f the accunt. It must be unique. <hst> - fr IAX this tag specifies the address which will be used. Fr SIP this tag specifies the utbund prxy address. <use_utbund_prxy> - this tag is used with SIP accunts and specifies if the accunt will use different than the dmain utbund prxy server. <username> - this tag specifies the username fr registratin and authenticatin used by this accunt. Fr SIP the authenticatin username can be different. <authenticatin_username> - this tag is used by SIP accunts fr authenticatin when a different username is required. <passwrd> - this tag specifies the authrizatin passwrd fr this accunt. It culd be encded r be plain text. <cntext> - fr IAX this tag specifies the cntext used by the accunt. Fr SIP this tag specifies the dmain used by the accunt. <callerid> - this tag specifies the caller ID name. <number> - this tag specifies the caller ID number fr IAX nly. <register_n_startup> - this tag specifies if the accunt shuld be registered n startup f the phne. <d_nt_play_ringback_tnes> - this tag specifies if ringback tnes will be played fr this accunt. <vic _check_extensin> - this tag specifies the extensin that will be use t dial the accunts vic . It is used in Ziper Biz nly. <use_stun> - this is a tag that defines the STUN usage fr this accunt nly fr SIP. 0 - dn't use STUN; 1 - use the default STUN server; 2 - use custm STUN server defined in this accunt. <stun_hst> - this tag is used nly when custm STUN usage is defined. It specifies the STUN server hst address. ZOIPER Cnfiguratin File Dcumentatin f 15

12 <stun_prt> - this tag is used nly when custm STUN usage is defined. It specifies the STUN server prt. Default: <stun_refresh_perid> - this tag is used nly when custm STUN usage is defined. It specifies the STUN server refresh perid. <transprt_type> - this tag defines the packet transprt type nly fr SIP. 0 - this accunt will use UDP transprt; 1 - TCP transprt; 2 - TLS transprt. This tag is used in Ziper Biz nly. Ziper Free uses UDP transprt nly. <custm_cdecs> - this tag specifies if custm cdecs set will be used fr this accunt. If this tag is set t True the accunt sectin shuld cntain "cdecs" sectin (cdec set). <dtmf_style> - this tag defines the way f sending DTMF tnes cncerning a particular SIP accunt. 0 - DTMF RFC-2833; 1 - DTMF SIP INFO. ZOIPER Cnfiguratin File Dcumentatin f 15

13 4. Example <?xml versin="1.0" encding="utf-8"?> <ptins> <general> <recrd_calls>0</recrd_calls> <recrd_path></recrd_path> <always_n_tp>0</always_n_tp> g_call> <autmatic_ppup_n_incming_call>1</autmatic_ppup_n_incmin <ppup_menu_n_incming_call>1</ppup_menu_n_incming_call> <user_data_visible>1</user_data_visible> <vlume_cntrls_visible>1</vlume_cntrls_visible> <lg_visible>0</lg_visible> <check_fr_updates>1</check_fr_updates> <catch_prtcl_requests>1</catch_prtcl_requests> <integrate_int_utlk>1</integrate_int_utlk> <use_windws_dialing_rules>1</use_windws_dialing_rules> <start_with_windws>1</start_with_windws> <shw_hints>0</shw_hints> <start_minimized>0</start_minimized> <frward_type>0</frward_type> <frward_secnds>30</frward_secnds> <frward_extensin></frward_extensin> <autanswer_secnds>30</autanswer_secnds> <play_sund_n_aut_answer>1</play_sund_n_aut_answer> <autmatic_url_pen>0</autmatic_url_pen> <pen_url_n_style>0</pen_url_n_style> <pen_url></pen_url> <number_f_lines>6</number_f_lines> <strip_dial_chars>+-()[]{}</strip_dial_chars> <language>english</language> <default_accunt>sipaccunt</default_accunt> <n_transfer_request_style>2</n_transfer_request_style> </general> <sip_ptins> <prt>5060</prt> </sip_ptins> <iax_ptins> <prt>4569</prt> </iax_ptins> <rtp_ptins> <prt>8000</prt> <sessin_name>ziper_user</sessin_name> <url> </rtp_ptins> <stun_ptins> <enable_stun>1</enable_stun> <stun_hst>stun.ziper.cm</stun_hst> <stun_prt>3478</stun_prt> <stun_refresh_perid>30</stun_refresh_perid> </stun_ptins> ZOIPER Cnfiguratin File Dcumentatin f 15

14 <audi> <input_device>realtek AC97 Audi</input_device> <utput_device>realtek AC97 Audi</utput_device> <ringing_device></ringing_device> <use_ech_cancellatin>1</use_ech_cancellatin> <use_audi_enhancement>1</use_audi_enhancement> <ring_tne_file></ring_tne_file> <mic_bst>0</mic_bst> <pc_speaker_ring>0</pc_speaker_ring> <mute_n_early_media>0</mute_n_early_media> <ring_when_talking>1</ring_when_talking> <input_vlume>1</input_vlume> <utput_vlume>0.5</utput_vlume> <ringtne_path></ringtne_path> <disable_dtmf_sunds>0</disable_dtmf_sunds> </audi> <transfer> <park_extensin>700</park_extensin> <vic _prefix>mail</vic _prefix> </transfer> <prvisin> <remember_username_passwrd>0</remember_username_passwrd> <lgin_autmatically>0</lgin_autmatically> <username></username> <passwrd></passwrd> </prvisin> <diagnstics> <enable_debug_lg>0</enable_debug_lg> </diagnstics> <restrictins> accunt_selectin, register</restrictins> <accunts> <accunt> <tech>0</tech> <use_utbund_prxy>1</use_utbund_prxy> <name>sipaccunt</name> <hst>utbundprxy.xm</hst> <username>theuser</username> <authenticatin_username></authenticatin_username> <passwrd>filclf5d0dibmu+9swyisa==</passwrd> <cntext>dmain.cm</cntext> <callerid>caller</callerid> <number></number> <register_n_startup>1</register_n_startup> <d_nt_play_ringback_tnes>0</d_nt_play_ringback_tnes> <use_stun>2</use_stun> <stun_hst>thestun.cm</stun_hst> <stun_prt>3478</stun_prt> <stun_refresh_perid>30</stun_refresh_perid> <custm_cdecs>0</custm_cdecs> <dtmf_style>0</dtmf_style> </accunt> </accunts> <cdecs> <cdec> <name>gsm</name> ZOIPER Cnfiguratin File Dcumentatin f 15

15 <cdec_id>1</cdec_id> <pririty>1</pririty> <selected>1</selected> </cdec> <cdec> <name>speex</name> <cdec_id>24</cdec_id> <pririty>2</pririty> <selected>1</selected> </cdec> <cdec> <name>ilbc 30</name> <cdec_id>27</cdec_id> <pririty>3</pririty> <selected>1</selected> </cdec> <cdec> <name>a-law</name> <cdec_id>6</cdec_id> <pririty>4</pririty> <selected>1</selected> </cdec> <cdec> <name>u-law</name> <cdec_id>0</cdec_id> <pririty>5</pririty> <selected>1</selected> </cdec> <cdec> <name>ilbc 20</name> <cdec_id>28</cdec_id> <pririty>6</pririty> <selected>1</selected> </cdec> <use_default_speex_settings>1</use_default_speex_settings> <enhance_decding>1</enhance_decding> <quality>4</quality> <bitrate>8</bitrate> <variable_bit_rate>0</variable_bit_rate> <average_bit_rate>0</average_bit_rate> <cmplexity>3</cmplexity> </cdecs> </ptins> ZOIPER Cnfiguratin File Dcumentatin f 15