Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

VoIP corrections #873

Merged
merged 8 commits into from
Feb 5, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/extensions/voip-integration/3cx-integration-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

## How to setup 3CX Integration for an administrator

Fill in the connection details of your 3CX server. To do this, go to the Administration (System panel) -> VoIP · 3cx.
Fill in the connection details of your 3CX server. To do this, go to the Administration (System panel) > Integrations > VoIP · 3cx.

![3CX integration config](../../_static/images/extensions/voip-integration/3cx-admin-setup.png)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ VoIP Integration extension supports* the following Asterisk servers:
## How to setup Asterisk Integration for an administrator

#### Step 1:
Fill in the connection details of your Asterisk server. To do this, go to the Administration (System panel) > VoIP » Asterisk AMI.
Fill in the connection details of your Asterisk server. To do this, go to the Administration (System panel) > Integrations > VoIP · Asterisk AMI.

![Asterisk integration config](../../_static/images/extensions/voip-integration/asterisk-admin-setup.png)

Expand All @@ -31,7 +31,6 @@ Fill in the connection details of your Asterisk server. To do this, go to the Ad
* **Port** – a port for connection through AMI interface.
* **Username** – AMI username.
* **Password** – AMI user password.
* **Version of the Asterisk server** – a version of your Asterisk server.
* **Protocol** – protocol for connection to Asterisk server (TCP, UDP, TLS).
* **Dialout Channel** – channel format for outgoing calls. It can be “PJSIP/###” (Asterisk 13+) or “SIP/###”, where ### is a user’s extension (internal number). The extension “###” will be substituted automatically depending on the user.
* **Dial Context** – context for dial actions.
Expand All @@ -41,16 +40,18 @@ Fill in the connection details of your Asterisk server. To do this, go to the Ad
* **Dial Format for outgoing calls** – a phone number format for outgoing (click-to-call) calls.
* **List of ignored numbers** – list of numbers which will be ignored. Popup window will not be displayed. Use numbers in the following formats: +14844608117 (full number match) or #4844608117# (regular expression).
* **Permitted Entities** – entities that will be displayed in popup window and will be used to identify a caller by his phone number.
* **Apply global ACL for caller lookup** – apply global ACL rules (Administration > Roles) for caller lookup. This information is displayed in the popup window. If unchecked, no ACL restrictions are used.
* **Hide a Lead** – Hide a Lead in a call popup when Account / Contact are available.
* **Display Accounts related to Contacts** – display only Accounts related to Contacts.
* **Automatically save a call** – Automatically save incoming/outgoing calls in the system without having to press "Save" button.
* **Automatically open the caller information** – automatically open the caller information for incoming/outgoing calls.
* **Access Key to EspoCRM** – an access key of EspoCRM to post data from Asterisk server.
* **Listen recorded calls** – possibility to listen recorded calls in EspoCRM.
* **URL to recorded calls** – a pattern of recorded call URLs.
* **Lines** – a prefix of phone numbers. E.g. UK phone number 702031112233 will be formatted like “7” – a line and “02031112233” – a phone number.
* **Quick Create Entities** – entities which can be created through the call popup window.
* **Active Queue Numbers** – a list of queue phone numbers which should be determined by EspoCRM.
* **Display a popup only after answering the call** – do not show incoming call popups until the user answers a call.
* **Experimental features** – test experimental features.

#### Step 2:

