Asterisk RealTime SIP

sip.conf Setup

You can keep any sip users in the flatfile AND use RealTime. How cool is that?

Extconfig.conf Setup

Add the following line, swapping your own personal values if you wish:



You can change mysql to odbc if you want to use odbc (don't forget to compile the asterisk-addons package for MySQL support!).
You can change asterisk to be the name of your database.
You can change sip_buddies to be the name of the sip table we will create below.

Note: regseconds is the time the peer was registered PLUS the expiration time. It is placed in the table as unix time.

Database Config

put the following in res_mysql.conf

Values in sip.conf or iax.conf like in older versions of * are no longer used.

Database Table

Lets create the table we need:

NOTE: You can use any table name you wish, just make sure the table name matches what you have the family name bound to.

NOTE: General principles: the column names in your database table correspond to the option names in sip.conf. You do not have to have all option names defined in your table; you only have to define those columns you actually use in sip.conf. Exceptions to this are 'regserver' and 'regseconds', which the channel driver's realtime routines use for internal book-keeping. The 'name' field must also be present to hold equivalent of the category name in the sip.conf file. It is easily possible that different versions of Asterisk will require different tables. For instance, a 1.6 version of Asterisk would not use the "cancallforward", or 'restrictcid', or 'mask', or 'qualify', or "musiconhold" columns, but might require 'mohinterpret', 'mohsuggest', etc. etc. options instead. Options (column names) that not offered in sip.conf are ignored. Some options in sip.conf are OK to have multiple entries, but in a real-time database, Only one column is available. In these cases, you can add multiple values separated by semicolons. This occurs with setvar, allow/disallow, and permit/deny. One more point: in allow/disallow and permit/deny, the order of these statements is crucial in the config file, as they are applied in order. In the realtime db, the order is determined by the order of the columns in the table. You will note that the deny/disallow entries come before the allow/permit entries, to support the common usage of 'deny all', then permit '192.168.....'.




May 14/08 arf_
Added 'subscribecontext' to the above as it's may be needed in some case (and it works a least with asterisk 1.4.18)

Apr 15/08 bcnit
Added 'defaultuser' to the above as it's needed in Asterisk 1.6.

Jul 9/07 bcnit
Note that 'regserver' has been added to the above this doesn't appear to be used by anything other than the initial call RealTime makes to clear the record, but including it gets rid of a WARNING on the console!

Jun 8/07 bcnit
If you are going to access the table above using MS Access and MyODBC, define port as:

Or you'll have all sorts of problems trying to update rows!

Jan 4/06 mhaynes
I ran into problems using the Message Waiting Indicator with my Cisco 7960g phone using the realtime system under Asterisk 1.2.0. Turns out you need to set the rtcachefriends=yes in the general context of your flat file sip.conf. Once this is done, MWI starts working as usual.

Nov 9/05 hfwang
Note: It seems that since asterisk 1.0.2RC1 there is 1 additional field for SIP accounts called 'fullcontact'. Added this field in the table above.

Updated by: DHuang

(3/16/05) Updated by: utdrmac - incominglimit and outgoinglimit are deprecated. Use Asterisk cmd SetGroup instead.

Jan 2/06 misak
Added setvar column


NOTE: The index created on the column 'name' is because RealTime does its SELECT query using that column everytime. That column must also be unique.

You do not need every column listed above. If you wish, you can remove those columns you know you will never use. The columns in your tables should line up with the fields you would specify in the given entity declaration. If an entry would appear more than once, in the column it should be separated by a semicolon. For example, an entity that looks like:


could be stored in a table like this:



You do not need to insert the ipaddr, port or regseconds information. These columns will be updated periodicaly by RealTime.

Testing

Throw some data into the above table and try to register an extension. The /var/log/asterisk/debug should give info on any problems.

Realtime Caching...

As of CVS-HEAD 3/16/05, if you enable RealTime caching in your sip.conf, Voicemail MWI works and so does 'sip show peers'. To do so, add "rtcachefriends=yes" to the general section of your sip.conf file.

As the name implies, this caches the "RealTime" information from the database. As a result, there is a delay in updating some (if not all) fields in the SIP entry when you update the database. For instance, if you create an entry with a context = "context1" and Asterisk loads it from the database (perhaps the phone registered or tried to make a call), Asterisk holds on to that information as far as I can tell, indefinitely until a sip reload occurs.

This also means that you will have to do a sip reload to clear out any entries. Removing them from the database does not seem to work. You can still add new entries though without reloading Asterisk.

RealTime caching...isn't that an oxymoron anyways? :-) — (Someone check to see if this affects IAX too, I don't have any IAX phones at the moment. - Flobi) — (RealTime caching does affect IAX as well, works the same way. - Josh)

Update : use "sip prune realtime PEERNAME" then "sip show peer PEERNAME load" to flush the peer and reload from db - (Voicemeup)

See Also

• Asterisk RealTime
• Asterisk RealTime Static
• Asterisk RealTime Sip
• Asterisk RealTime IAX
• Asterisk RealTime Voicemail
• Asterisk RealTime Extensions