diff --git a/README.md b/README.md index 11e3fa3..5b7d45b 100644 --- a/README.md +++ b/README.md @@ -7,22 +7,27 @@ Gemeinschaft 2.x - CallerID addon 1. INSTALLATION --------------- -1. copy the directories `dialplan-scripts/` and `inc/` to `/opt/gemeinschaft/` -- open the file `/etc/asterisk/e-internal.ael` -- find the `context to-internal-users-self` (around line 478) -- in there, find the `to_user:` section -- before the `Dial(…)` command (around line 731), add the following line: -```php +* copy the directories `dialplan-scripts/` and `inc/` to `/opt/gemeinschaft/` +* open the file `/etc/asterisk/e-internal.ael` +* find the `context to-internal-users-self` (around line 478) +* in there, find the `to_user:` section +* before the `Dial(…)` command (around line 731), add the following line: + +``` AGI(/opt/gemeinschaft/dialplan-scripts/in-get-callerid.agi,${CALLERID(num)}); ``` - so that it looks like this: -```php + +so that it looks like this: + +``` AGI(/opt/gemeinschaft/dialplan-scripts/in-get-callerid.agi,${CALLERID(num)}); Dial(SIP/${EXTEN}${pgrpdialstr},${dialtimeout}); ``` -- somewhat further down find the `to_queue:` section -- before the `Queue(…)` command (around line 912), add the line from above so that it looks like this: -```php + +* somewhat further down find the `to_queue:` section +* before the `Queue(…)` command (around line 912), add the line from above so that it looks like this: + +``` AGI(/opt/gemeinschaft/dialplan-scripts/in-get-callerid.agi,${CALLERID(num)}); Set(queue_entertime=${EPOCH}); Queue(${EXTEN},${ring_instead_of_moh},,,${queuetimeout}); @@ -33,14 +38,16 @@ Set(queue_waittime=$[${EPOCH}-${queue_entertime}]); 2. CONFIGURATION ---------------- -1. open the file `inc/CallerID/CallerID.class.php` -- find the line that reads: +* open the file `inc/CallerID/CallerID.class.php` +* find the line that reads: + ```php protected static $dataProvider = 'CSVLookup,CountryCodes'; ``` -- set your preferred order of lookup (from left to right, separated by commas) -- the first match will be used -- ignore the `$countrycode` and `$areacode` as they will be overwritten by your + +* set your preferred order of lookup (from left to right, separated by commas) +* the first match will be used +* ignore the `$countrycode` and `$areacode` as they will be overwritten by your Gemeinschaft canonization settings (make sure they are correct!) @@ -49,6 +56,7 @@ protected static $dataProvider = 'CSVLookup,CountryCodes'; #### CSVLookup - the csv-file for CSVLookup is `inc/CallerID/CSVLookup/telefonbuch.csv` - the numbers need to be formatted as your phone shows them (i.e. not in international format!) + - the asterisk ("*") wildcard is allowed #### CountryCodes - uses several official prefix lists to return country and sometimes the region of the caller