628f58759709cca9534657cf78dbe1f5970fa581
[asterisk/asterisk.git] / configs / sip.conf.sample
1 ;
2 ; SIP Configuration example for Asterisk
3 ;
4 ; Note: Please read the security documentation for Asterisk in order to
5 ;       understand the risks of installing Asterisk with the sample
6 ;       configuration. If your Asterisk is installed on a public
7 ;       IP address connected to the Internet, you will want to learn
8 ;       about the various security settings BEFORE you start
9 ;       Asterisk. 
10 ;       Especially note the following settings:
11 ;               - allowguest (default enabled)
12 ;               - permit/deny - IP address filters
13 ;               - contactpermit/contactdeny - IP address filters for registrations
14 ;               - context - Which set of services you offer various users
15 ;
16 ; SIP dial strings
17 ;-----------------------------------------------------------
18 ; In the dialplan (extensions.conf) you can use several
19 ; syntaxes for dialing SIP devices.
20 ;        SIP/devicename
21 ;        SIP/username@domain   (SIP uri)
22 ;        SIP/username[:password[:md5secret[:authname[:transport]]]]@host[:port]
23 ;        SIP/devicename/extension
24 ;
25 ;
26 ; Devicename
27 ;        devicename is defined as a peer in a section below.
28 ;
29 ; username@domain
30 ;        Call any SIP user on the Internet
31 ;        (Don't forget to enable DNS SRV records if you want to use this)
32 ;
33 ; devicename/extension
34 ;        If you define a SIP proxy as a peer below, you may call
35 ;        SIP/proxyhostname/user or SIP/user@proxyhostname
36 ;        where the proxyhostname is defined in a section below
37 ;        This syntax also works with ATA's with FXO ports
38 ;
39 ; SIP/username[:password[:md5secret[:authname]]]@host[:port]
40 ;        This form allows you to specify password or md5secret and authname
41 ;        without altering any authentication data in config.
42 ;        Examples:
43 ;
44 ;        SIP/*98@mysipproxy
45 ;        SIP/sales:topsecret::account02@domain.com:5062
46 ;        SIP/12345678::bc53f0ba8ceb1ded2b70e05c3f91de4f:myname@192.168.0.1
47 ;
48 ; All of these dial strings specify the SIP request URI.
49 ; In addition, you can specify a specific To: header by adding an
50 ; exclamation mark after the dial string, like
51 ;
52 ;         SIP/sales@mysipproxy!sales@edvina.net
53 ;
54 ; CLI Commands
55 ; -------------------------------------------------------------
56 ; Useful CLI commands to check peers/users:
57 ;   sip show peers               Show all SIP peers (including friends)
58 ;   sip show registry            Show status of hosts we register with
59 ;
60 ;   sip set debug on             Show all SIP messages
61 ;
62 ;   module reload chan_sip.so    Reload configuration file
63 ;
64 ;------- Naming devices ------------------------------------------------------
65 ;
66 ; When naming devices, make sure you understand how Asterisk matches calls
67 ; that come in.
68 ;       1. Asterisk checks the SIP From: address username and matches against
69 ;          names of devices with type=user
70 ;          The name is the text between square brackets [name]
71 ;       2. Asterisk checks the From: addres and matches the list of devices
72 ;          with a type=peer
73 ;       3. Asterisk checks the IP address (and port number) that the INVITE
74 ;          was sent from and matches against any devices with type=peer
75 ;
76 ; Don't mix extensions with the names of the devices. Devices need a unique
77 ; name. The device name is *not* used as phone numbers. Phone numbers are
78 ; anything you declare as an extension in the dialplan (extensions.conf).
79 ;
80 ; When setting up trunks, make sure there's no risk that any From: username
81 ; (caller ID) will match any of your device names, because then Asterisk
82 ; might match the wrong device.
83 ;
84 ; Note: The parameter "username" is not the username and in most cases is
85 ;       not needed at all. Check below. In later releases, it's renamed
86 ;       to "defaultuser" which is a better name, since it is used in
87 ;       combination with the "defaultip" setting.
88 ;-----------------------------------------------------------------------------
89
90 ; ** Old configuration options **
91 ; The "call-limit" configuation option is considered old is replaced
92 ; by new functionality. To enable callcounters, you use the new 
93 ; "callcounter" setting (for extension states in queue and subscriptions)
94 ; You are encouraged to use the dialplan groupcount functionality
95 ; to enforce call limits instead of using this channel-specific method.
96 ; You can still set limits per device in sip.conf or in a database by using
97 ; "setvar" to set variables that can be used in the dialplan for various limits.
98
99 [general]
100 context=default                 ; Default context for incoming calls
101 ;allowguest=no                  ; Allow or reject guest calls (default is yes)
102                                 ; If your Asterisk is connected to the Internet
103                                 ; and you have allowguest=yes
104                                 ; you want to check which services you offer everyone
105                                 ; out there, by enabling them in the default context (see below).
106 ;match_auth_username=yes        ; if available, match user entry using the
107                                 ; 'username' field from the authentication line
108                                 ; instead of the From: field.
109 allowoverlap=no                 ; Disable overlap dialing support. (Default is yes)
110 ;allowtransfer=no               ; Disable all transfers (unless enabled in peers or users)
111                                 ; Default is enabled. The Dial() options 't' and 'T' are not
112                                 ; related as to whether SIP transfers are allowed or not.
113 ;realm=mydomain.tld             ; Realm for digest authentication
114                                 ; defaults to "asterisk". If you set a system name in
115                                 ; asterisk.conf, it defaults to that system name
116                                 ; Realms MUST be globally unique according to RFC 3261
117                                 ; Set this to your host name or domain name
118 ;domainsasrealm=no              ; Use domans list as realms
119                                 ; You can serve multiple Realms specifying several
120                                 ; 'domain=...' directives (see below). 
121                                 ; In this case Realm will be based on request 'From'/'To' header
122                                 ; and should match one of domain names.
123                                 ; Otherwise default 'realm=...' will be used.
124 udpbindaddr=0.0.0.0             ; IP address to bind UDP listen socket to (0.0.0.0 binds to all)
125                                 ; Optionally add a port number, 192.168.1.1:5062 (default is port 5060)
126
127 ; When a dialog is started with another SIP endpoint, the other endpoint
128 ; should include an Allow header telling us what SIP methods the endpoint
129 ; implements. However, some endpoints either do not include an Allow header
130 ; or lie about what methods they implement. In the former case, Asterisk
131 ; makes the assumption that the endpoint supports all known SIP methods.
132 ; If you know that your SIP endpoint does not provide support for a specific
133 ; method, then you may provide a comma-separated list of methods that your
134 ; endpoint does not implement in the disallowed_methods option. Note that 
135 ; if your endpoint is truthful with its Allow header, then there is no need 
136 ; to set this option. This option may be set in the general section or may
137 ; be set per endpoint. If this option is set both in the general section and
138 ; in a peer section, then the peer setting completely overrides the general
139 ; setting (i.e. the result is *not* the union of the two options).
140 ;
141 ; Note also that while Asterisk currently will parse an Allow header to learn
142 ; what methods an endpoint supports, the only actual use for this currently
143 ; is for determining if Asterisk may send connected line UPDATE requests. Its
144 ; use may be expanded in the future.
145 ;
146 ; disallowed_methods = UPDATE
147
148 ;
149 ; Note that the TCP and TLS support for chan_sip is currently considered
150 ; experimental.  Since it is new, all of the related configuration options are
151 ; subject to change in any release.  If they are changed, the changes will
152 ; be reflected in this sample configuration file, as well as in the UPGRADE.txt file.
153 ;
154 tcpenable=no                    ; Enable server for incoming TCP connections (default is no)
155 tcpbindaddr=0.0.0.0             ; IP address for TCP server to bind to (0.0.0.0 binds to all interfaces)
156                                 ; Optionally add a port number, 192.168.1.1:5062 (default is port 5060)
157
158 ;tlsenable=no                   ; Enable server for incoming TLS (secure) connections (default is no)
159 ;tlsbindaddr=0.0.0.0            ; IP address for TLS server to bind to (0.0.0.0) binds to all interfaces)
160                                 ; Optionally add a port number, 192.168.1.1:5063 (default is port 5061)
161                                 ; Remember that the IP address must match the common name (hostname) in the
162                                 ; certificate, so you don't want to bind a TLS socket to multiple IP addresses.
163                                 ; For details how to construct a certificate for SIP see 
164                                 ; http://tools.ietf.org/html/draft-ietf-sip-domain-certs
165
166 srvlookup=yes                   ; Enable DNS SRV lookups on outbound calls
167                                 ; Note: Asterisk only uses the first host
168                                 ; in SRV records
169                                 ; Disabling DNS SRV lookups disables the
170                                 ; ability to place SIP calls based on domain
171                                 ; names to some other SIP users on the Internet
172                                 ; Specifying a port in a SIP peer definition or
173                                 ; when dialing outbound calls will supress SRV
174                                 ; lookups for that peer or call.
175
176 ;pedantic=yes                   ; Enable checking of tags in headers,
177                                 ; international character conversions in URIs
178                                 ; and multiline formatted headers for strict
179                                 ; SIP compatibility (defaults to "no")
180
181 ; See qos.tex or Quality of Service section of asterisk.pdf for a description of these parameters.
182 ;tos_sip=cs3                    ; Sets TOS for SIP packets.
183 ;tos_audio=ef                   ; Sets TOS for RTP audio packets.
184 ;tos_video=af41                 ; Sets TOS for RTP video packets.
185 ;tos_text=af41                  ; Sets TOS for RTP text packets.
186
187 ;cos_sip=3                      ; Sets 802.1p priority for SIP packets.
188 ;cos_audio=5                    ; Sets 802.1p priority for RTP audio packets.
189 ;cos_video=4                    ; Sets 802.1p priority for RTP video packets.
190 ;cos_text=3                     ; Sets 802.1p priority for RTP text packets.
191
192 ;maxexpiry=3600                 ; Maximum allowed time of incoming registrations
193                                 ; and subscriptions (seconds)
194 ;minexpiry=60                   ; Minimum length of registrations/subscriptions (default 60)
195 ;defaultexpiry=120              ; Default length of incoming/outgoing registration
196 ;mwiexpiry=3600                 ; Expiry time for outgoing MWI subscriptions
197 ;qualifyfreq=60                 ; Qualification: How often to check for the host to be up in seconds
198                                 ; Set to low value if you use low timeout for NAT of UDP sessions
199                                 ; Default: 60
200 ;qualifygap=100                 ; Number of milliseconds between each group of peers being qualified
201                                 ; Default: 100
202 ;qualifypeers=1                 ; Number of peers in a group to be qualified at the same time
203                                 ; Default: 1
204 ;notifymimetype=text/plain      ; Allow overriding of mime type in MWI NOTIFY
205 ;buggymwi=no                    ; Cisco SIP firmware doesn't support the MWI RFC
206                                 ; fully. Enable this option to not get error messages
207                                 ; when sending MWI to phones with this bug.
208 ;mwi_from=asterisk              ; When sending MWI NOTIFY requests, use this setting in
209                                 ; the From: header as the "name" portion. Also fill the
210                                 ; "user" portion of the URI in the From: header with this
211                                 ; value if no fromuser is set
212                                 ; Default: empty
213 ;vmexten=voicemail              ; dialplan extension to reach mailbox sets the
214                                 ; Message-Account in the MWI notify message
215                                 ; defaults to "asterisk"
216
217 ;preferred_codec_only=yes       ; Respond to a SIP invite with the single most preferred codec
218                                 ; rather than advertising all joint codec capabilities. This
219                                 ; limits the other side's codec choice to exactly what we prefer.
220
221 ;disallow=all                   ; First disallow all codecs
222 ;allow=ulaw                     ; Allow codecs in order of preference
223 ;allow=ilbc                     ; see doc/rtp-packetization for framing options
224 ;
225 ; This option specifies a preference for which music on hold class this channel
226 ; should listen to when put on hold if the music class has not been set on the
227 ; channel with Set(CHANNEL(musicclass)=whatever) in the dialplan, and the peer
228 ; channel putting this one on hold did not suggest a music class.
229 ;
230 ; This option may be specified globally, or on a per-user or per-peer basis.
231 ;
232 ;mohinterpret=default
233 ;
234 ; This option specifies which music on hold class to suggest to the peer channel
235 ; when this channel places the peer on hold. It may be specified globally or on
236 ; a per-user or per-peer basis.
237 ;
238 ;mohsuggest=default
239 ;
240 ;parkinglot=plaza               ; Sets the default parking lot for call parking
241                                 ; This may also be set for individual users/peers
242                                 ; Parkinglots are configured in features.conf
243 ;language=en                    ; Default language setting for all users/peers
244                                 ; This may also be set for individual users/peers
245 ;relaxdtmf=yes                  ; Relax dtmf handling
246 ;trustrpid = no                 ; If Remote-Party-ID should be trusted
247 ;sendrpid = yes                 ; If Remote-Party-ID should be sent (defaults to no)
248 ;sendrpid = rpid                ; Use the "Remote-Party-ID" header
249                                 ; to send the identity of the remote party
250                                 ; This is identical to sendrpid=yes
251 ;sendrpid = pai                 ; Use the "P-Asserted-Identity" header
252                                 ; to send the identity of the remote party
253 ;rpid_update = no               ; In certain cases, the only method by which a connected line
254                                 ; change may be immediately transmitted is with a SIP UPDATE request.
255                                 ; If communicating with another Asterisk server, and you wish to be able
256                                 ; transmit such UPDATE messages to it, then you must enable this option.
257                                 ; Otherwise, we will have to wait until we can send a reinvite to
258                                 ; transmit the information.
259 ;prematuremedia=no              ; Some ISDN links send empty media frames before 
260                                 ; the call is in ringing or progress state. The SIP 
261                                 ; channel will then send 183 indicating early media
262                                 ; which will be empty - thus users get no ring signal.
263                                 ; Setting this to "no" will stop any media before we have
264                                 ; call progress. Default is "yes".
265                                 ;
266                                 ; In order for "noanswer" applications to work, you need to run
267                                 ; the progress() application in the priority before the app.
268
269 ;progressinband=never           ; If we should generate in-band ringing always
270                                 ; use 'never' to never use in-band signalling, even in cases
271                                 ; where some buggy devices might not render it
272                                 ; Valid values: yes, no, never Default: never
273 ;useragent=Asterisk PBX         ; Allows you to change the user agent string
274                                 ; The default user agent string also contains the Asterisk
275                                 ; version. If you don't want to expose this, change the
276                                 ; useragent string.
277 ;promiscredir = no              ; If yes, allows 302 or REDIR to non-local SIP address
278                                 ; Note that promiscredir when redirects are made to the
279                                 ; local system will cause loops since Asterisk is incapable
280                                 ; of performing a "hairpin" call.
281 ;usereqphone = no               ; If yes, ";user=phone" is added to uri that contains
282                                 ; a valid phone number
283 ;dtmfmode = rfc2833             ; Set default dtmfmode for sending DTMF. Default: rfc2833
284                                 ; Other options:
285                                 ; info : SIP INFO messages (application/dtmf-relay)
286                                 ; shortinfo : SIP INFO messages (application/dtmf)
287                                 ; inband : Inband audio (requires 64 kbit codec -alaw, ulaw)
288                                 ; auto : Use rfc2833 if offered, inband otherwise
289
290 ;compactheaders = yes           ; send compact sip headers.
291 ;
292 ;videosupport=yes               ; Turn on support for SIP video. You need to turn this
293                                 ; on in this section to get any video support at all.
294                                 ; You can turn it off on a per peer basis if the general
295                                 ; video support is enabled, but you can't enable it for
296                                 ; one peer only without enabling in the general section.
297                                 ; If you set videosupport to "always", then RTP ports will
298                                 ; always be set up for video, even on clients that don't
299                                 ; support it.  This assists callfile-derived calls and
300                                 ; certain transferred calls to use always use video when
301                                 ; available. [yes|NO|always]
302
303 ;maxcallbitrate=384             ; Maximum bitrate for video calls (default 384 kb/s)
304                                 ; Videosupport and maxcallbitrate is settable
305                                 ; for peers and users as well
306 ;callevents=no                  ; generate manager events when sip ua
307                                 ; performs events (e.g. hold)
308 ;authfailureevents=no           ; generate manager "peerstatus" events when peer can't
309                                 ; authenticate with Asterisk. Peerstatus will be "rejected".
310 ;alwaysauthreject = yes         ; When an incoming INVITE or REGISTER is to be rejected,
311                                 ; for any reason, always reject with an identical response
312                                 ; equivalent to valid username and invalid password/hash
313                                 ; instead of letting the requester know whether there was
314                                 ; a matching user or peer for their request.  This reduces
315                                 ; the ability of an attacker to scan for valid SIP usernames.
316
317 ;g726nonstandard = yes          ; If the peer negotiates G726-32 audio, use AAL2 packing
318                                 ; order instead of RFC3551 packing order (this is required
319                                 ; for Sipura and Grandstream ATAs, among others). This is
320                                 ; contrary to the RFC3551 specification, the peer _should_
321                                 ; be negotiating AAL2-G726-32 instead :-(
322 ;outboundproxy=proxy.provider.domain            ; send outbound signaling to this proxy, not directly to the devices
323 ;outboundproxy=proxy.provider.domain:8080       ; send outbound signaling to this proxy, not directly to the devices
324 ;outboundproxy=proxy.provider.domain,force      ; Send ALL outbound signalling to proxy, ignoring route: headers
325 ;outboundproxy=tls://proxy.provider.domain      ; same as '=proxy.provider.domain' except we try to connect with tls
326 ;                                               ; (could also be tcp,udp) - defining transports on the proxy line only
327 ;                                               ; applies for the global proxy, otherwise use the transport= option
328 ;matchexterniplocally = yes     ; Only substitute the externip or externhost setting if it matches
329                                 ; your localnet setting. Unless you have some sort of strange network
330                                 ; setup you will not need to enable this.
331
332 ;dynamic_exclude_static = yes   ; Disallow all dynamic hosts from registering
333                                 ; as any IP address used for staticly defined
334                                 ; hosts.  This helps avoid the configuration
335                                 ; error of allowing your users to register at
336                                 ; the same address as a SIP provider.
337
338 ;contactdeny=0.0.0.0/0.0.0.0           ; Use contactpermit and contactdeny to
339 ;contactpermit=172.16.0.0/255.255.0.0  ; restrict at what IPs your users may
340                                        ; register their phones.
341
342 ;engine=asterisk                ; RTP engine to use when communicating with the device
343
344 ;
345 ; If regcontext is specified, Asterisk will dynamically create and destroy a
346 ; NoOp priority 1 extension for a given peer who registers or unregisters with
347 ; us and have a "regexten=" configuration item.
348 ; Multiple contexts may be specified by separating them with '&'. The
349 ; actual extension is the 'regexten' parameter of the registering peer or its
350 ; name if 'regexten' is not provided.  If more than one context is provided,
351 ; the context must be specified within regexten by appending the desired
352 ; context after '@'.  More than one regexten may be supplied if they are
353 ; separated by '&'.  Patterns may be used in regexten.
354 ;
355 ;regcontext=sipregistrations
356 ;regextenonqualify=yes          ; Default "no"
357                                 ; If you have qualify on and the peer becomes unreachable
358                                 ; this setting will enforce inactivation of the regexten
359                                 ; extension for the peer
360
361 ; The shrinkcallerid function removes '(', ' ', ')', non-trailing '.', and '-' not
362 ; in square brackets.  For example, the caller id value 555.5555 becomes 5555555
363 ; when this option is enabled.  Disabling this option results in no modification
364 ; of the caller id value, which is necessary when the caller id represents something
365 ; that must be preserved.  This option can only be used in the [general] section.
366 ; By default this option is on.
367 ;
368 ;shrinkcallerid=yes     ; on by default
369
370
371 ;use_q850_reason = no ; Default "no"
372                       ; Set to yes add Reason header and use Reason header if it is available.
373 ;
374 ;------------------------ TLS settings ------------------------------------------------------------
375 ;tlscertfile=</path/to/certificate.pem> ; Certificate file (*.pem format only) to use for TLS connections
376                                         ; default is to look for "asterisk.pem" in current directory
377
378 ;tlsprivatekey=</path/to/private.pem> ; Private key file (*.pem format only) for TLS connections.
379                                       ; If no tlsprivatekey is specified, tlscertfile is searched for
380                                       ; for both public and private key.
381
382 ;tlscafile=</path/to/certificate>
383 ;        If the server your connecting to uses a self signed certificate
384 ;        you should have their certificate installed here so the code can
385 ;        verify the authenticity of their certificate.
386
387 ;tlscadir=</path/to/ca/dir>
388 ;        A directory full of CA certificates.  The files must be named with
389 ;        the CA subject name hash value.
390 ;        (see man SSL_CTX_load_verify_locations for more info)
391
392 ;tlsdontverifyserver=[yes|no]
393 ;        If set to yes, don't verify the servers certificate when acting as
394 ;        a client.  If you don't have the server's CA certificate you can
395 ;        set this and it will connect without requiring tlscafile to be set.
396 ;        Default is no.
397
398 ;tlscipher=<SSL cipher string>
399 ;        A string specifying which SSL ciphers to use or not use
400 ;        A list of valid SSL cipher strings can be found at:
401 ;                http://www.openssl.org/docs/apps/ciphers.html#CIPHER_STRINGS
402 ;
403 ;tlsclientmethod=tlsv1     ; values include tlsv1, sslv3, sslv2.
404                            ; Specify protocol for outbound client connections.
405                            ; If left unspecified, the default is sslv2.
406 ;
407 ;--------------------------- SIP timers ----------------------------------------------------
408 ; These timers are used primarily in INVITE transactions.
409 ; The default for Timer T1 is 500 ms or the measured run-trip time between
410 ; Asterisk and the device if you have qualify=yes for the device.
411 ;
412 ;t1min=100                      ; Minimum roundtrip time for messages to monitored hosts
413                                 ; Defaults to 100 ms
414 ;timert1=500                    ; Default T1 timer
415                                 ; Defaults to 500 ms or the measured round-trip
416                                 ; time to a peer (qualify=yes).
417 ;timerb=32000                   ; Call setup timer. If a provisional response is not received
418                                 ; in this amount of time, the call will autocongest
419                                 ; Defaults to 64*timert1
420
421 ;--------------------------- RTP timers ----------------------------------------------------
422 ; These timers are currently used for both audio and video streams. The RTP timeouts
423 ; are only applied to the audio channel.
424 ; The settings are settable in the global section as well as per device
425 ;
426 ;rtptimeout=60                  ; Terminate call if 60 seconds of no RTP or RTCP activity
427                                 ; on the audio channel
428                                 ; when we're not on hold. This is to be able to hangup
429                                 ; a call in the case of a phone disappearing from the net,
430                                 ; like a powerloss or grandma tripping over a cable.
431 ;rtpholdtimeout=300             ; Terminate call if 300 seconds of no RTP or RTCP activity
432                                 ; on the audio channel
433                                 ; when we're on hold (must be > rtptimeout)
434 ;rtpkeepalive=<secs>            ; Send keepalives in the RTP stream to keep NAT open
435                                 ; (default is off - zero)
436
437 ;--------------------------- SIP Session-Timers (RFC 4028)------------------------------------
438 ; SIP Session-Timers provide an end-to-end keep-alive mechanism for active SIP sessions.
439 ; This mechanism can detect and reclaim SIP channels that do not terminate through normal
440 ; signaling procedures. Session-Timers can be configured globally or at a user/peer level.
441 ; The operation of Session-Timers is driven by the following configuration parameters:
442 ;
443 ; * session-timers    - Session-Timers feature operates in the following three modes:
444 ;                            originate : Request and run session-timers always
445 ;                            accept    : Run session-timers only when requested by other UA
446 ;                            refuse    : Do not run session timers in any case
447 ;                       The default mode of operation is 'accept'.
448 ; * session-expires   - Maximum session refresh interval in seconds. Defaults to 1800 secs.
449 ; * session-minse     - Minimum session refresh interval in seconds. Defualts to 90 secs.
450 ; * session-refresher - The session refresher (uac|uas). Defaults to 'uas'.
451 ;
452 ;session-timers=originate
453 ;session-expires=600
454 ;session-minse=90
455 ;session-refresher=uas
456 ;
457 ;--------------------------- SIP DEBUGGING ---------------------------------------------------
458 ;sipdebug = yes                 ; Turn on SIP debugging by default, from
459                                 ; the moment the channel loads this configuration
460 ;recordhistory=yes              ; Record SIP history by default
461                                 ; (see sip history / sip no history)
462 ;dumphistory=yes                ; Dump SIP history at end of SIP dialogue
463                                 ; SIP history is output to the DEBUG logging channel
464
465
466 ;--------------------------- STATUS NOTIFICATIONS (SUBSCRIPTIONS) ----------------------------
467 ; You can subscribe to the status of extensions with a "hint" priority
468 ; (See extensions.conf.sample for examples)
469 ; chan_sip support two major formats for notifications: dialog-info and SIMPLE
470 ;
471 ; You will get more detailed reports (busy etc) if you have a call counter enabled
472 ; for a device.
473 ;
474 ; If you set the busylevel, we will indicate busy when we have a number of calls that
475 ; matches the busylevel treshold.
476 ;
477 ; For queues, you will need this level of detail in status reporting, regardless
478 ; if you use SIP subscriptions. Queues and manager use the same internal interface
479 ; for reading status information.
480 ;
481 ; Note: Subscriptions does not work if you have a realtime dialplan and use the
482 ; realtime switch.
483 ;
484 ;allowsubscribe=no              ; Disable support for subscriptions. (Default is yes)
485 ;subscribecontext = default     ; Set a specific context for SUBSCRIBE requests
486                                 ; Useful to limit subscriptions to local extensions
487                                 ; Settable per peer/user also
488 ;notifyringing = no             ; Control whether subscriptions already INUSE get sent
489                                 ; RINGING when another call is sent (default: yes)
490 ;notifyhold = yes               ; Notify subscriptions on HOLD state (default: no)
491                                 ; Turning on notifyringing and notifyhold will add a lot
492                                 ; more database transactions if you are using realtime.
493 ;notifycid = yes                ; Control whether caller ID information is sent along with
494                                 ; dialog-info+xml notifications (supported by snom phones).
495                                 ; Note that this feature will only work properly when the
496                                 ; incoming call is using the same extension and context that
497                                 ; is being used as the hint for the called extension.  This means
498                                 ; that it won't work when using subscribecontext for your sip
499                                 ; user or peer (if subscribecontext is different than context).
500                                 ; This is also limited to a single caller, meaning that if an
501                                 ; extension is ringing because multiple calls are incoming,
502                                 ; only one will be used as the source of caller ID.  Specify
503                                 ; 'ignore-context' to ignore the called context when looking
504                                 ; for the caller's channel.  The default value is 'no.' Setting
505                                 ; notifycid to 'ignore-context' also causes call-pickups attempted
506                                 ; via SNOM's NOTIFY mechanism to set the context for the call pickup
507                                 ; to PICKUPMARK.
508 ;callcounter = yes              ; Enable call counters on devices. This can be set per
509                                 ; device too.
510
511 ;----------------------------------------- T.38 FAX SUPPORT ----------------------------------
512 ;
513 ; This setting is available in the [general] section as well as in device configurations.
514 ; Setting this to yes enables T.38 FAX (UDPTL) on SIP calls; it defaults to off.
515 ;
516 ; t38pt_udptl = yes            ; Enables T.38 with FEC error correction.
517 ; t38pt_udptl = yes,fec        ; Enables T.38 with FEC error correction.
518 ; t38pt_udptl = yes,redundancy ; Enables T.38 with redundancy error correction.
519 ; t38pt_udptl = yes,none       ; Enables T.38 with no error correction.
520 ;
521 ; In some cases, T.38 endpoints will provide a T38FaxMaxDatagram value (during T.38 setup) that
522 ; is based on an incorrect interpretation of the T.38 recommendation, and results in failures
523 ; because Asterisk does not believe it can send T.38 packets of a reasonable size to that
524 ; endpoint (Cisco media gateways are one example of this situation). In these cases, during a
525 ; T.38 call you will see warning messages on the console/in the logs from the Asterisk UDPTL
526 ; stack complaining about lack of buffer space to send T.38 FAX packets. If this occurs, you
527 ; can set an override (globally, or on a per-device basis) to make Asterisk ignore the
528 ; T38FaxMaxDatagram value specified by the other endpoint, and use a configured value instead.
529 ; This can be done by appending 'maxdatagram=<value>' to the t38pt_udptl configuration option,
530 ; like this:
531 ;
532 ; t38pt_udptl = yes,fec,maxdatagram=400 ; Enables T.38 with FEC error correction and overrides
533 ;                                       ; the other endpoint's provided value to assume we can
534 ;                                       ; send 400 byte T.38 FAX packets to it.
535 ;
536 ; FAX detection will cause the SIP channel to jump to the 'fax' extension (if it exists)
537 ; based one or more events being detected. The events that can be detected are an incoming
538 ; CNG tone or an incoming T.38 re-INVITE request.
539 ;
540 ; faxdetect = yes               ; Default 'no', 'yes' enables both CNG and T.38 detection
541 ; faxdetect = cng               ; Enables only CNG detection
542 ; faxdetect = t38               ; Enables only T.38 detection
543 ;
544 ;----------------------------------------- OUTBOUND SIP REGISTRATIONS  ------------------------
545 ; Asterisk can register as a SIP user agent to a SIP proxy (provider)
546 ; Format for the register statement is:
547 ;       register => [peer?][transport://]user[@domain][:secret[:authuser]]@host[:port][/extension][~expiry]
548 ;
549 ;
550 ;
551 ; domain is either
552 ;       - domain in DNS
553 ;       - host name in DNS
554 ;       - the name of a peer defined below or in realtime
555 ; The domain is where you register your username, so your SIP uri you are registering to
556 ; is username@domain
557 ;
558 ; If no extension is given, the 's' extension is used. The extension needs to
559 ; be defined in extensions.conf to be able to accept calls from this SIP proxy
560 ; (provider).
561 ;
562 ; A similar effect can be achieved by adding a "callbackextension" option in a peer section.
563 ; this is equivalent to having the following line in the general section:
564 ;
565 ;        register => username:secret@host/callbackextension
566 ;
567 ; and more readable because you don't have to write the parameters in two places
568 ; (note that the "port" is ignored - this is a bug that should be fixed).
569 ;
570 ; Note that a register= line doesn't mean that we will match the incoming call in any
571 ; other way than described above. If you want to control where the call enters your
572 ; dialplan, which context, you want to define a peer with the hostname of the provider's
573 ; server. If the provider has multiple servers to place calls to your system, you need
574 ; a peer for each server.
575 ;
576 ; Beginning with Asterisk version 1.6.2, the "user" portion of the register line may
577 ; contain a port number. Since the logical separator between a host and port number is a
578 ; ':' character, and this character is already used to separate between the optional "secret"
579 ; and "authuser" portions of the line, there is a bit of a hoop to jump through if you wish
580 ; to use a port here. That is, you must explicitly provide a "secret" and "authuser" even if
581 ; they are blank. See the third example below for an illustration.
582 ;
583 ;
584 ; Examples:
585 ;
586 ;register => 1234:password@mysipprovider.com
587 ;
588 ;     This will pass incoming calls to the 's' extension
589 ;
590 ;
591 ;register => 2345:password@sip_proxy/1234
592 ;
593 ;    Register 2345 at sip provider 'sip_proxy'.  Calls from this provider
594 ;    connect to local extension 1234 in extensions.conf, default context,
595 ;    unless you configure a [sip_proxy] section below, and configure a
596 ;    context.
597 ;    Tip 1: Avoid assigning hostname to a sip.conf section like [provider.com]
598 ;    Tip 2: Use separate inbound and outbound sections for SIP providers
599 ;           (instead of type=friend) if you have calls in both directions
600 ;
601 ;register => 3456@mydomain:5082::@mysipprovider.com
602 ;
603 ;    Note that in this example, the optional authuser and secret portions have
604 ;    been left blank because we have specified a port in the user section
605 ;
606 ;register => tls://username:xxxxxx@sip-tls-proxy.example.org
607 ;
608 ;    The 'transport' part defaults to 'udp' but may also be 'tcp' or 'tls'.
609 ;    Using 'udp://' explicitly is also useful in case the username part
610 ;    contains a '/' ('user/name').
611
612 ;registertimeout=20             ; retry registration calls every 20 seconds (default)
613 ;registerattempts=10            ; Number of registration attempts before we give up
614                                 ; 0 = continue forever, hammering the other server
615                                 ; until it accepts the registration
616                                 ; Default is 0 tries, continue forever
617
618 ;----------------------------------------- OUTBOUND MWI SUBSCRIPTIONS -------------------------
619 ; Asterisk can subscribe to receive the MWI from another SIP server and store it locally for retrieval
620 ; by other phones.
621 ; Format for the mwi register statement is:
622 ;       mwi => user[:secret[:authuser]]@host[:port][/mailbox]
623 ;
624 ; Examples:
625 ;mwi => 1234:password@mysipprovider.com/1234
626 ;
627 ; MWI received will be stored in the 1234 mailbox of the SIP_Remote context. It can be used by other phones by following the below:
628 ; mailbox=1234@SIP_Remote
629 ;----------------------------------------- NAT SUPPORT ------------------------
630 ;
631 ; WARNING: SIP operation behind a NAT is tricky and you really need
632 ; to read and understand well the following section.
633 ;
634 ; When Asterisk is behind a NAT device, the "local" address (and port) that
635 ; a socket is bound to has different values when seen from the inside or
636 ; from the outside of the NATted network. Unfortunately this address must
637 ; be communicated to the outside (e.g. in SIP and SDP messages), and in
638 ; order to determine the correct value Asterisk needs to know:
639 ;
640 ; + whether it is talking to someone "inside" or "outside" of the NATted network.
641 ;   This is configured by assigning the "localnet" parameter with a list
642 ;   of network addresses that are considered "inside" of the NATted network.
643 ;   IF LOCALNET IS NOT SET, THE EXTERNAL ADDRESS WILL NOT BE SET CORRECTLY.
644 ;   Multiple entries are allowed, e.g. a reasonable set is the following:
645 ;
646 ;      localnet=192.168.0.0/255.255.0.0 ; RFC 1918 addresses
647 ;      localnet=10.0.0.0/255.0.0.0      ; Also RFC1918
648 ;      localnet=172.16.0.0/12           ; Another RFC1918 with CIDR notation
649 ;      localnet=169.254.0.0/255.255.0.0 ; Zero conf local network
650 ;
651 ; + the "externally visible" address and port number to be used when talking
652 ;   to a host outside the NAT. This information is derived by one of the
653 ;   following (mutually exclusive) config file parameters:
654 ;
655 ;   a. "externip = hostname[:port]" specifies a static address[:port] to
656 ;      be used in SIP and SDP messages.
657 ;      The hostname is looked up only once, when [re]loading sip.conf .
658 ;      If a port number is not present, use the "bindport" value (which is
659 ;      not guaranteed to work correctly, because a NAT box might remap the
660 ;      port number as well as the address).
661 ;      This approach can be useful if you have a NAT device where you can
662 ;      configure the mapping statically. Examples:
663 ;
664 ;        externip = 12.34.56.78          ; use this address.
665 ;        externip = 12.34.56.78:9900     ; use this address and port.
666 ;        externip = mynat.my.org:12600   ; Public address of my nat box.
667 ;        externtcpport = 9900   ; The externally mapped tcp port, when Asterisk is behind a static NAT or PAT. 
668 ;                               ; externtcpport will default to the externip or externhost port if either one is set. 
669 ;        externtlsport = 12600  ; The externally mapped tls port, when Asterisk is behind a static NAT or PAT.
670 ;                               ; externtlsport port will default to the RFC designated port of 5061.   
671 ;
672 ;   b. "externhost = hostname[:port]" is similar to "externip" except
673 ;      that the hostname is looked up every "externrefresh" seconds
674 ;      (default 10s). This can be useful when your NAT device lets you choose
675 ;      the port mapping, but the IP address is dynamic.
676 ;      Beware, you might suffer from service disruption when the name server
677 ;      resolution fails. Examples:
678 ;
679 ;        externhost=foo.dyndns.net       ; refreshed periodically
680 ;        externrefresh=180               ; change the refresh interval
681 ;
682 ;   c. "stunaddr = stun.server[:port]" queries the STUN server specified
683 ;      as an argument to obtain the external address/port.
684 ;      Queries are also sent periodically every "externrefresh" seconds
685 ;      (as a side effect, sending the query also acts as a keepalive for
686 ;      the state entry on the nat box):
687 ;
688 ;        stunaddr = foo.stun.com:3478
689 ;        externrefresh = 15
690 ;
691 ;   Note that at the moment all these mechanism work only for the SIP socket.
692 ;   The IP address discovered with externip/externhost/STUN is reused for
693 ;   media sessions as well, but the port numbers are not remapped so you
694 ;   may still experience problems.
695 ;
696 ; NOTE 1: in some cases, NAT boxes will use different port numbers in
697 ; the internal<->external mapping. In these cases, the "externip" and
698 ; "externhost" might not help you configure addresses properly, and you
699 ; really need to use STUN.
700 ;
701 ; NOTE 2: when using "externip" or "externhost", the address part is
702 ; also used as the external address for media sessions.
703 ; If you use "stunaddr", STUN queries will be sent to the same server
704 ; also from media sockets, and this should permit a correct mapping of
705 ; the port numbers as well.
706 ;
707 ; In addition to the above, Asterisk has an additional "nat" parameter to
708 ; address NAT-related issues in incoming SIP or media sessions.
709 ; In particular, depending on the 'nat= ' settings described below, Asterisk
710 ; may override the address/port information specified in the SIP/SDP messages,
711 ; and use the information (sender address) supplied by the network stack instead.
712 ; However, this is only useful if the external traffic can reach us.
713 ; The following settings are allowed (both globally and in individual sections):
714 ;
715 ;        nat = no                ; Default. Use rport if the remote side says to use it.
716 ;        nat = force_rport       ; Force rport to always be on.
717 ;        nat = yes               ; Force rport to always be on and perform comedia RTP handling.
718 ;        nat = comedia           ; Use rport if the remote side says to use it and perform comedia RTP handling.
719 ;
720 ; 'comedia RTP handling' refers to the technique of sending RTP to the port that the
721 ; the other endpoint's RTP arrived from, and means 'connection-oriented media'. This is
722 ; only partially related to RFC 4145 which was referred to as COMEDIA while it was in
723 ; draft form. This method is used to accomodate endpoints that may be located behind
724 ; NAT devices, and as such the port number they tell Asterisk to send RTP packets to
725 ; for their media streams is not actual port number that will be used on the nearer
726 ; side of the NAT.
727 ;
728 ; In addition to these settings, Asterisk *always* uses 'symmetric RTP' mode as defined by
729 ; RFC 4961; Asterisk will always send RTP packets from the same port number it expects
730 ; to receive them on.
731 ;
732 ; The IP address used for media (audio, video, and text) in the SDP can also be overridden by using
733 ; the media_address configuration option. This is only applicable to the general section and
734 ; can not be set per-user or per-peer.
735 ;
736 ; media_address = 172.16.42.1
737
738 ;----------------------------------- MEDIA HANDLING --------------------------------
739 ; By default, Asterisk tries to re-invite media streams to an optimal path. If there's
740 ; no reason for Asterisk to stay in the media path, the media will be redirected.
741 ; This does not really work well in the case where Asterisk is outside and the
742 ; clients are on the inside of a NAT. In that case, you want to set directmedia=nonat.
743 ;
744 ;directmedia=yes                ; Asterisk by default tries to redirect the
745                                 ; RTP media stream to go directly from
746                                 ; the caller to the callee.  Some devices do not
747                                 ; support this (especially if one of them is behind a NAT).
748                                 ; The default setting is YES. If you have all clients
749                                 ; behind a NAT, or for some other reason want Asterisk to
750                                 ; stay in the audio path, you may want to turn this off.
751
752                                 ; This setting also affect direct RTP
753                                 ; at call setup (a new feature in 1.4 - setting up the
754                                 ; call directly between the endpoints instead of sending
755                                 ; a re-INVITE).
756
757                                 ; Additionally this option does not disable all reINVITE operations.
758                                 ; It only controls Asterisk generating reINVITEs for the specific
759                                 ; purpose of setting up a direct media path. If a reINVITE is
760                                 ; needed to switch a media stream to inactive (when placed on
761                                 ; hold) or to T.38, it will still be done, regardless of this 
762                                 ; setting. Note that direct T.38 is not supported.
763
764 ;directmedia=nonat              ; An additional option is to allow media path redirection
765                                 ; (reinvite) but only when the peer where the media is being
766                                 ; sent is known to not be behind a NAT (as the RTP core can
767                                 ; determine it based on the apparent IP address the media
768                                 ; arrives from).
769
770 ;directmedia=update             ; Yet a third option... use UPDATE for media path redirection,
771                                 ; instead of INVITE. This can be combined with 'nonat', as
772                                 ; 'directmedia=update,nonat'. It implies 'yes'.
773
774 ;directrtpsetup=yes             ; Enable the new experimental direct RTP setup. This sets up
775                                 ; the call directly with media peer-2-peer without re-invites.
776                                 ; Will not work for video and cases where the callee sends
777                                 ; RTP payloads and fmtp headers in the 200 OK that does not match the
778                                 ; callers INVITE. This will also fail if directmedia is enabled when
779                                 ; the device is actually behind NAT.
780
781 ;ignoresdpversion=yes           ; By default, Asterisk will honor the session version
782                                 ; number in SDP packets and will only modify the SDP
783                                 ; session if the version number changes. This option will
784                                 ; force asterisk to ignore the SDP session version number
785                                 ; and treat all SDP data as new data.  This is required
786                                 ; for devices that send us non standard SDP packets
787                                 ; (observed with Microsoft OCS). By default this option is
788                                 ; off.
789
790 ;sdpsession=Asterisk PBX        ; Allows you to change the SDP session name string, (s=)
791                                 ; Like the useragent parameter, the default user agent string
792                                 ; also contains the Asterisk version.
793 ;sdpowner=root                  ; Allows you to change the username field in the SDP owner string, (o=)
794                                 ; This field MUST NOT contain spaces
795
796 ;----------------------------------------- REALTIME SUPPORT ------------------------
797 ; For additional information on ARA, the Asterisk Realtime Architecture,
798 ; please read realtime.txt and extconfig.txt in the /doc directory of the
799 ; source code.
800 ;
801 ;rtcachefriends=yes             ; Cache realtime friends by adding them to the internal list
802                                 ; just like friends added from the config file only on a
803                                 ; as-needed basis? (yes|no)
804
805 ;rtsavesysname=yes              ; Save systemname in realtime database at registration
806                                 ; Default= no
807
808 ;rtupdate=yes                   ; Send registry updates to database using realtime? (yes|no)
809                                 ; If set to yes, when a SIP UA registers successfully, the ip address,
810                                 ; the origination port, the registration period, and the username of
811                                 ; the UA will be set to database via realtime.
812                                 ; If not present, defaults to 'yes'. Note: realtime peers will
813                                 ; probably not function across reloads in the way that you expect, if
814                                 ; you turn this option off.
815 ;rtautoclear=yes                ; Auto-Expire friends created on the fly on the same schedule
816                                 ; as if it had just registered? (yes|no|<seconds>)
817                                 ; If set to yes, when the registration expires, the friend will
818                                 ; vanish from the configuration until requested again. If set
819                                 ; to an integer, friends expire within this number of seconds
820                                 ; instead of the registration interval.
821
822 ;ignoreregexpire=yes            ; Enabling this setting has two functions:
823                                 ;
824                                 ; For non-realtime peers, when their registration expires, the
825                                 ; information will _not_ be removed from memory or the Asterisk database
826                                 ; if you attempt to place a call to the peer, the existing information
827                                 ; will be used in spite of it having expired
828                                 ;
829                                 ; For realtime peers, when the peer is retrieved from realtime storage,
830                                 ; the registration information will be used regardless of whether
831                                 ; it has expired or not; if it expires while the realtime peer
832                                 ; is still in memory (due to caching or other reasons), the
833                                 ; information will not be removed from realtime storage
834
835 ;----------------------------------------- SIP DOMAIN SUPPORT ------------------------
836 ; Incoming INVITE and REFER messages can be matched against a list of 'allowed'
837 ; domains, each of which can direct the call to a specific context if desired.
838 ; By default, all domains are accepted and sent to the default context or the
839 ; context associated with the user/peer placing the call.
840 ; REGISTER to non-local domains will be automatically denied if a domain
841 ; list is configured.
842 ;
843 ; Domains can be specified using:
844 ; domain=<domain>[,<context>]
845 ; Examples:
846 ; domain=myasterisk.dom
847 ; domain=customer.com,customer-context
848 ;
849 ; In addition, all the 'default' domains associated with a server should be
850 ; added if incoming request filtering is desired.
851 ; autodomain=yes
852 ;
853 ; To disallow requests for domains not serviced by this server:
854 ; allowexternaldomains=no
855
856 ;domain=mydomain.tld,mydomain-incoming
857                                 ; Add domain and configure incoming context
858                                 ; for external calls to this domain
859 ;domain=1.2.3.4                 ; Add IP address as local domain
860                                 ; You can have several "domain" settings
861 ;allowexternaldomains=no        ; Disable INVITE and REFER to non-local domains
862                                 ; Default is yes
863 ;autodomain=yes                 ; Turn this on to have Asterisk add local host
864                                 ; name and local IP to domain list.
865
866 ; fromdomain=mydomain.tld       ; When making outbound SIP INVITEs to
867                                 ; non-peers, use your primary domain "identity"
868                                 ; for From: headers instead of just your IP
869                                 ; address. This is to be polite and
870                                 ; it may be a mandatory requirement for some
871                                 ; destinations which do not have a prior
872                                 ; account relationship with your server.
873
874 ;------------------------------ JITTER BUFFER CONFIGURATION --------------------------
875 ; jbenable = yes              ; Enables the use of a jitterbuffer on the receiving side of a
876                               ; SIP channel. Defaults to "no". An enabled jitterbuffer will
877                               ; be used only if the sending side can create and the receiving
878                               ; side can not accept jitter. The SIP channel can accept jitter,
879                               ; thus a jitterbuffer on the receive SIP side will be used only
880                               ; if it is forced and enabled.
881
882 ; jbforce = no                ; Forces the use of a jitterbuffer on the receive side of a SIP
883                               ; channel. Defaults to "no".
884
885 ; jbmaxsize = 200             ; Max length of the jitterbuffer in milliseconds.
886
887 ; jbresyncthreshold = 1000    ; Jump in the frame timestamps over which the jitterbuffer is
888                               ; resynchronized. Useful to improve the quality of the voice, with
889                               ; big jumps in/broken timestamps, usually sent from exotic devices
890                               ; and programs. Defaults to 1000.
891
892 ; jbimpl = fixed              ; Jitterbuffer implementation, used on the receiving side of a SIP
893                               ; channel. Two implementations are currently available - "fixed"
894                               ; (with size always equals to jbmaxsize) and "adaptive" (with
895                               ; variable size, actually the new jb of IAX2). Defaults to fixed.
896
897 ; jbtargetextra = 40          ; This option only affects the jb when 'jbimpl = adaptive' is set.
898                               ; The option represents the number of milliseconds by which the new jitter buffer
899                               ; will pad its size. the default is 40, so without modification, the new
900                               ; jitter buffer will set its size to the jitter value plus 40 milliseconds.
901                               ; increasing this value may help if your network normally has low jitter,
902                               ; but occasionally has spikes.
903
904 ; jblog = no                  ; Enables jitterbuffer frame logging. Defaults to "no".
905 ;-----------------------------------------------------------------------------------
906
907 [authentication]
908 ; Global credentials for outbound calls, i.e. when a proxy challenges your
909 ; Asterisk server for authentication. These credentials override
910 ; any credentials in peer/register definition if realm is matched.
911 ;
912 ; This way, Asterisk can authenticate for outbound calls to other
913 ; realms. We match realm on the proxy challenge and pick an set of
914 ; credentials from this list
915 ; Syntax:
916 ;        auth = <user>:<secret>@<realm>
917 ;        auth = <user>#<md5secret>@<realm>
918 ; Example:
919 ;auth=mark:topsecret@digium.com
920 ;
921 ; You may also add auth= statements to [peer] definitions
922 ; Peer auth= override all other authentication settings if we match on realm
923
924 ;------------------------------------------------------------------------------
925 ; DEVICE CONFIGURATION
926 ;
927 ; The SIP channel has two types of devices, the friend and the peer.
928 ; * The type=friend is a device type that accepts both incoming and outbound calls,
929 ;   where Asterisk match on the From: username on incoming calls.
930 ;   (A synonym for friend is "user"). This is a type you use for your local
931 ;   SIP phones.
932 ; * The type=peer also handles both incoming and outbound calls. On inbound calls,
933 ;   Asterisk only matches on IP/port, not on names. This is mostly used for SIP
934 ;   trunks.
935 ;
936 ; For device names, we recommend using only a-z, numerics (0-9) and underscore
937 ;
938 ; For local phones, type=friend works most of the time
939 ;
940 ; If you have one-way audio, you probably have NAT problems.
941 ; If Asterisk is on a public IP, and the phone is inside of a NAT device
942 ; you will need to configure nat option for those phones.
943 ; Also, turn on qualify=yes to keep the nat session open
944 ;
945 ; Configuration options available
946 ; --------------------
947 ; context
948 ; callingpres
949 ; permit
950 ; deny
951 ; secret
952 ; md5secret
953 ; remotesecret
954 ; transport
955 ; dtmfmode
956 ; directmedia
957 ; nat
958 ; callgroup
959 ; pickupgroup
960 ; language
961 ; allow
962 ; disallow
963 ; insecure
964 ; trustrpid
965 ; progressinband
966 ; promiscredir
967 ; useclientcode
968 ; accountcode
969 ; setvar
970 ; callerid
971 ; amaflags
972 ; callcounter
973 ; busylevel
974 ; allowoverlap
975 ; allowsubscribe
976 ; allowtransfer
977 ; ignoresdpversion
978 ; subscribecontext
979 ; template
980 ; videosupport
981 ; maxcallbitrate
982 ; rfc2833compensate
983 ; mailbox
984 ; session-timers
985 ; session-expires
986 ; session-minse
987 ; session-refresher
988 ; t38pt_usertpsource
989 ; regexten
990 ; fromdomain
991 ; fromuser
992 ; host
993 ; port
994 ; qualify
995 ; defaultip
996 ; defaultuser
997 ; rtptimeout
998 ; rtpholdtimeout
999 ; sendrpid
1000 ; outboundproxy
1001 ; rfc2833compensate
1002 ; callbackextension
1003 ; registertrying
1004 ; timert1
1005 ; timerb
1006 ; qualifyfreq
1007 ; t38pt_usertpsource
1008 ; contactpermit         ; Limit what a host may register as (a neat trick
1009 ; contactdeny           ; is to register at the same IP as a SIP provider,
1010 ;                       ; then call oneself, and get redirected to that
1011 ;                       ; same location).
1012 ; unsolicited_mailbox
1013 ; use_q850_reason
1014
1015 ;[sip_proxy]
1016 ; For incoming calls only. Example: FWD (Free World Dialup)
1017 ; We match on IP address of the proxy for incoming calls
1018 ; since we can not match on username (caller id)
1019 ;type=peer
1020 ;context=from-fwd
1021 ;host=fwd.pulver.com
1022
1023 ;[sip_proxy-out]
1024 ;type=peer                        ; we only want to call out, not be called
1025 ;remotesecret=guessit             ; Our password to their service
1026 ;defaultuser=yourusername         ; Authentication user for outbound proxies
1027 ;fromuser=yourusername            ; Many SIP providers require this!
1028 ;fromdomain=provider.sip.domain
1029 ;host=box.provider.com
1030 ;transport=udp,tcp                ; This sets the default transport type to udp for outgoing, and will
1031 ;                                 ; accept both tcp and udp. The default transport type is only used for
1032 ;                                 ; outbound messages until a Registration takes place.  During the
1033 ;                                 ; peer Registration the transport type may change to another supported
1034 ;                                 ; type if the peer requests so.
1035
1036 ;usereqphone=yes                  ; This provider requires ";user=phone" on URI
1037 ;callcounter=yes                  ; Enable call counter
1038 ;busylevel=2                      ; Signal busy at 2 or more calls
1039 ;outboundproxy=proxy.provider.domain  ; send outbound signaling to this proxy, not directly to the peer
1040 ;port=80                          ; The port number we want to connect to on the remote side
1041                                   ; Also used as "defaultport" in combination with "defaultip" settings
1042
1043 ;--- sample definition for a provider
1044 ;[provider1]
1045 ;type=peer
1046 ;host=sip.provider1.com
1047 ;fromuser=4015552299              ; how your provider knows you
1048 ;remotesecret=youwillneverguessit ; The password we use to authenticate to them
1049 ;secret=gissadetdu                ; The password they use to contact us
1050 ;callbackextension=123            ; Register with this server and require calls coming back to this extension
1051 ;transport=udp,tcp                ; This sets the transport type to udp for outgoing, and will
1052 ;                                 ;   accept both tcp and udp. Default is udp. The first transport
1053 ;                                 ;   listed will always be used for outgoing connections.
1054 ;unsolicited_mailbox=4015552299   ; If the remote SIP server sends an unsolicited MWI NOTIFY message the new/old
1055 ;                                 ;   message count will be stored in the configured virtual mailbox. It can be used
1056 ;                                 ;   by any device supporting MWI by specifying <configured value>@SIP_Remote as the
1057 ;                                 ;   mailbox.
1058
1059 ;
1060 ; Because you might have a large number of similar sections, it is generally
1061 ; convenient to use templates for the common parameters, and add them
1062 ; the the various sections. Examples are below, and we can even leave
1063 ; the templates uncommented as they will not harm:
1064
1065 [basic-options](!)                ; a template
1066         dtmfmode=rfc2833
1067         context=from-office
1068         type=friend
1069
1070 [natted-phone](!,basic-options)   ; another template inheriting basic-options
1071         nat=yes
1072         directmedia=no
1073         host=dynamic
1074
1075 [public-phone](!,basic-options)   ; another template inheriting basic-options
1076         nat=no
1077         directmedia=yes
1078
1079 [my-codecs](!)                    ; a template for my preferred codecs
1080         disallow=all
1081         allow=ilbc
1082         allow=g729
1083         allow=gsm
1084         allow=g723
1085         allow=ulaw
1086
1087 [ulaw-phone](!)                   ; and another one for ulaw-only
1088         disallow=all
1089         allow=ulaw
1090
1091 ; and finally instantiate a few phones
1092 ;
1093 ; [2133](natted-phone,my-codecs)
1094 ;        secret = peekaboo
1095 ; [2134](natted-phone,ulaw-phone)
1096 ;        secret = not_very_secret
1097 ; [2136](public-phone,ulaw-phone)
1098 ;        secret = not_very_secret_either
1099 ; ...
1100 ;
1101
1102 ; Standard configurations not using templates look like this:
1103 ;
1104 ;[grandstream1]
1105 ;type=friend
1106 ;context=from-sip                ; Where to start in the dialplan when this phone calls
1107 ;callerid=John Doe <1234>        ; Full caller ID, to override the phones config
1108                                  ; on incoming calls to Asterisk
1109 ;host=192.168.0.23               ; we have a static but private IP address
1110                                  ; No registration allowed
1111 ;nat=no                          ; there is not NAT between phone and Asterisk
1112 ;directmedia=yes                 ; allow RTP voice traffic to bypass Asterisk
1113 ;dtmfmode=info                   ; either RFC2833 or INFO for the BudgeTone
1114 ;call-limit=1                    ; permit only 1 outgoing call and 1 incoming call at a time
1115                                  ; from the phone to asterisk (deprecated)
1116                                  ; 1 for the explicit peer, 1 for the explicit user,
1117                                  ; remember that a friend equals 1 peer and 1 user in
1118                                  ; memory
1119                                  ; There is no combined call counter for a "friend"
1120                                  ; so there's currently no way in sip.conf to limit
1121                                  ; to one inbound or outbound call per phone. Use
1122                                  ; the group counters in the dial plan for that.
1123                                  ;
1124 ;mailbox=1234@default            ; mailbox 1234 in voicemail context "default"
1125 ;disallow=all                    ; need to disallow=all before we can use allow=
1126 ;allow=ulaw                      ; Note: In user sections the order of codecs
1127                                  ; listed with allow= does NOT matter!
1128 ;allow=alaw
1129 ;allow=g723.1                    ; Asterisk only supports g723.1 pass-thru!
1130 ;allow=g729                      ; Pass-thru only unless g729 license obtained
1131 ;callingpres=allowed_passed_screen ; Set caller ID presentation
1132                                  ; See README.callingpres for more information
1133
1134 ;[xlite1]
1135 ; Turn off silence suppression in X-Lite ("Transmit Silence"=YES)!
1136 ; Note that Xlite sends NAT keep-alive packets, so qualify=yes is not needed
1137 ;type=friend
1138 ;regexten=1234                   ; When they register, create extension 1234
1139 ;callerid="Jane Smith" <5678>
1140 ;host=dynamic                    ; This device needs to register
1141 ;nat=yes                         ; X-Lite is behind a NAT router
1142 ;directmedia=no                  ; Typically set to NO if behind NAT
1143 ;disallow=all
1144 ;allow=gsm                       ; GSM consumes far less bandwidth than ulaw
1145 ;allow=ulaw
1146 ;allow=alaw
1147 ;mailbox=1234@default,1233@default ; Subscribe to status of multiple mailboxes
1148 ;registertrying=yes              ; Send a 100 Trying when the device registers.
1149
1150 ;[snom]
1151 ;type=friend                     ; Friends place calls and receive calls
1152 ;context=from-sip                ; Context for incoming calls from this user
1153 ;secret=blah
1154 ;subscribecontext=localextensions ; Only allow SUBSCRIBE for local extensions
1155 ;language=de                     ; Use German prompts for this user
1156 ;host=dynamic                    ; This peer register with us
1157 ;dtmfmode=inband                 ; Choices are inband, rfc2833, or info
1158 ;defaultip=192.168.0.59          ; IP used until peer registers
1159 ;mailbox=1234@context,2345       ; Mailbox(-es) for message waiting indicator
1160 ;subscribemwi=yes                ; Only send notifications if this phone
1161                                  ; subscribes for mailbox notification
1162 ;vmexten=voicemail               ; dialplan extension to reach mailbox
1163                                  ; sets the Message-Account in the MWI notify message
1164                                  ; defaults to global vmexten which defaults to "asterisk"
1165 ;disallow=all
1166 ;allow=ulaw                      ; dtmfmode=inband only works with ulaw or alaw!
1167
1168
1169 ;[polycom]
1170 ;type=friend                     ; Friends place calls and receive calls
1171 ;context=from-sip                ; Context for incoming calls from this user
1172 ;secret=blahpoly
1173 ;host=dynamic                    ; This peer register with us
1174 ;dtmfmode=rfc2833                ; Choices are inband, rfc2833, or info
1175 ;defaultuser=polly               ; Username to use in INVITE until peer registers
1176 ;defaultip=192.168.40.123
1177                                  ; Normally you do NOT need to set this parameter
1178 ;disallow=all
1179 ;allow=ulaw                      ; dtmfmode=inband only works with ulaw or alaw!
1180 ;progressinband=no               ; Polycom phones don't work properly with "never"
1181
1182
1183 ;[pingtel]
1184 ;type=friend
1185 ;secret=blah
1186 ;host=dynamic
1187 ;insecure=port                   ; Allow matching of peer by IP address without
1188                                  ; matching port number
1189 ;insecure=invite                 ; Do not require authentication of incoming INVITEs
1190 ;insecure=port,invite            ; (both)
1191 ;qualify=1000                    ; Consider it down if it's 1 second to reply
1192                                  ; Helps with NAT session
1193                                  ; qualify=yes uses default value
1194 ;qualifyfreq=60                  ; Qualification: How often to check for the
1195                                  ; host to be up in seconds
1196                                  ; Set to low value if you use low timeout for
1197                                  ; NAT of UDP sessions
1198 ;
1199 ; Call group and Pickup group should be in the range from 0 to 63
1200 ;
1201 ;callgroup=1,3-4                 ; We are in caller groups 1,3,4
1202 ;pickupgroup=1,3-5               ; We can do call pick-p for call group 1,3,4,5
1203 ;defaultip=192.168.0.60          ; IP address to use if peer has not registered
1204 ;deny=0.0.0.0/0.0.0.0            ; ACL: Control access to this account based on IP address
1205 ;permit=192.168.0.60/255.255.255.0
1206 ;permit=192.168.0.60/24          ; we can also use CIDR notation for subnet masks
1207
1208 ;[cisco1]
1209 ;type=friend
1210 ;secret=blah
1211 ;qualify=200                     ; Qualify peer is no more than 200ms away
1212 ;nat=yes                         ; This phone may be natted
1213                                  ; Send SIP and RTP to the IP address that packet is
1214                                  ; received from instead of trusting SIP headers
1215 ;host=dynamic                    ; This device registers with us
1216 ;directmedia=no                  ; Asterisk by default tries to redirect the
1217                                  ; RTP media stream (audio) to go directly from
1218                                  ; the caller to the callee.  Some devices do not
1219                                  ; support this (especially if one of them is
1220                                  ; behind a NAT).
1221 ;defaultip=192.168.0.4           ; IP address to use until registration
1222 ;defaultuser=goran               ; Username to use when calling this device before registration
1223                                  ; Normally you do NOT need to set this parameter
1224 ;setvar=CUSTID=5678              ; Channel variable to be set for all calls from or to this device
1225 ;setvar=ATTENDED_TRANSFER_COMPLETE_SOUND=beep   ; This channel variable will
1226                                                 ; cause the given audio file to
1227                                                 ; be played upon completion of
1228                                                 ; an attended transfer.
1229
1230 ;[pre14-asterisk]
1231 ;type=friend
1232 ;secret=digium
1233 ;host=dynamic
1234 ;rfc2833compensate=yes          ; Compensate for pre-1.4 DTMF transmission from another Asterisk machine.
1235                                 ; You must have this turned on or DTMF reception will work improperly.
1236 ;t38pt_usertpsource=yes         ; Use the source IP address of RTP as the destination IP address for UDPTL packets
1237                                 ; if the nat option is enabled. If a single RTP packet is received Asterisk will know the
1238                                 ; external IP address of the remote device. If port forwarding is done at the client side
1239                                 ; then UDPTL will flow to the remote device.