Expand Down
7 changes: 5 additions & 2 deletions docs/extensions/voip-integration/binotel-integration-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,24 +5,27 @@ Binotel integration is available as part of [VoIP Integration extension](https:/

## How to setup Binotel Integration for an administrator

1\. Fill in the connection details of your Binotel server. For this go to the Administration (System panel) -> VoIP » Binotel.
1\. Fill in the connection details of your Binotel server. For this go to the Administration (System panel) > Integrations > VoIP · Binotel.

![Binotel integration config](../../_static/images/extensions/voip-integration/binotel-admin-setup.png)

* **Name** – name of your Binotel connector.
* **Authorization Key** – authorization Key to the Binotel server.
* **Authorization Secret** – authorization Secret to the Binotel server.
* **Use SSL** – Use SSL for connection to the server Binotel.
* **Binotel API Version** – the version of the Binotel API which is used for integration.
* **Access Key** – the key to access to EspoCRM to handle incoming/outgoing calls.
* **Default Country** – The country is used to format phone numbers. E.g. 02011112222 for United Kingdom will be formatted to +442011112222.
* **Dial Format for outgoing calls** – Phone number format for outgoing (click-to-call) calls.
E.g. for "+44 (203) 111-22-33": {COUNTRY_CODE} - "44", {NATIONAL_NUMBER} - "2031112233".
* **List of ignored numbers** – list of numbers, which will be ignored and popup window will not be displayed. Use numbers in the following formats: +14844608117 (full number match) or #4844608117# (regular expression).
* **Permitted Entities** – entities that will be displayed in popup window and will be used to identify a caller by his phone number.
* **Apply global ACL for caller lookup** – apply global ACL rules (Administration > Roles) for caller lookup. This information is displayed in the popup window. If unchecked, no ACL restrictions are used.
* **Hide a Lead** – Hide a Lead in a call popup when Account / Contact are available.
* **Display Accounts related to Contacts** – display an account related to the contact in the popup window.
* **Automatically save a call** – automatically save incoming/outgoing calls in the system without having to press "Save" button.
* **Automatically open the caller information** – automatically open the caller information for incoming/outgoing calls.
* **Quick Create Entities** – entities which can be created through a call popup.
* **Experimental features** – test experimental features.

2\. Contact Binotel support to add an URL (see “Post URL” field) to handle incoming/outgoing calls (API CALL Settings and API PUSH):
**http://espocrm.local/?entryPoint=Binotel&connector=Binotel&key=hh9v0zr529**
Expand Down
9 changes: 6 additions & 3 deletions docs/extensions/voip-integration/iexpbx-integration-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ iexPBX integration is available as part of [VoIP Integration extension](https://

#### Step 1:

Fill in the connection details of your iexPBX server. To do this, go to the Administration (System panel) -> VoIP » iexPBX.
Fill in the connection details of your iexPBX server. To do this, go to the Administration (System panel) > Integrations > VoIP · iexPBX.

![iexPBX integration config](../../_static/images/extensions/voip-integration/iexpbx-admin-setup.png)

Expand All @@ -17,13 +17,16 @@ Fill in the connection details of your iexPBX server. To do this, go to the Admi
* **Access Key to EspoCRM** – the key to access to EspoCRM to handle incoming/outgoing calls.
* **Default Country** – the country is used to format phone numbers.
* **Dial Format for outgoing calls** – a phone number format for outgoing (click-to-call) calls.
* **Call Recording** – if you want to have possibility to listen recorded calls. This option should also be enabled in your telephony server.
* **List of ignored numbers** – list of numbers which will be ignored. Popup window will not be displayed. Use numbers in the following formats: +14844608117 (full number match) or #4844608117# (regular expression).
* **Permitted Entities** – entities that will be displayed in the popup window and will be used to identify a caller by his phone number.
* **Hide a Lead** – Hide a Lead in a call popup when Account / Contact are available.
* **Apply global ACL for caller lookup** – apply global ACL rules (Administration > Roles) for caller lookup. This information is displayed in the popup window. If unchecked, no ACL restrictions are used.
* **Hide a Lead** – hide a Lead in a call popup when Account / Contact are available.
* **Display Accounts related to Contacts** – display only Accounts related to Contacts.
* **Automatically save a call** – Automatically save incoming/outgoing calls in the system without having to press "Save" button.
* **Automatically save a call** – automatically save incoming/outgoing calls in the system without having to press "Save" button.
* **Automatically open the caller information** – automatically open the caller information for incoming/outgoing calls.
* **Quick Create Entities** – entities which can be created through the call popup window.
* **Experimental features** – test experimental features.

#### Step 2:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,24 +24,27 @@ VoIP Integration extension supports* the following Starface servers:

## How to setup Starface Integration for an administrator

Fill in the connection details of your Starface server. To do this, go to the Administration (System panel) -> VoIP » STARFACE.
Fill in the connection details of your Starface server. To do this, go to the Administration (System panel) > Integrations > VoIP · STARFACE.

![Starface integration config](../../_static/images/extensions/voip-integration/starface-admin-setup.png)

* **Name** – name of your connection.
* **Host** – IP or domain name of your Starface Server.
* **Host of Starface server** – IP or domain name of your Starface Server.
* **Port** – port for connection by AMI interface.
* **Protocol** – protocol that is used for connection of Starface server (HTTP, HTTPS).
* **Version of your Starface server** – version of your Starface server. This is an important option since Starface 6.4.2 is used a new authorization protocol.
* **Access Key to EspoCRM** – the key to access to EspoCRM to handle incoming/outgoing calls.
* **Default Country** – the country is used to format phone numbers.
* **Dial Format for outgoing calls** – a phone number format for outgoing (click-to-call) calls.
* **List of ignored numbers** – list of numbers which will be ignored. Popup window will not be displayed. Use numbers in the following formats: +14844608117 (full number match) or #4844608117# (regular expression).
* **Permitted Entities** – entities that will be displayed in the popup window and will be used to identify a caller by his phone number.
* **Apply global ACL for caller lookup** – apply global ACL rules (Administration > Roles) for caller lookup. This information is displayed in the popup window. If unchecked, no ACL restrictions are used.
* **Hide a Lead** – Hide a Lead in a call popup when Account / Contact are available.
* **Display Accounts related to Contacts** – display only Accounts related to Contacts.
* **Automatically save a call** – Automatically save incoming/outgoing calls in the system without having to press "Save" button.
* **Automatically open the caller information** – automatically open the caller information for incoming/outgoing calls.
* **Quick Create Entities** – entities which can be created through the call popup window.
* **Experimental features** – test experimental features.

## How to setup Starface Integration for users

Expand Down
9 changes: 6 additions & 3 deletions docs/extensions/voip-integration/twilio-integration-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ There are two ways in which you can set up Twilio integration:

1. Login to your Twilio account. If you have never used Twilio before, then create the account and purchase a phone number if needed.
2. Login as Administrator in EspoCRM.
3. Navigate to the Administration > VoIP Settings > VoIP » Twilio.
3. Navigate to the Administration (System panel) > Integrations > VoIP · Twilio.
4. Tick off Enabled box.
5. Fill in the connection details of your Twilio account.

Expand All @@ -30,19 +30,23 @@ There are two ways in which you can set up Twilio integration:
* **Enabled SIP Domains** – the list of enabled Twilio SIP domains which are used in EspoCRM.
* **List of ignored numbers** – list of numbers which will be ignored. Popup window will not be displayed. Use numbers in the following formats: +14844608117 (full number match) or #4844608117# (regular expression).
* **Permitted Entities** – entities that will be displayed in the popup window and will be used to identify a caller by his phone number.
* **Apply global ACL for caller lookup** – apply global ACL rules (Administration > Roles) for caller lookup. This information is displayed in the popup window. If unchecked, no ACL restrictions are used.
* **Hide a Lead** – Hide a Lead in a call popup when Account / Contact are available.
* **Display Accounts related to Contacts** – display only Accounts related to Contacts.
* **Automatically save a call** – automatically save incoming/outgoing calls without having to press “Save” button.
* **Automatically open the caller information** – automatically open the caller information for incoming/outgoing calls.
* **Quick Create Entities** – entities which can be created through the call popup window.
* **Call Transfer Entities** – the list of entities used for call transfer.
* **Transfer Timeout** – the number of seconds the customer has to wait for an agent to answer the transferred call.
* **Experimental features** – test experimental features.

## How to configure routing of Twilio phone numbers

After you have successfully filled in the connection details, EspoCRM will import all active Twilio phone numbers (wait a few minutes the first time).

1. **Configure Routing**

To configure Twilio phone number routing, go to Administration > VoIP Routing and select the phone number.
To configure Twilio phone number routing, go to Administration > VoIP Trunks and select the phone number.

![Twilio Routers](../../_static/images/extensions/voip-integration/twilio-routing.png)

Expand All @@ -60,7 +64,6 @@ After you have successfully filled in the connection details, EspoCRM will impor
* **Display the router's phone number as a caller** – display the office phone number (VoIP Router phone number) as caller.
* **Team Users** – a list of users to configure receiving incoming/outgoing calls, SMS and MMS.


2. **Grant access for Twilio Team members**

Go to Administration > Roles, create a Role for a Team of Twilio members (defined above) and grant access to the following entities: Calls, Messages, Accounts, Contacts, Leads.
Expand Down