note that group assignments must be from 0 to 63 (issue #7048)
[asterisk/asterisk.git] / configs / sip.conf.sample
1 ;
2 ; SIP Configuration example for Asterisk
3 ;
4 ; Syntax for specifying a SIP device in extensions.conf is
5 ; SIP/devicename where devicename is defined in a section below.
6 ;
7 ; You may also use 
8 ; SIP/username@domain to call any SIP user on the Internet
9 ; (Don't forget to enable DNS SRV records if you want to use this)
10
11 ; If you define a SIP proxy as a peer below, you may call
12 ; SIP/proxyhostname/user or SIP/user@proxyhostname 
13 ; where the proxyhostname is defined in a section below 
14
15 ; Useful CLI commands to check peers/users:
16 ;   sip show peers              Show all SIP peers (including friends)
17 ;   sip show users              Show all SIP users (including friends)
18 ;   sip show registry           Show status of hosts we register with
19 ;
20 ;   sip debug                   Show all SIP messages
21 ;
22 ;   reload chan_sip.so          Reload configuration file
23 ;                               Active SIP peers will not be reconfigured
24 ;
25
26 [general]
27 context=default                 ; Default context for incoming calls
28 ;allowguest=no                  ; Allow or reject guest calls (default is yes, 
29                                 ; this can also be set to 'osp'
30                                 ; if asterisk was compiled with OSP support.)
31 allowoverlap=no                 ; Disable overlap dialing support. (Default is yes)
32 ;allowsubscribe=no              ; Disable support for subscriptions. (Default is yes)
33 ;realm=mydomain.tld             ; Realm for digest authentication
34                                 ; defaults to "asterisk"
35                                 ; Realms MUST be globally unique according to RFC 3261
36                                 ; Set this to your host name or domain name
37 bindport=5060                   ; UDP Port to bind to (SIP standard port is 5060)
38 bindaddr=0.0.0.0                ; IP address to bind to (0.0.0.0 binds to all)
39 srvlookup=yes                   ; Enable DNS SRV lookups on outbound calls
40                                 ; Note: Asterisk only uses the first host 
41                                 ; in SRV records
42                                 ; Disabling DNS SRV lookups disables the 
43                                 ; ability to place SIP calls based on domain 
44                                 ; names to some other SIP users on the Internet
45                                 
46 ;domain=mydomain.tld            ; Set default domain for this host
47                                 ; If configured, Asterisk will only allow
48                                 ; INVITE and REFER to non-local domains
49                                 ; Use "sip show domains" to list local domains
50 ;domain=mydomain.tld,mydomain-incoming
51                                 ; Add domain and configure incoming context
52                                 ; for external calls to this domain
53 ;domain=1.2.3.4                 ; Add IP address as local domain
54                                 ; You can have several "domain" settings
55 ;allowexternalinvites=no        ; Disable INVITE and REFER to non-local domains
56                                 ; Default is yes
57 ;autodomain=yes                 ; Turn this on to have Asterisk add local host
58                                 ; name and local IP to domain list.
59 ;pedantic=yes                   ; Enable checking of tags in headers, 
60                                 ; international character conversions in URIs
61                                 ; and multiline formatted headers for strict
62                                 ; SIP compatibility (defaults to "no")
63
64 ; See doc/README.tos for a description of these parameters.
65 ;tos_sip=cs3                    ; Sets TOS for SIP packets.
66 ;tos_audio=ef                   ; Sets TOS for RTP audio packets.
67 ;tos_video=af41                 ; Sets TOS for RTP video packets.
68
69 ;maxexpiry=3600                 ; Maximum allowed time of incoming registrations
70                                 ; and subscriptions (seconds)
71 ;minexpiry=60                   ; Minimum length of registrations/subscriptions (default 60)
72 ;defaultexpiry=120              ; Default length of incoming/outoing registration
73 ;t1min=100                      ; Minimum roundtrip time for messages to monitored hosts
74                                 ; Defaults to 100 ms
75 ;notifymimetype=text/plain      ; Allow overriding of mime type in MWI NOTIFY
76 ;checkmwi=10                    ; Default time between mailbox checks for peers
77 ;vmexten=voicemail              ; dialplan extension to reach mailbox sets the 
78                                 ; Message-Account in the MWI notify message 
79                                 ; defaults to "asterisk"
80 ;recordhistory=yes              ; Record SIP history by default 
81                                 ; (see sip history / sip no history)
82
83 ;disallow=all                   ; First disallow all codecs
84 ;allow=ulaw                     ; Allow codecs in order of preference
85 ;allow=ilbc                     ; 
86 ;musicclass=default             ; Sets the default music on hold class for all SIP calls
87                                 ; This may also be set for individual users/peers
88 ;language=en                    ; Default language setting for all users/peers
89                                 ; This may also be set for individual users/peers
90 ;relaxdtmf=yes                  ; Relax dtmf handling
91 ;rtptimeout=60                  ; Terminate call if 60 seconds of no RTP activity
92                                 ; when we're not on hold
93 ;rtpholdtimeout=300             ; Terminate call if 300 seconds of no RTP activity
94                                 ; when we're on hold (must be > rtptimeout)
95 ;trustrpid = no                 ; If Remote-Party-ID should be trusted
96 ;sendrpid = yes                 ; If Remote-Party-ID should be sent
97 ;progressinband=never           ; If we should generate in-band ringing always
98                                 ; use 'never' to never use in-band signalling, even in cases
99                                 ; where some buggy devices might not render it
100                                 ; Valid values: yes, no, never Default: never
101 ;useragent=Asterisk PBX         ; Allows you to change the user agent string
102 ;promiscredir = no              ; If yes, allows 302 or REDIR to non-local SIP address
103                                 ; Note that promiscredir when redirects are made to the
104                                 ; local system will cause loops since Asterisk is incapable
105                                 ; of performing a "hairpin" call.
106 ;usereqphone = no               ; If yes, ";user=phone" is added to uri that contains
107                                 ; a valid phone number
108 ;dtmfmode = rfc2833             ; Set default dtmfmode for sending DTMF. Default: rfc2833
109                                 ; Other options: 
110                                 ; info : SIP INFO messages
111                                 ; inband : Inband audio (requires 64 kbit codec -alaw, ulaw)
112                                 ; auto : Use rfc2833 if offered, inband otherwise
113
114 ;compactheaders = yes           ; send compact sip headers.
115 ;sipdebug = yes                 ; Turn on SIP debugging by default, from
116                                 ; the moment the channel loads this configuration
117 ;subscribecontext = default     ; Set a specific context for SUBSCRIBE requests
118                                 ; Useful to limit subscriptions to local extensions
119                                 ; Settable per peer/user also
120 ;notifyringing = yes            ; Notify subscriptions on RINGING state
121 ;
122 ;videosupport=yes               ; Turn on support for SIP video
123 ;maxcallbitrate=384             ; Maximum bitrate for video calls (default 384 kb/s)
124                                 ; Videosupport and maxcallbitrate is settable
125                                 ; for peers and users as well
126 ;callevents=no                  ; generate manager events when sip ua 
127                                 ; performs events (e.g. hold)
128
129 ;
130 ; If regcontext is specified, Asterisk will dynamically create and destroy a
131 ; NoOp priority 1 extension for a given peer who registers or unregisters with
132 ; us.  The actual extension is the 'regexten' parameter of the registering
133 ; peer or its name if 'regexten' is not provided.  More than one regexten may
134 ; be supplied if they are separated by '&'.  Patterns may be used in regexten.
135 ;
136 ;regcontext=sipregistrations
137 ;
138 ;----------------------------------------- OUTBOUND SIP REGISTRATIONS  ------------------------
139 ; Asterisk can register as a SIP user agent to a SIP proxy (provider)
140 ; Format for the register statement is:
141 ;       register => user[:secret[:authuser]]@host[:port][/extension]
142 ;
143 ; If no extension is given, the 's' extension is used. The extension needs to
144 ; be defined in extensions.conf to be able to accept calls from this SIP proxy
145 ; (provider).
146 ;
147 ; host is either a host name defined in DNS or the name of a section defined
148 ; below.
149 ;
150 ; Examples:
151 ;
152 ;register => 1234:password@mysipprovider.com    
153 ;
154 ;     This will pass incoming calls to the 's' extension
155 ;
156 ;
157 ;register => 2345:password@sip_proxy/1234
158 ;
159 ;    Register 2345 at sip provider 'sip_proxy'.  Calls from this provider
160 ;    connect to local extension 1234 in extensions.conf, default context,
161 ;    unless you configure a [sip_proxy] section below, and configure a
162 ;    context.
163 ;    Tip 1: Avoid assigning hostname to a sip.conf section like [provider.com]
164 ;    Tip 2: Use separate type=peer and type=user sections for SIP providers
165 ;           (instead of type=friend) if you have calls in both directions
166   
167 ;registertimeout=20             ; retry registration calls every 20 seconds (default)
168 ;registerattempts=10            ; Number of registration attempts before we give up
169                                 ; 0 = continue forever, hammering the other server
170                                 ; until it accepts the registration
171                                 ; Default is 0 tries, continue forever
172
173 ;----------------------------------------- NAT SUPPORT ------------------------
174 ; The externip, externhost and localnet settings are used if you use Asterisk
175 ; behind a NAT device to communicate with services on the outside.
176
177 ;externip = 200.201.202.203     ; Address that we're going to put in outbound SIP
178                                 ; messages if we're behind a NAT
179
180                                 ; The externip and localnet is used
181                                 ; when registering and communicating with other proxies
182                                 ; that we're registered with
183 ;externhost=foo.dyndns.net      ; Alternatively you can specify an 
184                                 ; external host, and Asterisk will 
185                                 ; perform DNS queries periodically.  Not
186                                 ; recommended for production 
187                                 ; environments!  Use externip instead
188 ;externrefresh=10               ; How often to refresh externhost if 
189                                 ; used
190                                 ; You may add multiple local networks.  A reasonable 
191                                 ; set of defaults are:
192 ;localnet=192.168.0.0/255.255.0.0; All RFC 1918 addresses are local networks
193 ;localnet=10.0.0.0/255.0.0.0    ; Also RFC1918
194 ;localnet=172.16.0.0/12         ; Another RFC1918 with CIDR notation
195 ;localnet=169.254.0.0/255.255.0.0 ;Zero conf local network
196
197 ; The nat= setting is used when Asterisk is on a public IP, communicating with
198 ; devices hidden behind a NAT device (broadband router).  If you have one-way
199 ; audio problems, you usually have problems with your NAT configuration or your
200 ; firewall's support of SIP+RTP ports.  You configure Asterisk choice of RTP
201 ; ports for incoming audio in rtp.conf
202 ;
203 ;nat=no                         ; Global NAT settings  (Affects all peers and users)
204                                 ; yes = Always ignore info and assume NAT
205                                 ; no = Use NAT mode only according to RFC3581 
206                                 ; never = Never attempt NAT mode or RFC3581 support
207                                 ; route = Assume NAT, don't send rport 
208                                 ; (work around more UNIDEN bugs)
209
210 ;canreinvite=yes                ; Asterisk by default tries to redirect the
211                                 ; RTP media stream (audio) to go directly from
212                                 ; the caller to the callee.  Some devices do not
213                                 ; support this (especially if one of them is 
214                                 ; behind a NAT).
215                                 ; The default setting is YES. If you have all clients
216                                 ; behind a NAT, or for some other reason wants
217                                 ; Asterisk to stay in the audio path,
218                                 ; you may want to turn this off
219
220 ;----------------------------------------- REALTIME SUPPORT ------------------------
221 ; For additional information on ARA, the Asterisk Realtime Architecture,
222 ; please read realtime.txt and extconfig.txt in the /doc directory of the
223 ; source code.
224 ;
225 ;rtcachefriends=yes             ; Cache realtime friends by adding them to the internal list
226                                 ; just like friends added from the config file only on a
227                                 ; as-needed basis? (yes|no)
228
229 ;rtupdate=yes                   ; Send registry updates to database using realtime? (yes|no)
230                                 ; If set to yes, when a SIP UA registers successfully, the ip address,
231                                 ; the origination port, the registration period, and the username of
232                                 ; the UA will be set to database via realtime. 
233                                 ; If not present, defaults to 'yes'.
234 ;rtautoclear=yes                ; Auto-Expire friends created on the fly on the same schedule
235                                 ; as if it had just registered? (yes|no|<seconds>)
236                                 ; If set to yes, when the registration expires, the friend will
237                                 ; vanish from the configuration until requested again. If set
238                                 ; to an integer, friends expire within this number of seconds
239                                 ; instead of the registration interval.
240
241 ;ignoreregexpire=yes            ; Enabling this setting has two functions:
242                                 ;
243                                 ; For non-realtime peers, when their registration expires, the
244                                 ; information will _not_ be removed from memory or the Asterisk database
245                                 ; if you attempt to place a call to the peer, the existing information
246                                 ; will be used in spiteof it having expired
247                                 ;
248                                 ; For realtime peers, when the peer is retrieved from realtime storage,
249                                 ; the registration information will be used regardless of whether
250                                 ; it has expired or not; if it expires while the realtime peer 
251                                 ; is still in memory (due to caching or other reasons), the 
252                                 ; information will not be removed from realtime storage
253
254 ;----------------------------------------- SIP DOMAIN SUPPORT ------------------------
255 ; Incoming INVITE and REFER messages can be matched against a list of 'allowed'
256 ; domains, each of which can direct the call to a specific context if desired.
257 ; By default, all domains are accepted and sent to the default context or the
258 ; context associated with the user/peer placing the call.
259 ; Domains can be specified using:
260 ; domain=<domain>[,<context>]
261 ; Examples:
262 ; domain=myasterisk.dom
263 ; domain=customer.com,customer-context
264 ;
265 ; In addition, all the 'default' domains associated with a server should be
266 ; added if incoming request filtering is desired.
267 ; autodomain=yes
268 ;
269 ; To disallow requests for domains not serviced by this server:
270 ; allowexternaldomains=no
271
272 ; fromdomain=mydomain.tld ; When making outbound SIP INVITEs to
273                           ; non-peers, use your primary domain "identity"
274                           ; for From: headers instead of just your IP
275                           ; address. This is to be polite and
276                           ; it may be a mandatory requirement for some
277                           ; destinations which do not have a prior
278                           ; account relationship with your server. 
279
280 [authentication]
281 ; Global credentials for outbound calls, i.e. when a proxy challenges your
282 ; Asterisk server for authentication. These credentials override
283 ; any credentials in peer/register definition if realm is matched.
284 ;
285 ; This way, Asterisk can authenticate for outbound calls to other
286 ; realms. We match realm on the proxy challenge and pick an set of 
287 ; credentials from this list
288 ; Syntax:
289 ;       auth = <user>:<secret>@<realm>
290 ;       auth = <user>#<md5secret>@<realm>
291 ; Example:
292 ;auth=mark:topsecret@digium.com
293
294 ; You may also add auth= statements to [peer] definitions 
295 ; Peer auth= override all other authentication settings if we match on realm
296
297 ;------------------------------------------------------------------------------
298 ; Users and peers have different settings available. Friends have all settings,
299 ; since a friend is both a peer and a user
300 ;
301 ; User config options:        Peer configuration:
302 ; --------------------        -------------------
303 ; context                     context
304 ; callingpres                 callingpres
305 ; permit                      permit
306 ; deny                        deny
307 ; secret                      secret
308 ; md5secret                   md5secret
309 ; dtmfmode                    dtmfmode
310 ; canreinvite                 canreinvite
311 ; nat                         nat
312 ; callgroup                   callgroup
313 ; pickupgroup                 pickupgroup
314 ; language                    language
315 ; allow                       allow
316 ; disallow                    disallow
317 ; insecure                    insecure
318 ; trustrpid                   trustrpid
319 ; progressinband              progressinband
320 ; promiscredir                promiscredir
321 ; useclientcode               useclientcode
322 ; accountcode                 accountcode
323 ; setvar                      setvar
324 ; callerid                    callerid
325 ; amaflags                    amaflags
326 ; call-limit                  call-limit
327 ; restrictcid                 restrictcid
328 ; allowoverlap                allowoverlap
329 ; allowsubscribe              allowsubscribe
330 ; subscribecontext            subscribecontext
331 ; videosupport                videosupport
332 ; maxcallbitrate              maxcallbitrate
333 ;                             mailbox
334 ;                             username
335 ;                             template
336 ;                             fromdomain
337 ;                             regexten
338 ;                             fromuser
339 ;                             host
340 ;                             port
341 ;                             qualify
342 ;                             defaultip
343 ;                             rtptimeout
344 ;                             rtpholdtimeout
345 ;                             sendrpid
346
347 ;[sip_proxy]
348 ; For incoming calls only. Example: FWD (Free World Dialup)
349 ; We match on IP address of the proxy for incoming calls 
350 ; since we can not match on username (caller id)
351 ;type=peer
352 ;context=from-fwd
353 ;host=fwd.pulver.com
354
355 ;[sip_proxy-out]
356 ;type=peer                      ; we only want to call out, not be called
357 ;secret=guessit
358 ;username=yourusername          ; Authentication user for outbound proxies
359 ;fromuser=yourusername          ; Many SIP providers require this!
360 ;fromdomain=provider.sip.domain 
361 ;host=box.provider.com
362 ;usereqphone=yes                ; This provider requires ";user=phone" on URI
363 ;call-limit=5                   ; permit only 5 simultaneous outgoing calls to this peer
364                                 ; Call-limits will not be enforced on real-time peers,
365                                 ; since they are not stored in-memory
366
367 ;------------------------------------------------------------------------------
368 ; Definitions of locally connected SIP devices
369 ;
370 ; type = user   a device that authenticates to us by "from" field to place calls
371 ; type = peer   a device we place calls to or that calls us and we match by host
372 ; type = friend two configurations (peer+user) in one
373 ;
374 ; For device names, we recommend using only a-z, numerics (0-9) and underscore
375
376 ; For local phones, type=friend works most of the time
377 ;
378 ; If you have one-way audio, you propably have NAT problems. 
379 ; If Asterisk is on a public IP, and the phone is inside of a NAT device
380 ; you will need to configure nat option for those phones.
381 ; Also, turn on qualify=yes to keep the nat session open
382
383 ;[grandstream1]
384 ;type=friend                    
385 ;context=from-sip               ; Where to start in the dialplan when this phone calls
386 ;callerid=John Doe <1234>       ; Full caller ID, to override the phones config
387                                 ; on incoming calls to Asterisk
388 ;host=192.168.0.23              ; we have a static but private IP address
389                                 ; No registration allowed
390 ;nat=no                         ; there is not NAT between phone and Asterisk
391 ;canreinvite=yes                ; allow RTP voice traffic to bypass Asterisk
392 ;dtmfmode=info                  ; either RFC2833 or INFO for the BudgeTone
393 ;call-limit=1                   ; permit only 1 outgoing call and 1 incoming call at a time
394                                 ; from the phone to asterisk
395                                 ; 1 for the explicit peer, 1 for the explicit user,
396                                 ; remember that a friend equals 1 peer and 1 user in
397                                 ; memory
398                                 ; This will affect your subscriptions as well.
399                                 ; There is no combined call counter for a "friend"
400                                 ; so there's currently no way in sip.conf to limit
401                                 ; to one inbound or outbound call per phone. Use
402                                 ; the group counters in the dial plan for that.
403                                 ;
404 ;mailbox=1234@default           ; mailbox 1234 in voicemail context "default"
405 ;disallow=all                   ; need to disallow=all before we can use allow=
406 ;allow=ulaw                     ; Note: In user sections the order of codecs
407                                 ; listed with allow= does NOT matter!
408 ;allow=alaw
409 ;allow=g723.1                   ; Asterisk only supports g723.1 pass-thru!
410 ;allow=g729                     ; Pass-thru only unless g729 license obtained
411 ;astdb=chan2ext/SIP/grandstream1=1234   ; ensures an astDB entry exists
412 ;callingpres=allowed_passed_screen      ; Set caller ID presentation
413                                 ; See README.callingpres for more information
414
415
416 ;[xlite1]
417 ; Turn off silence suppression in X-Lite ("Transmit Silence"=YES)!
418 ; Note that Xlite sends NAT keep-alive packets, so qualify=yes is not needed
419 ;type=friend
420 ;regexten=1234                  ; When they register, create extension 1234
421 ;callerid="Jane Smith" <5678>
422 ;host=dynamic                   ; This device needs to register
423 ;nat=yes                        ; X-Lite is behind a NAT router
424 ;canreinvite=no                 ; Typically set to NO if behind NAT
425 ;disallow=all
426 ;allow=gsm                      ; GSM consumes far less bandwidth than ulaw
427 ;allow=ulaw
428 ;allow=alaw
429 ;mailbox=1234@default,1233@default      ; Subscribe to status of multiple mailboxes
430
431
432 ;[snom]
433 ;type=friend                    ; Friends place calls and receive calls
434 ;context=from-sip               ; Context for incoming calls from this user
435 ;secret=blah
436 ;subscribecontext=localextensions       ; Only allow SUBSCRIBE for local extensions
437 ;language=de                    ; Use German prompts for this user 
438 ;host=dynamic                   ; This peer register with us
439 ;dtmfmode=inband                ; Choices are inband, rfc2833, or info
440 ;defaultip=192.168.0.59         ; IP used until peer registers
441 ;mailbox=1234@context,2345      ; Mailbox(-es) for message waiting indicator
442 ;subscribemwi=yes               ; Only send notifications if this phone 
443                                 ; subscribes for mailbox notification
444 ;vmexten=voicemail              ; dialplan extension to reach mailbox 
445                                 ; sets the Message-Account in the MWI notify message
446                                 ; defaults to global vmexten which defaults to "asterisk"
447 ;restrictcid=yes                ; To have the callerid restriced -> sent as ANI
448 ;disallow=all
449 ;allow=ulaw                     ; dtmfmode=inband only works with ulaw or alaw!
450
451
452 ;[polycom]
453 ;type=friend                    ; Friends place calls and receive calls
454 ;context=from-sip               ; Context for incoming calls from this user
455 ;secret=blahpoly
456 ;host=dynamic                   ; This peer register with us
457 ;dtmfmode=rfc2833               ; Choices are inband, rfc2833, or info
458 ;username=polly                 ; Username to use in INVITE until peer registers
459                                 ; Normally you do NOT need to set this parameter
460 ;disallow=all
461 ;allow=ulaw                     ; dtmfmode=inband only works with ulaw or alaw!
462 ;progressinband=no              ; Polycom phones don't work properly with "never"
463
464
465 ;[pingtel]
466 ;type=friend
467 ;secret=blah
468 ;host=dynamic
469 ;insecure=port                  ; Allow matching of peer by IP address without 
470                                 ; matching port number
471 ;insecure=invite                ; Do not require authentication of incoming INVITEs
472 ;insecure=port,invite           ; (both)
473 ;qualify=1000                   ; Consider it down if it's 1 second to reply
474                                 ; Helps with NAT session
475                                 ; qualify=yes uses default value
476 ;
477 ; Call group and Pickup group should be in the range from 0 to 63
478 ;
479 ;callgroup=1,3-4                ; We are in caller groups 1,3,4
480 ;pickupgroup=1,3-5              ; We can do call pick-p for call group 1,3,4,5
481 ;defaultip=192.168.0.60         ; IP address to use if peer has not registred
482
483 ;[cisco1]
484 ;type=friend
485 ;secret=blah
486 ;qualify=200                    ; Qualify peer is no more than 200ms away
487 ;nat=yes                        ; This phone may be natted
488                                 ; Send SIP and RTP to the IP address that packet is 
489                                 ; received from instead of trusting SIP headers 
490 ;host=dynamic                   ; This device registers with us
491 ;canreinvite=no                 ; Asterisk by default tries to redirect the
492                                 ; RTP media stream (audio) to go directly from
493                                 ; the caller to the callee.  Some devices do not
494                                 ; support this (especially if one of them is 
495                                 ; behind a NAT).
496 ;defaultip=192.168.0.4          ; IP address to use until registration
497 ;username=goran                 ; Username to use when calling this device before registration
498                                 ; Normally you do NOT need to set this parameter
499 ;setvar=CUSTID=5678             ; Channel variable to be set for all calls from this device
500