Before you start installing and configuring the SIP client, check your equipment. You will need the following:

  • PBX (private branch exchange) – make sure everything is set up in advance, as you will need the username and password of the telephony user
  • PCMA and PCMU audio codecs of the G.711 standard. The rest is under development.

Install and configure the SIP client. To do this:

  1. Download the application installation file setup-sipclient-1.0.3.028.exe
  2. Run the installer
  3. The installation window will open. Click the Install button.
  4. A download window will open. Wait for the program to install.
  5. After the download is complete, click the Finish button in the window that appears.
  6. Go to the location of the installed file and open the SIPClient folder
    By default, the program is installed in the folder C:\Program Files (x86)\SIPClient
  7. Find the following two files: appsettings.json and appsettings_demo_cloud.json
  8. Move contents from appsettings_demo_cloud.json to appsettings.json with replacement
    If the system does not allow you to save changes, use Notepad++, launched as Administrator
  9. Fill in the SIP block in the appsettings.json file:
    • "Address": "IP address", — fill in based on your telephone system
    • "Port": "Port number", — fill in based on your telephone system
    • "Login": "SIP account", — fill in based on your telephone system
    • "Password": "SIP password" — fill in based on your telephone system
      The data depends on the PBX used, the example below shows an example of configurations for Mango telephony.
  10. In the Application block, find the line and enter the value:
    "AnswerURL": "https://delivery.ucs.ru/manager/guests/{phone}",
  11. Save the settings you made
  12. Run the SipekPhoneSrv.exe application, but not as administrator
  13. If necessary, check the application startup in the task manager. The application is called SipekPhoneSrv

The SIP client is installed and configured, you can start accepting orders.

If you make any changes to the appsettings.json file, please remember to restart the SipekPhoneSrv application.

Example settings

{
  "SIP": {
    "Address": "sip.ip",
    "Port": "5060",
    "Login": "sip_login",
    "Password": "sip_password",
    "ThreeStepAuth": true
  },
   "SIPClient": {
    "Address": "localhost",
    "Port":  "5555"
  },
  "Cash": {
    "CashID": ""
  },
  "Delivery": {
    "Address": "",
    "Port": "",
    "Path": "/api/sip/incoming"
  },
  "Application": {
    "RingingFilename": "Resources\\Sounds\\Ringing.wav",
    "UseUI": "true",
    "AnswerURL": "https://delivery.ucs.ru/manager/guests/{phone}",
    "HangupURL": "",
    "MissedURL": ""
     
  }
 
}

Description of parameters

Parameters

Description

Connection parameters to PBX
AddressAddress
PortPort 
LoginLogin
PasswordPassword
ThreeStepAuthProcessing three-step authorization
The port to which commands from the delivery server are sent: pick up the phone, drop the call
AddressAddress
PortPort
The cash register to which the notification is sent
CashIDCash register ID, do not specify
Delivery server 
AddressAddress, do not specify
PortPort, do not specify
PathPath
Sound signal
RingingFilenameFile name