Dialplan configuration

Here is the example dialplan demonstration integration levels:

[globals]

[general]

; Set connection options for curl.
[sub-setcurlopt]
exten => _X.,1,Set(CURLOPT(conntimeout)=3)
exten => _X.,n,Set(CURLOPT(dnstimeout)=3)
exten => _X.,n,Set(CURLOPT(httptimeout)=3)
exten => _X.,n,Set(CURLOPT(ssl_verifypeer)=0)
exten => _X.,n,Return

; Get caller ID name from Odoo, replace odoo to your Odoo's hostname / IP address
; Arguments:
; - number: calling number, strip + if comes with +.
; - db: Odoo's database name, ommit if you have one db or use dbfilter.
; - country: 2 letters country code, See https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2
; If country code is omitted Asterisk Agent's Odoo account's country code will be used for phonenumbers parsing.
[sub-setcallerid]
exten => _X.,1,Gosub(sub-setcurlopt,${EXTEN},1)
;   You need to cut leading + on numbers incoming from trunks before passing it to get_caller_name.
exten => _X.,n,Set(CALLERID(name)=${CURL(http://odoo:8069/asterisk_calls/get_caller_name?number=${CALLERID(number)})})
exten => _X.,n,Return

; Get partner's manager channel if set.
[sub-dialmanager]
exten => _X.,1,Set(manager_channel=${CURL(http://odoo:8072/asterisk_calls/get_partner_manager?number=${CALLERID(number)})})
exten => _X.,n,ExecIf($["${manager_channel}" != ""]?Dial(${manager_channel}/${EXTEN},60,t))
exten => _X.,n,Return

; Call from DID numbers e.g. PSTN numbers connected to Asterisk box.
[from-sip-external]
; Set partner's caller name
exten => _X.,1,Gosub(sub-setcallerid,${EXTEN},1)
; Record call
exten => _X.,n,MixMonitor(${UNIQUEID}.wav)
; Try to connect to manager
exten => _X.,n,Gosub(sub-dialmanager,${EXTEN},1)
; Put in the Queue.
exten => _X.,n,Queue(sales)

; This macro is used to send DTMF digits on outgoing calls to partner if exten is specified.
[post-dial-send-dtmf]
exten => s,1,NoOp(DTMF digits: ${dtmf_digits})
same => n,ExecIf($["${dtmf_digits}" = ""]?Return)
same => n,Wait(${dtmf_delay})
same => n,SendDTMF(${dtmf_digits})
same => n,Return

[from-internal]
; Activate call recording.
exten => _X.,1,MixMonitor(${UNIQUEID}.wav)
; Local users calling
exten => _XXXX,2,Dial(SIP/${EXTEN},30)
; Outgoing calls pattern
exten => _XXXXX.,2,Dial(SIP/provider/${EXTEN},30,TU(post-dial-send-dtmf))

FreePBX setup

Setup and configuration videos are available here.

Installation

Docker compose deploy is the official installation method. Make sure that your docker service is set to run on boot.

Please refer to your Linux distribution documentaion on how to install docker and docker-compose.

Follow the guide below to get the Agent working.

Installation steps:

• Install docker and docker-compose system packages.
• Download docker-compose.yml. Adjust this file to your environment.
• Create addons folder in the curent directory and put there asterisk_calls, remote_agent, kv_cache and other asterisk modules you have.

The above steps as shell commands:

curl -o docker-compose.yml https://gitlab.com/odooist/asterisk_calls/snippets/1947981/raw
mkdir addons

Test run

To test start first RabbitMQ in background and Agent in foreground:

docker-compose up -d rabbitmq
docker-compose up agent

CTRL+C to interrupt.

docker-compose down

Production run

For production start the Agent as follows:

docker-compose up -d

Odoo.sh installation

The Agent uses long polling to receive call originate command from Odoo.

Odoo.sh does not allow polling from remote script so special Agent configuration is required.

Your should set the following configuration variables:

• ODOO_BUS_ENABLED=no
• WEB_SERVER_ENABLED=yes
• WEB_SERVER_ADDRESS=0.0.0.0:40000

Now your should make the Agent's port 40000 accessible from Odoo as Odoo will make HTTP requests to connect to the Agent.

Also it is strictly recommended to run a HTTPS proxy server in front of the Agent's builtin WEB server to be protected from traffic sniffing.

Required modules

• K/V Cache - this addon is included when you download Asterisk Calls from the market. But if you copy Asterisk Calls module from another place make sure you have also kv_cache installed.
• Remote Agent - same as above.

Long polling

Be sure to enable Odoo long polling feature and make sure it is working.

If You see in your Odoo logs Exception: bus.Bus unavailable message it means you did not configure it correctly.

To activate long polling and have enougth workers for this app start Odoo with at least --workers=4 or set it in odoo.conf:

[options]
workers = 4
longpolling_port = 8072

Attention! This is just an example of conf file options that must be set! Don't throw away your own options!!!

Be sure to have the following record in your Odoo startup logs:

astcall_odoo | 2018-09-10 15:37:58,920 18 INFO ? odoo.service.server: Evented Service (longpolling) running on 0.0.0.0:8072

Asterisk system account

The Asterisk Agent needs an odoo system account to work on.

During the asterisk_calls module installation a new Odoo account asterisk is created.

This is a special Odoo account with very limited access rights and of portal type to save a license on Odoo Enterprise.

It is recommented to change asterisk account password in Odoo and also adjust the Agent ODOO_PASS setting.

Set account time zone

Asterisk sends call records in its server's time zone. You should set asterisk_service account time zone in user's preferences to value set in Asterisk server.

To see time zone settings for account you should activate Odoo developer mode.

Configure users and groups

Map Odoo users with Asterisk user's extensions.

Users who use Asterisk Calls must have Asterisk Calls User permission.

For SIP users you can specify SIP alert-info header to enable auto answer feature. Check you SIP phone manuals for that.

After you mapped Odoo users with Asterisk extensions users can use click to call feature.

When you map Odoo user to Asterisk extensions in Asterisk Calls -> Users menu user is automatically added to Asterisk Calls group.

When you delete Asterisk user mapping Asterisk call permission is automatically removed from Odoo user.

Notice! After you change user extensions mapping reload the WEB client (press F5) to catch the change!