Yeastar module settings

To configure the integration application, find the “Yeastar S” item in the left menu of your Bitrix24 in the “Applications” section.

In the “Yeastar S” application, go to the “Settings” tab and fill in the settings blocks described below.

Setting up integration from the Bitrix24 side includes 4 steps:

1. Settings of the connection to AMI Yeastar

   

   Setting	Description
   IP-Address of the Application	Сurrent IP address of the integration application server.
   Integration via API	When setting up the integration via AMI (for Yeastar S20), this parameter should not be selected. The manual for settings the integration via API is here.
   Functioning of the Event-Listener Yeastar	This indicator shows the connecting status of the integration module to your IP-PBX Yeastar. After saving the settings, the integration module connects to your IP-PBX Yeastar (provided that the settings block for connection to AMI is green) not immediately, but within 1 minute. If after some minutes after saving the settings (you need to manually reload the module integration page in browser) the green indicator does not appear – it is recommended to restart the PBX.
   AMI settings for connecting to Yeastar	This indicator shows the status of AMI connection of your IP-PBX to the application server. The green status indicates that connection port to AMI is opened, and the specified data for connecting to AMI are relevant.
   Host	Your external static IP address through which your IP PBX is accessible
   Port	5038 is a standard port for access to AMI, do not change it
   Login and password	Fill in the Username and the Password specified by you in the Network services settings. By default (if you do not change the settings) the login is admin, the password is password.

   Note

   If your IP-PBX temporarily was unavailable or was reloaded, it is necessary to re-connect manually the integration port to IP-PBX by clicking “Save” button at the bottom of the settings page. If you don’t do it, the integration module will automatically re-connect to the IP-PBX 10 minutes after the events from your IP-PBX will stop to come.

2. Settings of the FTP access to Yeastar

   

   • host – your external static IP address through which your IP PBX is accessible
   • port – 21 is a standard port for access to FTP
   • login – standard login: support
   • password – standard password or new password. See setting up an FTP access.
   • Passive FTP mode – check this option if you experience errors connecting to FTP or if call recordings are not loading.
   • Path to folders with records files * – standard path when storing call recording files on an SD card inserted into an IP PBX /ftp_media/mmc/autorecords/

   Note

   * Shows an example of the field “Path to the folder with records files” for the case, when the conversation records are stored on the card inserted into в IP-PBX TF/SD: /ftp_media/mmc/autorecorders/

   Note

   If the conversation records of your IP-PBX are stored on the separate network drive, it is necessary to arrange FTP access to this network drive and set the appropriate access parameters to the FTP server.

   In this case, the path /autorecords/ should be set in the field “path to the folder with records files”, because when connecting your IP-PBX via FTP, it will automatically create the /autorecords/ folder in the connected folder and will store all call records there.

3. Settings of the CDR Yeastar database access

   

   • host — your external static IP address at which IP-PBX is available
   • port — 3306 is a standard port for access to the database, do not change it
   • Login and password — enter the user name and the password specified by you in database access settings.

4. Settings of the internal numbers of the employees

   In the section “employees’ internal numbers” enter the short internal numbers of the employees, who use Bitrix24 CRM. Enter only one number in each field. Integration will work only with internal numbers specified in this section.

   

   The standard version of the module supports the integration of up to 30 internal numbers. However, the number of internal numbers can be expanded.