Skip to main content
Skip table of contents

CX Voice Upgrade to 4.7

Voice Connector

Voice Connector
  1. SSH onto the Debian server on which the Voice connector is installed.

    1. Use command

      CODE
      ssh <username>@<server-ip>
    2. Enter user password and press ENTER.

    3. Use command

      CODE
      su
    4. Enter root password and press ENTER.

  2. Run the command to see the list of running containers

    CODE
    docker ps
  3. Note the container ID of the current deployed 4.6 Voice connector.

  4. Note the port of that container i.e. for 0.0.0.0:8116->8080/tcp, :::8116->8080/tcp, the port of the container is 8116.

  5. Run the command to stop the container

    CODE
    docker stop <container-ID>
  6. Run the command to remove the container

    CODE
    docker rm <container-ID>
  7. Navigate to the folder where the docker-compose.yml and env.txt files are located for the voice connector.

  8. Open the docker-compose.yml file and replace the text inside with text below:

    CODE
    version: "3.8"
    services:
      voice-connector:
        image: gitimages.expertflow.com/freeswitch/ecx_generic_connector:4.7
        deploy:
          resources:
            limits:
              memory: 1024m
            reservations:
              memory: 256m
        container_name: unified-voice-connector
        ports:
          - PORT:8080
        env_file:
          - ./env.txt
        command: ["java", "-Xms256m", "-Xmx1024m", "-XX:+UseG1GC", "-XX:MinHeapFreeRatio=10", "-XX:MaxHeapFreeRatio=30", "-jar", "/app/ecx_generic_connector.jar"]
        restart: always
  9. Replace the PORT keyword with the port noted above in step 4.

  10. Run the command

    CODE
    docker compose up -d
  11. Confirm that the docker container is running by using the command

    CODE
    docker ps
    Untitled-20240207-065334.png
  12. Confirm that the container is running correctly by opening the logs with command

    CODE
    docker logs -f containerID
    Untitled-20240207-065355.png

Media Server configuration

Scripts
  1. SSH onto the Debian server on which the Voice connector is installed.

    1. Use command

      CODE
      ssh <username>@<server-ip>
    2. Enter user password and press ENTER.

    3. Use command

      CODE
      su
    4. Enter root password and press ENTER.

  2. Confirm git is installed, and install it if is not.

  3. Clone the Media Server scripts repository:

    CODE
    git clone -b 4.7 https://efcx:RecRpsuH34yqp56YRFUb@gitlab.expertflow.com/rtc/freeswitch-scripts.git
  4. Navigate to the cloned repository to access the files:

    CODE
    cd freeswitch-scripts
  5. Move set_recording_name.lua, cx_hangup.lua and vcApi.lua to the Media Server scripts folder:

    CODE
    mv consult_conf.lua set_recording_name.lua cx_hangup.lua vcApi.lua /usr/share/freeswitch/scripts/
    chmod -R 777 /usr/share/freeswitch/scripts/
  6. Edit the configuration scripts of your specific DNs i.e. for a DN of 1555 the configuration script will be named cx_env1555.lua.

    CODE
    vi /usr/share/freeswitch/scripts/cx_env1555.lua
  7. Edit the value of the field voiceConnectorApi such that it matches the format: “http://VC-IP:VC-PORT” i.e. for a Voice Connector deployed on server 192.168.1.120, using the docker container port 8115, the value of voiceConnectorApi will be "http://192.168.1.120:8115".

  8. Save the file.

Changes in conference profile
  • Login to Media Server web interface. 

    • Open in browser: https://IP-addr, where IP-addr is the IP address of the Media Server.

  • Add the username and password that was shown upon installation of Media Server and press LOGIN.

  • Press the IP address in the top right and select the Domain being used.:

  • Open the Conference Profiles section under the Applications tab:

image-20240822-053906.png
  • Open the profile named default:

image-20240822-054148.png
  • Under the Profile Parameters, find the caller-controls keyword under the Name column and click the checkbox:

image-20241203-072119.png
  • Press TOGGLE in the top right and choose CONTINUE in the prompt shown.

image-20241203-072152.png
  • Save the changes by pressing SAVE button in top right corner.

Changes in Call Recording Dialplan
  • Login to Media Server web interface. 

    • Open in browser: https://IP-addr, where IP-addr is the IP address of the Media Server.

  • Add the username and password that was shown upon installation of Media Server and press LOGIN.

  • Press the IP address in the top right and select the Domain created in the Domain creation section above:

  • Open the Dialplan Manager section under the Dialplan tab.

  • Find and open the user_record dialplan.

  • Add the following data to the table(ignore any data already added), such that the final version looks like the image below:

Tag

Type

Data

Inline

Group

Order

Enabled

action

set

record_path=${recordings_dir}/${domain_name}/archive/${strftime(%Y)}/${strftime(%b)}/${strftime(%d)}

true

9

10

true

action

export

record_path=${recordings_dir}/${domain_name}/archive/${strftime(%Y)}/${strftime(%b)}/${strftime(%d)}

true

9

15

true

action

set

record_name=${uuid}.${record_ext}

true

9

20

true

action

mkdir

${record_path}

-

9

25

true

action

set

recording_follow_transfer=false

true

9

30

true

action

export

recording_follow_transfer=false

true

9

35

true

action

set

record_append=false

true

9

40

true

action

set

record_in_progress=true

true

9

45

true

action

set

RECORD_ANSWER_REQ=true

-

9

50

true

action

lua

set_recording_name.lua

-

9

55

true

action

export

${recording_command}

-

9

60

true

action

set

recording_filename=${recording_filename}

-

9

65

true

image-20241211-095349.png

  • Save the changes by pressing SAVE button in top right corner.

Changes in conference Dialplan
  • Login to Media Server web interface. 

    • Open in browser: https://IP-addr, where IP-addr is the IP address of the Media Server.

  • Add the username and password that was shown upon installation of Media Server and press LOGIN.

  • Press the IP address in the top right and select the Domain created in the Domain creation section above:

  • Open the Dialplan Manager section under the Dialplan tab.

  • Find and open the CustomConf dialplan.

  • Add the following information to this dialplan:

Tag

Type

Data

Group

Order

Enabled

action

set

absolute_codec_string=G7221@32000h,G7221@16000h,G722,PCMU,PCMA

0

31

true

action

export

absolute_codec_string=G7221@32000h,G7221@16000h,G722,PCMU,PCMA

0

32

true

image-20250101-060339.png
  • Save the changes by pressing SAVE button in top right corner.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.