2 ; SIP Configuration example for Asterisk
5 ;-----------------------------------------------------------
6 ; In the dialplan (extensions.conf) you can use several
7 ; syntaxes for dialing SIP devices.
9 ; SIP/username@domain (SIP uri)
10 ; SIP/username[:password[:md5secret[:authname[:transport]]]]@host[:port]
11 ; SIP/devicename/extension
15 ; devicename is defined as a peer in a section below.
18 ; Call any SIP user on the Internet
19 ; (Don't forget to enable DNS SRV records if you want to use this)
21 ; devicename/extension
22 ; If you define a SIP proxy as a peer below, you may call
23 ; SIP/proxyhostname/user or SIP/user@proxyhostname
24 ; where the proxyhostname is defined in a section below
25 ; This syntax also works with ATA's with FXO ports
27 ; SIP/username[:password[:md5secret[:authname]]]@host[:port]
28 ; This form allows you to specify password or md5secret and authname
29 ; without altering any authentication data in config.
33 ; SIP/sales:topsecret::account02@domain.com:5062
34 ; SIP/12345678::bc53f0ba8ceb1ded2b70e05c3f91de4f:myname@192.168.0.1
36 ; All of these dial strings specify the SIP request URI.
37 ; In addition, you can specify a specific To: header by adding an
38 ; exclamation mark after the dial string, like
40 ; SIP/sales@mysipproxy!sales@edvina.net
43 ; -------------------------------------------------------------
44 ; Useful CLI commands to check peers/users:
45 ; sip show peers Show all SIP peers (including friends)
46 ; sip show registry Show status of hosts we register with
48 ; sip set debug on Show all SIP messages
50 ; module reload chan_sip.so Reload configuration file
52 ;------- Naming devices ------------------------------------------------------
54 ; When naming devices, make sure you understand how Asterisk matches calls
56 ; 1. Asterisk checks the SIP From: address username and matches against
57 ; names of devices with type=user
58 ; The name is the text between square brackets [name]
59 ; 2. Asterisk checks the From: addres and matches the list of devices
61 ; 3. Asterisk checks the IP address (and port number) that the INVITE
62 ; was sent from and matches against any devices with type=peer
64 ; Don't mix extensions with the names of the devices. Devices need a unique
65 ; name. The device name is *not* used as phone numbers. Phone numbers are
66 ; anything you declare as an extension in the dialplan (extensions.conf).
68 ; When setting up trunks, make sure there's no risk that any From: username
69 ; (caller ID) will match any of your device names, because then Asterisk
70 ; might match the wrong device.
72 ; Note: The parameter "username" is not the username and in most cases is
73 ; not needed at all. Check below. In later releases, it's renamed
74 ; to "defaultuser" which is a better name, since it is used in
75 ; combination with the "defaultip" setting.
76 ;-----------------------------------------------------------------------------
78 ; ** Deprecated configuration options **
79 ; The "call-limit" configuation option is deprecated. It still works in
80 ; this version of Asterisk, but will disappear in the next version.
81 ; You are encouraged to use the dialplan groupcount functionality
82 ; to enforce call limits instead of using this channel-specific method.
84 ; You can still set limits per device in sip.conf or in a database by using
85 ; "setvar" to set variables that can be used in the dialplan for various limits.
88 context=default ; Default context for incoming calls
89 ;allowguest=no ; Allow or reject guest calls (default is yes)
90 ;match_auth_username=yes ; if available, match user entry using the
91 ; 'username' field from the authentication line
92 ; instead of the From: field.
93 allowoverlap=no ; Disable overlap dialing support. (Default is yes)
94 ;allowtransfer=no ; Disable all transfers (unless enabled in peers or users)
96 ;realm=mydomain.tld ; Realm for digest authentication
97 ; defaults to "asterisk". If you set a system name in
98 ; asterisk.conf, it defaults to that system name
99 ; Realms MUST be globally unique according to RFC 3261
100 ; Set this to your host name or domain name
101 udpbindaddr=0.0.0.0 ; IP address to bind UDP listen socket to (0.0.0.0 binds to all)
102 ; Optionally add a port number, 192.168.1.1:5062 (default is port 5060)
105 ; Note that the TCP and TLS support for chan_sip is currently considered
106 ; experimental. Since it is new, all of the related configuration options are
107 ; subject to change in any release. If they are changed, the changes will
108 ; be reflected in this sample configuration file, as well as in the UPGRADE.txt file.
110 tcpenable=no ; Enable server for incoming TCP connections (default is no)
111 tcpbindaddr=0.0.0.0 ; IP address for TCP server to bind to (0.0.0.0 binds to all interfaces)
112 ; Optionally add a port number, 192.168.1.1:5062 (default is port 5060)
114 ;tlsenable=no ; Enable server for incoming TLS (secure) connections (default is no)
115 ;tlsbindaddr=0.0.0.0 ; IP address for TLS server to bind to (0.0.0.0) binds to all interfaces)
116 ; Optionally add a port number, 192.168.1.1:5063 (default is port 5061)
117 ; Remember that the IP address must match the common name (hostname) in the
118 ; certificate, so you don't want to bind a TLS socket to multiple IP addresses.
120 ;tlscertfile=</path/to/certificate.pem> ; Certificate file (*.pem only) to use for TLS connections
121 ; default is to look for "asterisk.pem" in current directory
123 ;tlsprivatekey=</path/to/private.pem> ; Private key file (*.pem only) for TLS connections.
124 ; If no tlsprivatekey is specified, tlscertfile is searched for
125 ; for both public and private key.
127 ;tlscafile=</path/to/certificate>
128 ; If the server your connecting to uses a self signed certificate
129 ; you should have their certificate installed here so the code can
130 ; verify the authenticity of their certificate.
132 ;tlscadir=</path/to/ca/dir>
133 ; A directory full of CA certificates. The files must be named with
134 ; the CA subject name hash value.
135 ; (see man SSL_CTX_load_verify_locations for more info)
137 ;tlsdontverifyserver=[yes|no]
138 ; If set to yes, don't verify the servers certificate when acting as
139 ; a client. If you don't have the server's CA certificate you can
140 ; set this and it will connect without requiring tlscafile to be set.
143 ;tlscipher=<SSL cipher string>
144 ; A string specifying which SSL ciphers to use or not use
145 ; A list of valid SSL cipher strings can be found at:
146 ; http://www.openssl.org/docs/apps/ciphers.html#CIPHER_STRINGS
148 srvlookup=yes ; Enable DNS SRV lookups on outbound calls
149 ; Note: Asterisk only uses the first host
151 ; Disabling DNS SRV lookups disables the
152 ; ability to place SIP calls based on domain
153 ; names to some other SIP users on the Internet
155 ;pedantic=yes ; Enable checking of tags in headers,
156 ; international character conversions in URIs
157 ; and multiline formatted headers for strict
158 ; SIP compatibility (defaults to "no")
160 ; See qos.tex or Quality of Service section of asterisk.pdf for a description of these parameters.
161 ;tos_sip=cs3 ; Sets TOS for SIP packets.
162 ;tos_audio=ef ; Sets TOS for RTP audio packets.
163 ;tos_video=af41 ; Sets TOS for RTP video packets.
164 ;tos_text=af41 ; Sets TOS for RTP text packets.
166 ;cos_sip=3 ; Sets 802.1p priority for SIP packets.
167 ;cos_audio=5 ; Sets 802.1p priority for RTP audio packets.
168 ;cos_video=4 ; Sets 802.1p priority for RTP video packets.
169 ;cos_text=3 ; Sets 802.1p priority for RTP text packets.
171 ;maxexpiry=3600 ; Maximum allowed time of incoming registrations
172 ; and subscriptions (seconds)
173 ;minexpiry=60 ; Minimum length of registrations/subscriptions (default 60)
174 ;defaultexpiry=120 ; Default length of incoming/outgoing registration
175 ;mwiexpiry=3600 ; Expiry time for outgoing MWI subscriptions
176 ;qualifyfreq=60 ; Qualification: How often to check for the
177 ; host to be up in seconds
178 ; Set to low value if you use low timeout for
179 ; NAT of UDP sessions
180 ;qualifygap=100 ; Number of milliseconds between each group of peers being qualified
181 ;qualifypeers=1 ; Number of peers in a group to be qualified at the same time
182 ;notifymimetype=text/plain ; Allow overriding of mime type in MWI NOTIFY
183 ;buggymwi=no ; Cisco SIP firmware doesn't support the MWI RFC
184 ; fully. Enable this option to not get error messages
185 ; when sending MWI to phones with this bug.
186 ;mwi_from=asterisk ; When sending MWI NOTIFY requests, use this setting in
187 ; the From: header as the "name" portion. Also fill the
188 ; "user" portion of the URI in the From: header with this
189 ; value if no fromuser is set
191 ;vmexten=voicemail ; dialplan extension to reach mailbox sets the
192 ; Message-Account in the MWI notify message
193 ; defaults to "asterisk"
195 ;preferred_codec_only=yes ; Respond to a SIP invite with the single most preferred codec
196 ; rather than advertising all joint codec capabilities. This
197 ; limits the other side's codec choice to exactly what we prefer.
199 ;disallow=all ; First disallow all codecs
200 ;allow=ulaw ; Allow codecs in order of preference
201 ;allow=ilbc ; see doc/rtp-packetization for framing options
203 ; This option specifies a preference for which music on hold class this channel
204 ; should listen to when put on hold if the music class has not been set on the
205 ; channel with Set(CHANNEL(musicclass)=whatever) in the dialplan, and the peer
206 ; channel putting this one on hold did not suggest a music class.
208 ; This option may be specified globally, or on a per-user or per-peer basis.
210 ;mohinterpret=default
212 ; This option specifies which music on hold class to suggest to the peer channel
213 ; when this channel places the peer on hold. It may be specified globally or on
214 ; a per-user or per-peer basis.
218 ;parkinglot=plaza ; Sets the default parking lot for call parking
219 ; This may also be set for individual users/peers
220 ; Parkinglots are configured in features.conf
221 ;language=en ; Default language setting for all users/peers
222 ; This may also be set for individual users/peers
223 ;relaxdtmf=yes ; Relax dtmf handling
224 ;trustrpid = no ; If Remote-Party-ID should be trusted
225 ;sendrpid = yes ; If Remote-Party-ID should be sent
226 ;sendrpid = rpid ; Use the "Remote-Party-ID" header
227 ; to send the identity of the remote party
228 ; This is identical to sendrpid=yes
229 ;sendrpid = pai ; Use the "P-Asserted-Identity" header
230 ; to send the identity of the remote party
231 ;rpid_header = rpid ; Which header should be used when sending Remote Party ID
232 ; 'rpid' means to send "Remote-Party-ID"
233 ; 'pai' means to send "P-Asserted-Identity"
234 ;progressinband=never ; If we should generate in-band ringing always
235 ; use 'never' to never use in-band signalling, even in cases
236 ; where some buggy devices might not render it
237 ; Valid values: yes, no, never Default: never
238 ;useragent=Asterisk PBX ; Allows you to change the user agent string
239 ; The default user agent string also contains the Asterisk
240 ; version. If you don't want to expose this, change the
242 ;sdpsession=Asterisk PBX ; Allows you to change the SDP session name string, (s=)
243 ; Like the useragent parameter, the default user agent string
244 ; also contains the Asterisk version.
245 ;sdpowner=root ; Allows you to change the username field in the SDP owner string, (o=)
246 ; This field MUST NOT contain spaces
247 ;promiscredir = no ; If yes, allows 302 or REDIR to non-local SIP address
248 ; Note that promiscredir when redirects are made to the
249 ; local system will cause loops since Asterisk is incapable
250 ; of performing a "hairpin" call.
251 ;usereqphone = no ; If yes, ";user=phone" is added to uri that contains
252 ; a valid phone number
253 ;dtmfmode = rfc2833 ; Set default dtmfmode for sending DTMF. Default: rfc2833
255 ; info : SIP INFO messages (application/dtmf-relay)
256 ; shortinfo : SIP INFO messages (application/dtmf)
257 ; inband : Inband audio (requires 64 kbit codec -alaw, ulaw)
258 ; auto : Use rfc2833 if offered, inband otherwise
260 ;compactheaders = yes ; send compact sip headers.
262 ;videosupport=yes ; Turn on support for SIP video. You need to turn this
263 ; on in this section to get any video support at all.
264 ; You can turn it off on a per peer basis if the general
265 ; video support is enabled, but you can't enable it for
266 ; one peer only without enabling in the general section.
267 ; If you set videosupport to "always", then RTP ports will
268 ; always be set up for video, even on clients that don't
269 ; support it. This assists callfile-derived calls and
270 ; certain transferred calls to use always use video when
271 ; available. [yes|NO|always]
273 ;maxcallbitrate=384 ; Maximum bitrate for video calls (default 384 kb/s)
274 ; Videosupport and maxcallbitrate is settable
275 ; for peers and users as well
276 ;callevents=no ; generate manager events when sip ua
277 ; performs events (e.g. hold)
278 ;authfailureevents=no ; generate manager "peerstatus" events when peer can't
279 ; authenticate with Asterisk. Peerstatus will be "rejected".
280 ;alwaysauthreject = yes ; When an incoming INVITE or REGISTER is to be rejected,
281 ; for any reason, always reject with an identical response
282 ; equivalent to valid username and invalid password/hash
283 ; instead of letting the requester know whether there was
284 ; a matching user or peer for their request. This reduces
285 ; the ability of an attacker to scan for valid SIP usernames.
287 ;g726nonstandard = yes ; If the peer negotiates G726-32 audio, use AAL2 packing
288 ; order instead of RFC3551 packing order (this is required
289 ; for Sipura and Grandstream ATAs, among others). This is
290 ; contrary to the RFC3551 specification, the peer _should_
291 ; be negotiating AAL2-G726-32 instead :-(
292 ;outboundproxy=proxy.provider.domain ; send outbound signaling to this proxy, not directly to the devices
293 ;outboundproxy=proxy.provider.domain:8080 ; send outbound signaling to this proxy, not directly to the devices
294 ;outboundproxy=proxy.provider.domain,force ; Send ALL outbound signalling to proxy, ignoring route: headers
295 ;outboundproxy=tls://proxy.provider.domain ; same as '=proxy.provider.domain' except we try to connect with tls
296 ; ; (could also be tcp,udp) - defining transports on the proxy line only
297 ; ; applies for the global proxy, otherwise use the transport= option
298 ;matchexterniplocally = yes ; Only substitute the externip or externhost setting if it matches
299 ; your localnet setting. Unless you have some sort of strange network
300 ; setup you will not need to enable this.
302 ;dynamic_exclude_static = yes ; Disallow all dynamic hosts from registering
303 ; as any IP address used for staticly defined
304 ; hosts. This helps avoid the configuration
305 ; error of allowing your users to register at
306 ; the same address as a SIP provider.
308 ;contactdeny=0.0.0.0/0.0.0.0 ; Use contactpermit and contactdeny to
309 ;contactpermit=172.16.0.0/255.255.0.0 ; restrict at what IPs your users may
310 ; register their phones.
312 ;engine=asterisk ; RTP engine to use when communicating with the device
315 ; If regcontext is specified, Asterisk will dynamically create and destroy a
316 ; NoOp priority 1 extension for a given peer who registers or unregisters with
317 ; us and have a "regexten=" configuration item.
318 ; Multiple contexts may be specified by separating them with '&'. The
319 ; actual extension is the 'regexten' parameter of the registering peer or its
320 ; name if 'regexten' is not provided. If more than one context is provided,
321 ; the context must be specified within regexten by appending the desired
322 ; context after '@'. More than one regexten may be supplied if they are
323 ; separated by '&'. Patterns may be used in regexten.
325 ;regcontext=sipregistrations
326 ;regextenonqualify=yes ; Default "no"
327 ; If you have qualify on and the peer becomes unreachable
328 ; this setting will enforce inactivation of the regexten
329 ; extension for the peer
331 ;--------------------------- SIP timers ----------------------------------------------------
332 ; These timers are used primarily in INVITE transactions.
333 ; The default for Timer T1 is 500 ms or the measured run-trip time between
334 ; Asterisk and the device if you have qualify=yes for the device.
336 ;t1min=100 ; Minimum roundtrip time for messages to monitored hosts
338 ;timert1=500 ; Default T1 timer
339 ; Defaults to 500 ms or the measured round-trip
340 ; time to a peer (qualify=yes).
341 ;timerb=32000 ; Call setup timer. If a provisional response is not received
342 ; in this amount of time, the call will autocongest
343 ; Defaults to 64*timert1
345 ;--------------------------- RTP timers ----------------------------------------------------
346 ; These timers are currently used for both audio and video streams. The RTP timeouts
347 ; are only applied to the audio channel.
348 ; The settings are settable in the global section as well as per device
350 ;rtptimeout=60 ; Terminate call if 60 seconds of no RTP or RTCP activity
351 ; on the audio channel
352 ; when we're not on hold. This is to be able to hangup
353 ; a call in the case of a phone disappearing from the net,
354 ; like a powerloss or grandma tripping over a cable.
355 ;rtpholdtimeout=300 ; Terminate call if 300 seconds of no RTP or RTCP activity
356 ; on the audio channel
357 ; when we're on hold (must be > rtptimeout)
358 ;rtpkeepalive=<secs> ; Send keepalives in the RTP stream to keep NAT open
359 ; (default is off - zero)
361 ;--------------------------- SIP Session-Timers (RFC 4028)------------------------------------
362 ; SIP Session-Timers provide an end-to-end keep-alive mechanism for active SIP sessions.
363 ; This mechanism can detect and reclaim SIP channels that do not terminate through normal
364 ; signaling procedures. Session-Timers can be configured globally or at a user/peer level.
365 ; The operation of Session-Timers is driven by the following configuration parameters:
367 ; * session-timers - Session-Timers feature operates in the following three modes:
368 ; originate : Request and run session-timers always
369 ; accept : Run session-timers only when requested by other UA
370 ; refuse : Do not run session timers in any case
371 ; The default mode of operation is 'accept'.
372 ; * session-expires - Maximum session refresh interval in seconds. Defaults to 1800 secs.
373 ; * session-minse - Minimum session refresh interval in seconds. Defualts to 90 secs.
374 ; * session-refresher - The session refresher (uac|uas). Defaults to 'uas'.
376 ;session-timers=originate
379 ;session-refresher=uas
381 ;--------------------------- HASH TABLE SIZES ------------------------------------------------
382 ; For maximum efficiency, adjust the following
383 ; values to be slightly larger than the maximum number of in-memory objects (devices).
384 ; Too large, and space is wasted. Too small, and things will run slower.
385 ; 563 is probably way too big for small (home) applications, but it
386 ; should cover most small/medium sites.
387 ; It is recommended to make the sizes be a prime number!
388 ; This was internally set to 17 for small-memory applications...
389 ; All tables default to 563, except when compiled in LOW_MEMORY mode,
390 ; in which case, they default to 17. You can override this by uncommenting
391 ; the following, and changing the values.
396 ;--------------------------- SIP DEBUGGING ---------------------------------------------------
397 ;sipdebug = yes ; Turn on SIP debugging by default, from
398 ; the moment the channel loads this configuration
399 ;recordhistory=yes ; Record SIP history by default
400 ; (see sip history / sip no history)
401 ;dumphistory=yes ; Dump SIP history at end of SIP dialogue
402 ; SIP history is output to the DEBUG logging channel
405 ;--------------------------- STATUS NOTIFICATIONS (SUBSCRIPTIONS) ----------------------------
406 ; You can subscribe to the status of extensions with a "hint" priority
407 ; (See extensions.conf.sample for examples)
408 ; chan_sip support two major formats for notifications: dialog-info and SIMPLE
410 ; You will get more detailed reports (busy etc) if you have a call counter enabled
413 ; If you set the busylevel, we will indicate busy when we have a number of calls that
414 ; matches the busylevel treshold.
416 ; For queues, you will need this level of detail in status reporting, regardless
417 ; if you use SIP subscriptions. Queues and manager use the same internal interface
418 ; for reading status information.
420 ; Note: Subscriptions does not work if you have a realtime dialplan and use the
423 ;allowsubscribe=no ; Disable support for subscriptions. (Default is yes)
424 ;subscribecontext = default ; Set a specific context for SUBSCRIBE requests
425 ; Useful to limit subscriptions to local extensions
426 ; Settable per peer/user also
427 ;notifyringing = no ; Control whether subscriptions already INUSE get sent
428 ; RINGING when another call is sent (default: yes)
429 ;notifyhold = yes ; Notify subscriptions on HOLD state (default: no)
430 ; Turning on notifyringing and notifyhold will add a lot
431 ; more database transactions if you are using realtime.
432 ;notifycid = yes ; Control whether caller ID information is sent along with
433 ; dialog-info+xml notifications (supported by snom phones).
434 ; Note that this feature will only work properly when the
435 ; incoming call is using the same extension and context that
436 ; is being used as the hint for the called extension. This means
437 ; that it won't work when using subscribecontext for your sip
438 ; user or peer (if subscribecontext is different than context).
439 ; This is also limited to a single caller, meaning that if an
440 ; extension is ringing because multiple calls are incoming,
441 ; only one will be used as the source of caller ID. Specify
442 ; 'ignore-context' to ignore the called context when looking
443 ; for the caller's channel. The default value is 'no.' Setting
444 ; notifycid to 'ignore-context' also causes call-pickups attempted
445 ; via SNOM's NOTIFY mechanism to set the context for the call pickup
447 ;callcounter = yes ; Enable call counters on devices. This can be set per
450 ;----------------------------------------- T.38 FAX PASSTHROUGH SUPPORT -----------------------
452 ; This setting is available in the [general] section as well as in device configurations.
453 ; Setting this to yes, enables T.38 fax (UDPTL) passthrough on SIP to SIP calls, provided
454 ; both parties have T38 support enabled in their Asterisk configuration
455 ; This has to be enabled in the general section for all devices to work. You can then
456 ; disable it on a per device basis.
458 ; T.38 faxing only works in SIP to SIP calls, with no local or agent channel being used.
460 ; t38pt_udptl = yes ; Default false
462 ; Fax Detect will cause the SIP channel to jump to the 'fax' extension (if it exists)
463 ; after T.38 is successfully negotiated.
465 ; faxdetect = yes ; Default false
467 ;----------------------------------------- OUTBOUND SIP REGISTRATIONS ------------------------
468 ; Asterisk can register as a SIP user agent to a SIP proxy (provider)
469 ; Format for the register statement is:
470 ; register => [transport://]user[:secret[:authuser]]@domain[:port][/extension][~expiry]
477 ; - the name of a peer defined below or in realtime
478 ; The domain is where you register your username, so your SIP uri you are registering to
481 ; If no extension is given, the 's' extension is used. The extension needs to
482 ; be defined in extensions.conf to be able to accept calls from this SIP proxy
485 ; A similar effect can be achieved by adding a "callbackextension" option in a peer section.
486 ; this is equivalent to having the following line in the general section:
488 ; register => username:secret@host/callbackextension
490 ; and more readable because you don't have to write the parameters in two places
491 ; (note that the "port" is ignored - this is a bug that should be fixed).
493 ; Note that a register= line doesn't mean that we will match the incoming call in any
494 ; other way than described above. If you want to control where the call enters your
495 ; dialplan, which context, you want to define a peer with the hostname of the provider's
496 ; server. If the provider has multiple servers to place calls to your system, you need
497 ; a peer for each server.
499 ; Beginning with Asterisk version 1.6.2, the "user" portion of the register line may
500 ; contain a port number. Since the logical separator between a host and port number is a
501 ; ':' character, and this character is already used to separate between the optional "secret"
502 ; and "authuser" portions of the line, there is a bit of a hoop to jump through if you wish
503 ; to use a port here. That is, you must explicitly provide a "secret" and "authuser" even if
504 ; they are blank. See the third example below for an illustration.
509 ;register => 1234:password@mysipprovider.com
511 ; This will pass incoming calls to the 's' extension
514 ;register => 2345:password@sip_proxy/1234
516 ; Register 2345 at sip provider 'sip_proxy'. Calls from this provider
517 ; connect to local extension 1234 in extensions.conf, default context,
518 ; unless you configure a [sip_proxy] section below, and configure a
520 ; Tip 1: Avoid assigning hostname to a sip.conf section like [provider.com]
521 ; Tip 2: Use separate inbound and outbound sections for SIP providers
522 ; (instead of type=friend) if you have calls in both directions
524 ;register => 3456@mydomain:5082::@mysipprovider.com
526 ; Note that in this example, the optional authuser and secret portions have
527 ; been left blank because we have specified a port in the user section
529 ;registertimeout=20 ; retry registration calls every 20 seconds (default)
530 ;registerattempts=10 ; Number of registration attempts before we give up
531 ; 0 = continue forever, hammering the other server
532 ; until it accepts the registration
533 ; Default is 0 tries, continue forever
534 ;----------------------------------------- OUTBOUND MWI SUBSCRIPTIONS -------------------------
535 ; Asterisk can subscribe to receive the MWI from another SIP server and store it locally for retrieval
537 ; Format for the mwi register statement is:
538 ; mwi => user[:secret[:authuser]]@host[:port][/mailbox]
541 ;mwi => 1234:password@mysipprovider.com/1234
543 ; 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:
544 ; mailbox=1234@SIP_Remote
545 ;----------------------------------------- NAT SUPPORT ------------------------
547 ; WARNING: SIP operation behind a NAT is tricky and you really need
548 ; to read and understand well the following section.
550 ; When Asterisk is behind a NAT device, the "local" address (and port) that
551 ; a socket is bound to has different values when seen from the inside or
552 ; from the outside of the NATted network. Unfortunately this address must
553 ; be communicated to the outside (e.g. in SIP and SDP messages), and in
554 ; order to determine the correct value Asterisk needs to know:
556 ; + whether it is talking to someone "inside" or "outside" of the NATted network.
557 ; This is configured by assigning the "localnet" parameter with a list
558 ; of network addresses that are considered "inside" of the NATted network.
559 ; IF LOCALNET IS NOT SET, THE EXTERNAL ADDRESS WILL NOT BE SET CORRECTLY.
560 ; Multiple entries are allowed, e.g. a reasonable set is the following:
562 ; localnet=192.168.0.0/255.255.0.0 ; RFC 1918 addresses
563 ; localnet=10.0.0.0/255.0.0.0 ; Also RFC1918
564 ; localnet=172.16.0.0/12 ; Another RFC1918 with CIDR notation
565 ; localnet=169.254.0.0/255.255.0.0 ; Zero conf local network
567 ; + the "externally visible" address and port number to be used when talking
568 ; to a host outside the NAT. This information is derived by one of the
569 ; following (mutually exclusive) config file parameters:
571 ; a. "externip = hostname[:port]" specifies a static address[:port] to
572 ; be used in SIP and SDP messages.
573 ; The hostname is looked up only once, when [re]loading sip.conf .
574 ; If a port number is not present, use the "bindport" value (which is
575 ; not guaranteed to work correctly, because a NAT box might remap the
576 ; port number as well as the address).
577 ; This approach can be useful if you have a NAT device where you can
578 ; configure the mapping statically. Examples:
580 ; externip = 12.34.56.78 ; use this address.
581 ; externip = 12.34.56.78:9900 ; use this address and port.
582 ; externip = mynat.my.org:12600 ; Public address of my nat box.
584 ; b. "externhost = hostname[:port]" is similar to "externip" except
585 ; that the hostname is looked up every "externrefresh" seconds
586 ; (default 10s). This can be useful when your NAT device lets you choose
587 ; the port mapping, but the IP address is dynamic.
588 ; Beware, you might suffer from service disruption when the name server
589 ; resolution fails. Examples:
591 ; externhost=foo.dyndns.net ; refreshed periodically
592 ; externrefresh=180 ; change the refresh interval
594 ; c. "stunaddr = stun.server[:port]" queries the STUN server specified
595 ; as an argument to obtain the external address/port.
596 ; Queries are also sent periodically every "externrefresh" seconds
597 ; (as a side effect, sending the query also acts as a keepalive for
598 ; the state entry on the nat box):
600 ; stunaddr = foo.stun.com:3478
603 ; Note that at the moment all these mechanism work only for the SIP socket.
604 ; The IP address discovered with externip/externhost/STUN is reused for
605 ; media sessions as well, but the port numbers are not remapped so you
606 ; may still experience problems.
608 ; NOTE 1: in some cases, NAT boxes will use different port numbers in
609 ; the internal<->external mapping. In these cases, the "externip" and
610 ; "externhost" might not help you configure addresses properly, and you
611 ; really need to use STUN.
613 ; NOTE 2: when using "externip" or "externhost", the address part is
614 ; also used as the external address for media sessions.
615 ; If you use "stunaddr", STUN queries will be sent to the same server
616 ; also from media sockets, and this should permit a correct mapping of
617 ; the port numbers as well.
619 ; In addition to the above, Asterisk has an additional "nat" parameter to
620 ; address NAT-related issues in incoming SIP or media sessions.
621 ; In particular, depending on the 'nat= ' settings described below, Asterisk
622 ; may override the address/port information specified in the SIP/SDP messages,
623 ; and use the information (sender address) supplied by the network stack instead.
624 ; However, this is only useful if the external traffic can reach us.
625 ; The following settings are allowed (both globally and in individual sections):
627 ; nat = no ; default. Use NAT mode only according to RFC3581 (;rport)
628 ; nat = yes ; Always ignore info and assume NAT
629 ; nat = never ; Never attempt NAT mode or RFC3581 support
630 ; nat = route ; route = Assume NAT, don't send rport
631 ; ; (work around more UNIDEN bugs)
633 ;----------------------------------- MEDIA HANDLING --------------------------------
634 ; By default, Asterisk tries to re-invite the audio to an optimal path. If there's
635 ; no reason for Asterisk to stay in the media path, the media will be redirected.
636 ; This does not really work with in the case where Asterisk is outside and have
637 ; clients on the inside of a NAT. In that case, you want to set canreinvite=nonat
639 ;canreinvite=yes ; Asterisk by default tries to redirect the
640 ; RTP media stream (audio) to go directly from
641 ; the caller to the callee. Some devices do not
642 ; support this (especially if one of them is behind a NAT).
643 ; The default setting is YES. If you have all clients
644 ; behind a NAT, or for some other reason wants Asterisk to
645 ; stay in the audio path, you may want to turn this off.
647 ; This setting also affect direct RTP
648 ; at call setup (a new feature in 1.4 - setting up the
649 ; call directly between the endpoints instead of sending
652 ;directrtpsetup=yes ; Enable the new experimental direct RTP setup. This sets up
653 ; the call directly with media peer-2-peer without re-invites.
654 ; Will not work for video and cases where the callee sends
655 ; RTP payloads and fmtp headers in the 200 OK that does not match the
656 ; callers INVITE. This will also fail if canreinvite is enabled when
657 ; the device is actually behind NAT.
659 ;canreinvite=nonat ; An additional option is to allow media path redirection
660 ; (reinvite) but only when the peer where the media is being
661 ; sent is known to not be behind a NAT (as the RTP core can
662 ; determine it based on the apparent IP address the media
665 ;canreinvite=update ; Yet a third option... use UPDATE for media path redirection,
666 ; instead of INVITE. This can be combined with 'nonat', as
667 ; 'canreinvite=update,nonat'. It implies 'yes'.
669 ;ignoresdpversion=yes ; By default, Asterisk will honor the session version
670 ; number in SDP packets and will only modify the SDP
671 ; session if the version number changes. This option will
672 ; force asterisk to ignore the SDP session version number
673 ; and treat all SDP data as new data. This is required
674 ; for devices that send us non standard SDP packets
675 ; (observed with Microsoft OCS). By default this option is
678 ;----------------------------------------- REALTIME SUPPORT ------------------------
679 ; For additional information on ARA, the Asterisk Realtime Architecture,
680 ; please read realtime.txt and extconfig.txt in the /doc directory of the
683 ;rtcachefriends=yes ; Cache realtime friends by adding them to the internal list
684 ; just like friends added from the config file only on a
685 ; as-needed basis? (yes|no)
687 ;rtsavesysname=yes ; Save systemname in realtime database at registration
690 ;rtupdate=yes ; Send registry updates to database using realtime? (yes|no)
691 ; If set to yes, when a SIP UA registers successfully, the ip address,
692 ; the origination port, the registration period, and the username of
693 ; the UA will be set to database via realtime.
694 ; If not present, defaults to 'yes'. Note: realtime peers will
695 ; probably not function across reloads in the way that you expect, if
696 ; you turn this option off.
697 ;rtautoclear=yes ; Auto-Expire friends created on the fly on the same schedule
698 ; as if it had just registered? (yes|no|<seconds>)
699 ; If set to yes, when the registration expires, the friend will
700 ; vanish from the configuration until requested again. If set
701 ; to an integer, friends expire within this number of seconds
702 ; instead of the registration interval.
704 ;ignoreregexpire=yes ; Enabling this setting has two functions:
706 ; For non-realtime peers, when their registration expires, the
707 ; information will _not_ be removed from memory or the Asterisk database
708 ; if you attempt to place a call to the peer, the existing information
709 ; will be used in spite of it having expired
711 ; For realtime peers, when the peer is retrieved from realtime storage,
712 ; the registration information will be used regardless of whether
713 ; it has expired or not; if it expires while the realtime peer
714 ; is still in memory (due to caching or other reasons), the
715 ; information will not be removed from realtime storage
717 ;----------------------------------------- SIP DOMAIN SUPPORT ------------------------
718 ; Incoming INVITE and REFER messages can be matched against a list of 'allowed'
719 ; domains, each of which can direct the call to a specific context if desired.
720 ; By default, all domains are accepted and sent to the default context or the
721 ; context associated with the user/peer placing the call.
722 ; REGISTER to non-local domains will be automatically denied if a domain
723 ; list is configured.
725 ; Domains can be specified using:
726 ; domain=<domain>[,<context>]
728 ; domain=myasterisk.dom
729 ; domain=customer.com,customer-context
731 ; In addition, all the 'default' domains associated with a server should be
732 ; added if incoming request filtering is desired.
735 ; To disallow requests for domains not serviced by this server:
736 ; allowexternaldomains=no
738 ;domain=mydomain.tld,mydomain-incoming
739 ; Add domain and configure incoming context
740 ; for external calls to this domain
741 ;domain=1.2.3.4 ; Add IP address as local domain
742 ; You can have several "domain" settings
743 ;allowexternaldomains=no ; Disable INVITE and REFER to non-local domains
745 ;autodomain=yes ; Turn this on to have Asterisk add local host
746 ; name and local IP to domain list.
748 ; fromdomain=mydomain.tld ; When making outbound SIP INVITEs to
749 ; non-peers, use your primary domain "identity"
750 ; for From: headers instead of just your IP
751 ; address. This is to be polite and
752 ; it may be a mandatory requirement for some
753 ; destinations which do not have a prior
754 ; account relationship with your server.
756 ;------------------------------ JITTER BUFFER CONFIGURATION --------------------------
757 ; jbenable = yes ; Enables the use of a jitterbuffer on the receiving side of a
758 ; SIP channel. Defaults to "no". An enabled jitterbuffer will
759 ; be used only if the sending side can create and the receiving
760 ; side can not accept jitter. The SIP channel can accept jitter,
761 ; thus a jitterbuffer on the receive SIP side will be used only
762 ; if it is forced and enabled.
764 ; jbforce = no ; Forces the use of a jitterbuffer on the receive side of a SIP
765 ; channel. Defaults to "no".
767 ; jbmaxsize = 200 ; Max length of the jitterbuffer in milliseconds.
769 ; jbresyncthreshold = 1000 ; Jump in the frame timestamps over which the jitterbuffer is
770 ; resynchronized. Useful to improve the quality of the voice, with
771 ; big jumps in/broken timestamps, usually sent from exotic devices
772 ; and programs. Defaults to 1000.
774 ; jbimpl = fixed ; Jitterbuffer implementation, used on the receiving side of a SIP
775 ; channel. Two implementations are currently available - "fixed"
776 ; (with size always equals to jbmaxsize) and "adaptive" (with
777 ; variable size, actually the new jb of IAX2). Defaults to fixed.
779 ; jblog = no ; Enables jitterbuffer frame logging. Defaults to "no".
780 ;-----------------------------------------------------------------------------------
783 ; Global credentials for outbound calls, i.e. when a proxy challenges your
784 ; Asterisk server for authentication. These credentials override
785 ; any credentials in peer/register definition if realm is matched.
787 ; This way, Asterisk can authenticate for outbound calls to other
788 ; realms. We match realm on the proxy challenge and pick an set of
789 ; credentials from this list
791 ; auth = <user>:<secret>@<realm>
792 ; auth = <user>#<md5secret>@<realm>
794 ;auth=mark:topsecret@digium.com
796 ; You may also add auth= statements to [peer] definitions
797 ; Peer auth= override all other authentication settings if we match on realm
799 ;------------------------------------------------------------------------------
800 ; DEVICE CONFIGURATION
802 ; The SIP channel has two types of devices, the friend and the peer.
803 ; * The type=friend is a device type that accepts both incoming and outbound calls,
804 ; where Asterisk match on the From: username on incoming calls.
805 ; (A synonym for friend is "user"). This is a type you use for your local
807 ; * The type=peer also handles both incoming and outbound calls. On inbound calls,
808 ; Asterisk only matches on IP/port, not on names. This is mostly used for SIP
811 ; For device names, we recommend using only a-z, numerics (0-9) and underscore
813 ; For local phones, type=friend works most of the time
815 ; If you have one-way audio, you probably have NAT problems.
816 ; If Asterisk is on a public IP, and the phone is inside of a NAT device
817 ; you will need to configure nat option for those phones.
818 ; Also, turn on qualify=yes to keep the nat session open
820 ; Configuration options available
821 ; --------------------
883 ; contactpermit ; Limit what a host may register as (a neat trick
884 ; contactdeny ; is to register at the same IP as a SIP provider,
885 ; ; then call oneself, and get redirected to that
889 ; For incoming calls only. Example: FWD (Free World Dialup)
890 ; We match on IP address of the proxy for incoming calls
891 ; since we can not match on username (caller id)
897 ;type=peer ; we only want to call out, not be called
898 ;remotesecret=guessit ; Our password to their service
899 ;defaultuser=yourusername ; Authentication user for outbound proxies
900 ;fromuser=yourusername ; Many SIP providers require this!
901 ;fromdomain=provider.sip.domain
902 ;host=box.provider.com
903 ;transport=udp,tcp ; This sets the transport type to udp for outgoing, and will
904 ; ; accept both tcp and udp. Default is udp. The first transport
905 ; ; listed will always be used for outgoing connections.
906 ;usereqphone=yes ; This provider requires ";user=phone" on URI
907 ;callcounter=yes ; Enable call counter
908 ;busylevel=2 ; Signal busy at 2 or more calls
909 ;outboundproxy=proxy.provider.domain ; send outbound signaling to this proxy, not directly to the peer
910 ;port=80 ; The port number we want to connect to on the remote side
911 ; Also used as "defaultport" in combination with "defaultip" settings
913 ;--- sample definition for a provider
916 ;host=sip.provider1.com
917 ;fromuser=4015552299 ; how your provider knows you
918 ;remotesecret=youwillneverguessit ; The password we use to authenticate to them
919 ;secret=gissadetdu ; The password they use to contact us
920 ;callbackextension=123 ; Register with this server and require calls coming back to this extension
921 ;transport=udp,tcp ; This sets the transport type to udp for outgoing, and will
922 ; ; accept both tcp and udp. Default is udp. The first transport
923 ; ; listed will always be used for outgoing connections.
926 ; Because you might have a large number of similar sections, it is generally
927 ; convenient to use templates for the common parameters, and add them
928 ; the the various sections. Examples are below, and we can even leave
929 ; the templates uncommented as they will not harm:
931 [basic-options](!) ; a template
936 [natted-phone](!,basic-options) ; another template inheriting basic-options
941 [public-phone](!,basic-options) ; another template inheriting basic-options
945 [my-codecs](!) ; a template for my preferred codecs
953 [ulaw-phone](!) ; and another one for ulaw-only
957 ; and finally instantiate a few phones
959 ; [2133](natted-phone,my-codecs)
961 ; [2134](natted-phone,ulaw-phone)
962 ; secret = not_very_secret
963 ; [2136](public-phone,ulaw-phone)
964 ; secret = not_very_secret_either
968 ; Standard configurations not using templates look like this:
972 ;context=from-sip ; Where to start in the dialplan when this phone calls
973 ;callerid=John Doe <1234> ; Full caller ID, to override the phones config
974 ; on incoming calls to Asterisk
975 ;host=192.168.0.23 ; we have a static but private IP address
976 ; No registration allowed
977 ;nat=no ; there is not NAT between phone and Asterisk
978 ;canreinvite=yes ; allow RTP voice traffic to bypass Asterisk
979 ;dtmfmode=info ; either RFC2833 or INFO for the BudgeTone
980 ;call-limit=1 ; permit only 1 outgoing call and 1 incoming call at a time
981 ; from the phone to asterisk (deprecated)
982 ; 1 for the explicit peer, 1 for the explicit user,
983 ; remember that a friend equals 1 peer and 1 user in
985 ; There is no combined call counter for a "friend"
986 ; so there's currently no way in sip.conf to limit
987 ; to one inbound or outbound call per phone. Use
988 ; the group counters in the dial plan for that.
990 ;mailbox=1234@default ; mailbox 1234 in voicemail context "default"
991 ;disallow=all ; need to disallow=all before we can use allow=
992 ;allow=ulaw ; Note: In user sections the order of codecs
993 ; listed with allow= does NOT matter!
995 ;allow=g723.1 ; Asterisk only supports g723.1 pass-thru!
996 ;allow=g729 ; Pass-thru only unless g729 license obtained
997 ;callingpres=allowed_passed_screen ; Set caller ID presentation
998 ; See README.callingpres for more information
1001 ; Turn off silence suppression in X-Lite ("Transmit Silence"=YES)!
1002 ; Note that Xlite sends NAT keep-alive packets, so qualify=yes is not needed
1004 ;regexten=1234 ; When they register, create extension 1234
1005 ;callerid="Jane Smith" <5678>
1006 ;host=dynamic ; This device needs to register
1007 ;nat=yes ; X-Lite is behind a NAT router
1008 ;canreinvite=no ; Typically set to NO if behind NAT
1010 ;allow=gsm ; GSM consumes far less bandwidth than ulaw
1013 ;mailbox=1234@default,1233@default ; Subscribe to status of multiple mailboxes
1014 ;registertrying=yes ; Send a 100 Trying when the device registers.
1017 ;type=friend ; Friends place calls and receive calls
1018 ;context=from-sip ; Context for incoming calls from this user
1020 ;subscribecontext=localextensions ; Only allow SUBSCRIBE for local extensions
1021 ;language=de ; Use German prompts for this user
1022 ;host=dynamic ; This peer register with us
1023 ;dtmfmode=inband ; Choices are inband, rfc2833, or info
1024 ;defaultip=192.168.0.59 ; IP used until peer registers
1025 ;mailbox=1234@context,2345 ; Mailbox(-es) for message waiting indicator
1026 ;subscribemwi=yes ; Only send notifications if this phone
1027 ; subscribes for mailbox notification
1028 ;vmexten=voicemail ; dialplan extension to reach mailbox
1029 ; sets the Message-Account in the MWI notify message
1030 ; defaults to global vmexten which defaults to "asterisk"
1032 ;allow=ulaw ; dtmfmode=inband only works with ulaw or alaw!
1036 ;type=friend ; Friends place calls and receive calls
1037 ;context=from-sip ; Context for incoming calls from this user
1039 ;host=dynamic ; This peer register with us
1040 ;dtmfmode=rfc2833 ; Choices are inband, rfc2833, or info
1041 ;defaultuser=polly ; Username to use in INVITE until peer registers
1042 ;defaultip=192.168.40.123
1043 ; Normally you do NOT need to set this parameter
1045 ;allow=ulaw ; dtmfmode=inband only works with ulaw or alaw!
1046 ;progressinband=no ; Polycom phones don't work properly with "never"
1053 ;insecure=port ; Allow matching of peer by IP address without
1054 ; matching port number
1055 ;insecure=invite ; Do not require authentication of incoming INVITEs
1056 ;insecure=port,invite ; (both)
1057 ;qualify=1000 ; Consider it down if it's 1 second to reply
1058 ; Helps with NAT session
1059 ; qualify=yes uses default value
1060 ;qualifyfreq=60 ; Qualification: How often to check for the
1061 ; host to be up in seconds
1062 ; Set to low value if you use low timeout for
1063 ; NAT of UDP sessions
1065 ; Call group and Pickup group should be in the range from 0 to 63
1067 ;callgroup=1,3-4 ; We are in caller groups 1,3,4
1068 ;pickupgroup=1,3-5 ; We can do call pick-p for call group 1,3,4,5
1069 ;defaultip=192.168.0.60 ; IP address to use if peer has not registered
1070 ;deny=0.0.0.0/0.0.0.0 ; ACL: Control access to this account based on IP address
1071 ;permit=192.168.0.60/255.255.255.0
1076 ;qualify=200 ; Qualify peer is no more than 200ms away
1077 ;nat=yes ; This phone may be natted
1078 ; Send SIP and RTP to the IP address that packet is
1079 ; received from instead of trusting SIP headers
1080 ;host=dynamic ; This device registers with us
1081 ;canreinvite=no ; Asterisk by default tries to redirect the
1082 ; RTP media stream (audio) to go directly from
1083 ; the caller to the callee. Some devices do not
1084 ; support this (especially if one of them is
1086 ;defaultip=192.168.0.4 ; IP address to use until registration
1087 ;defaultuser=goran ; Username to use when calling this device before registration
1088 ; Normally you do NOT need to set this parameter
1089 ;setvar=CUSTID=5678 ; Channel variable to be set for all calls from or to this device
1090 ;setvar=ATTENDED_TRANSFER_COMPLETE_SOUND=beep ; This channel variable will
1091 ; cause the given audio file to
1092 ; be played upon completion of
1093 ; an attended transfer.
1099 ;rfc2833compensate=yes ; Compensate for pre-1.4 DTMF transmission from another Asterisk machine.
1100 ; You must have this turned on or DTMF reception will work improperly.
1101 ;t38pt_usertpsource=yes ; Use the source IP address of RTP as the destination IP address for UDPTL packets
1102 ; if the nat option is enabled. If a single RTP packet is received Asterisk will know the
1103 ; external IP address of the remote device. If port forwarding is done at the client side
1104 ; then UDPTL will flow to the remote device.
projects / asterisk/asterisk.git / blob