diff --git a/docs/_static/images/extensions/voip-integration/detailed-twilio-buyNumber.png b/docs/_static/images/extensions/voip-integration/detailed-twilio-buyNumber.png new file mode 100644 index 000000000..c9371ab57 Binary files /dev/null and b/docs/_static/images/extensions/voip-integration/detailed-twilio-buyNumber.png differ diff --git a/docs/_static/images/extensions/voip-integration/detailed-twilio-espoUser.png b/docs/_static/images/extensions/voip-integration/detailed-twilio-espoUser.png new file mode 100644 index 000000000..4d3e3cb6a Binary files /dev/null and b/docs/_static/images/extensions/voip-integration/detailed-twilio-espoUser.png differ diff --git a/docs/_static/images/extensions/voip-integration/detailed-twilio-espoUserCallForwarding.png b/docs/_static/images/extensions/voip-integration/detailed-twilio-espoUserCallForwarding.png new file mode 100644 index 000000000..3c23084e5 Binary files /dev/null and b/docs/_static/images/extensions/voip-integration/detailed-twilio-espoUserCallForwarding.png differ diff --git a/docs/_static/images/extensions/voip-integration/detailed-twilio-getStarted.png b/docs/_static/images/extensions/voip-integration/detailed-twilio-getStarted.png new file mode 100644 index 000000000..8dae00d04 Binary files /dev/null and b/docs/_static/images/extensions/voip-integration/detailed-twilio-getStarted.png differ diff --git a/docs/_static/images/extensions/voip-integration/detailed-twilio-sipCredList.png b/docs/_static/images/extensions/voip-integration/detailed-twilio-sipCredList.png new file mode 100644 index 000000000..131d99ec7 Binary files /dev/null and b/docs/_static/images/extensions/voip-integration/detailed-twilio-sipCredList.png differ diff --git a/docs/_static/images/extensions/voip-integration/detailed-twilio-sipSearch.png b/docs/_static/images/extensions/voip-integration/detailed-twilio-sipSearch.png new file mode 100644 index 000000000..5205a230d Binary files /dev/null and b/docs/_static/images/extensions/voip-integration/detailed-twilio-sipSearch.png differ diff --git a/docs/_static/images/extensions/voip-integration/detailed-twilio-sipURL.png b/docs/_static/images/extensions/voip-integration/detailed-twilio-sipURL.png new file mode 100644 index 000000000..e6488245f Binary files /dev/null and b/docs/_static/images/extensions/voip-integration/detailed-twilio-sipURL.png differ diff --git a/docs/extensions/voip-integration/step-by-step-twilio-Call-forwarding-configuration.md b/docs/extensions/voip-integration/step-by-step-twilio-Call-forwarding-configuration.md new file mode 100644 index 000000000..14f82863d --- /dev/null +++ b/docs/extensions/voip-integration/step-by-step-twilio-Call-forwarding-configuration.md @@ -0,0 +1,29 @@ +# Detailed Twilio Call forwarding configuration guide + +1. Create Twilio Account: https://www.twilio.com/try-twilio + +![Twilio welcome page](../../_static/images/extensions/voip-integration/detailed-twilio-getStarted.png) + +2. In the list on the left, go to United States (US1) (or any other country) > Phone Numbers > Manage > Active Numbers and buy a number by pressing the *Buy a number* button in the upper-right corner. + +![Twilio buy number](../../_static/images/extensions/voip-integration/detailed-twilio-buyNumber.png) + +3. Go to your instance of EspoCRM, click the three dots in the top-right corner and select your User. Paste your real phone number into Phone field. + +![Twilio User personal phone number](../../_static/images/extensions/voip-integration/detailed-twilio-espoUserCallForwarding.png) + +4. In your EspoCRM instance, go to Administration > Integrations > VoIP » Twilio and configure everything as follows: [How to configure Twilio Integration for an administrator](twilio-integration-setup.md#how-to-configure-twilio-integration-for-an-administrator) + +5. Click *Test Connection* button and save the Connector. + +6. In the EspoCRM instance configure VoIP Router as indicated in the following instructions: [How to configure routing of Twilio phone numbers](twilio-integration-setup.md#how-to-configure-routing-of-twilio-phone-numbers) + +## How to test the connection +To test the connection, you need two real phone numbers: one that you've just entered in the User phone number field and another that you will call. +1. Create a Contact record. Paste your second real phone number into the phone number field. +2. Make a call from your EspoCRM instance by clicking the Contact's phone number. Accept the call on first phone number and wait for the call to reach the second number. +Two separate numbers should be used to test the connection properly. + +!!! note + + If the call drops, check Twilio's *Voice Geographic Permissions*: https://console.twilio.com/us1/develop/voice/settings/geo-permissions. Mark your country with a checkbox and click on the *Save* button. diff --git a/docs/extensions/voip-integration/step-by-step-twilio-SIP-configuration.md b/docs/extensions/voip-integration/step-by-step-twilio-SIP-configuration.md new file mode 100644 index 000000000..45d658ce3 --- /dev/null +++ b/docs/extensions/voip-integration/step-by-step-twilio-SIP-configuration.md @@ -0,0 +1,39 @@ +# Detailed Twilio SIP Trunk configuration guide + +1. Create Twilio Account: https://www.twilio.com/try-twilio + +![Twilio welcome page](../../_static/images/extensions/voip-integration/detailed-twilio-getStarted.png) + +2. In the list on the left, go to United States (US1) (or any other country) > Phone Numbers > Manage > Active Numbers and buy a number by pressing the *Buy a number* button in the upper-right corner. + +![Twilio buy number](../../_static/images/extensions/voip-integration/detailed-twilio-buyNumber.png) + +3. Search for the word `sip` and go to *Voice SIP Domains*, then press the **plus** button to create SIP Domain. + +![Twilio sip search](../../_static/images/extensions/voip-integration/detailed-twilio-sipSearch.png) + +4. Enter a Friendly Name for your SIP Domain, its SIP URL, then create a Credential List by pressing **plus** button in *Voice Authentication* section. In the *SIP Registration* section, click the Disable slider to enable it, and select the Credential List you created. SIP URL and SIP Credentials usernames will be used in the following points to connect the user to the SIP client and more. + +![Twilio friendly name/URL](../../_static/images/extensions/voip-integration/detailed-twilio-sipURL.png) +![Twilio friendly name/URL](../../_static/images/extensions/voip-integration/detailed-twilio-sipCredList.png) + +5. Go to your instance of EspoCRM, click the three dots in the top-right corner and select your User. Paste the following value into Phone field in the following format: `credential_username@SIP_URL.sip.twilio.com`. It should look something like this (it is important that the Phone type is SIP, as in the screenshot): + +![Twilio friendly name/URL](../../_static/images/extensions/voip-integration/detailed-twilio-espoUser.png) + +6. In your EspoCRM instance, go to Administration > Integrations > VoIP » Twilio and configure everything as follows: [How to configure Twilio Integration for an administrator](twilio-integration-setup.md#how-to-configure-twilio-integration-for-an-administrator) + +7. Additionally, set the *Enabled SIP Domain* value. If the previous steps were completed correctly, available options will be displayed as a drop-down menu. + +8. Click *Test Connection* button and save the Connector. + +9. In the EspoCRM instance configure VoIP Router as indicated in the following instructions: [How to configure routing of Twilio phone numbers](twilio-integration-setup.md#how-to-configure-routing-of-twilio-phone-numbers) + +## How to test the connection + +1. Log in to any convenient SIP client (for example, Zoiper, Linphone, Jami or any other) using the credentials created earlier, where the username will be in the `credential_username@SIP_URL.sip.twilio.com` format, the password is the one you specified for this credential. +2. Make a call from your EspoCRM instance by clicking on the phone number, accept the call in the SIP client and wait for the call to reach the desired number. Two separate numbers should be used to test the connection properly + +!!! note + + If the call drops, check Twilio's *Voice Geographic Permissions*: https://console.twilio.com/us1/develop/voice/settings/geo-permissions. Mark your country with a checkbox and click on the *Save* button. diff --git a/docs/extensions/voip-integration/twilio-integration-setup.md b/docs/extensions/voip-integration/twilio-integration-setup.md index 5b56adc89..99a0b6b95 100644 --- a/docs/extensions/voip-integration/twilio-integration-setup.md +++ b/docs/extensions/voip-integration/twilio-integration-setup.md @@ -99,30 +99,11 @@ Make sure that your users have the access to the entity 'Calls'. * [Grant access to Calls](customization.md#grant-access-to-calls) -## How to configure SIP Domains +## Detailed Twilio SIP Trunk Configuration Guide +For a step-by-step Twilio SIP Trunk implementation, please refer to the [Step-by-step Twilio SIP Trunk configuration guide](step-by-step-twilio-SIP-configuration.md). -1. Configure a SIP domain in Twilio: - - 1. Login to your Twilio account. - 2. Go to Twilio SIP Domains by clicking in the menu on the left side and select “Programmable Voice” option or just click the link: https://www.twilio.com/console/voice/sip/endpoints. - - ![Twilio SIP Domains](../../_static/images/extensions/voip-integration/twilio-sip-domains.png) - - 3. The next thing to do is to create a SIP Domain. To do that, select Domains option in the menu on the left side and press “+” button. - - ![Twilio add SIP domains](../../_static/images/extensions/voip-integration/twilio-add-sip-domain.png) - - 4. In the next window, you have to set up the domain configuration. Set the domain name (Friendly name), create your custom SIP URL, create Credential list for Voice Authentication, enable SIP Registration (by default its disabled), select Credential lists (created for Voice Authentication) and click Save. - - ![Twilio SIP configuration](../../_static/images/extensions/voip-integration/twilio-sip-domain-configuration.png) - -2. Enable this SIP Domain in EspoCRM connector: - - 1. Login as Administrator in EspoCRM. - 2. Navigate to the Administration > VoIP Settings > VoIP » Twilio. - 3. Select your custom SIP URL from the “Enable SIP Domains” field. - - ![Twilio enable SIP domain](../../_static/images/extensions/voip-integration/twilio-enable-sip-domain.png) +## Detailed Twilio Call forwarding Configuration Guide +For a step-by-step Twilio Call forwarding implementation, please refer to the [Step-by-step Twilio Call forwarding configuration guide](step-by-step-twilio-Call-forwarding-configuration.md). ## More Twilio settings for users