Mr. VoIP
← Free 3CX API

Mr. VoIP API Configuration Guide

How to download and configure your forever free 3CX APIs by Mr. VoIP. A quick how-to guide.

Get your Free 3CX API

  1. 1

    Visit https://www.mrvoip.com/call-center-customization/3cx-api/

  2. 2

    Click on the “Free 3CX API” button.

  3. 3

    Fill in the form and click submit.

  4. 4

    An OTP will be sent to the email address provided.

    Email from the Mr.VoIP API team containing the one-time verification code for your free API trial, which expires in 10 minutes
  5. 5

    Enter the OTP in the registration form and click submit again.

    Registration form with the OTP field filled in and the Submit button highlighted
  6. 6

    A message prompt will display in the screen, notifying you that your account is being created.

    Pop-up reading “Welcome To Mr.VoIP API. The process will take some time, please do not close the window”
  7. 7

    Once the account creation is done it will show the success message.

    Success pop-up confirming the account was created and asking you to check your email for further details
  8. 8

    Check your inbox for your welcome email which contains some simple steps to finalize your configuration.

Configuring Mr. VoIP on your 3CX Server

  1. 1

    Open the welcome email and follow the process step by step.

    Welcome email with your login credentials, the firewall ports to allow, and the steps to configure Mr. VoIP on your 3CX server
  2. 2

    Make sure the below port numbers are allowed in the firewall.

    Firewall ports to be allowed in the 3CX server before installation: OmniChannel (HTTPS) on TCP/4001 and Mr.VoIP on TCP/4040
  3. 3

    Open putty and login to your 3CX server with root credentials.

  4. 4

    Now copy and paste the installation command in the putty and press enter.

    Welcome email step with the install command highlighted: wget https://omni.mconnectapps.com/api/webrtc/mrvoipapiSetup.sh && bash mrvoipapiSetup.sh
    PuTTY terminal logged in as root with the command wget https://omni.mconnectapps.com/api/webrtc/mrvoipapiSetup.sh && bash mrvoipapiSetup.sh typed at the prompt
  5. 5

    Enter the FQDN name which you registered and press enter.

    PuTTY installer prompting for the 3CX domain name, with the FQDN typed in
  6. 6

    Now copy paste the company name as it was sent in the welcome email and press enter.

    PuTTY installer prompting for the company name, with the company name typed in
  7. 7

    Upon successful installation the success message is shown.

    PuTTY output showing the “Installed Successfully” banner and the OmniChannel URL on port 4001

Logging in

  1. 1

    Login Omni channel using the credentials in the welcome email.

    Customer contact information from the welcome email: login URL, company, username, masked password, contact, email and country
  2. 2

    Copy paste the Login URL in the browser and enter the company name, user name and password to login the Omni channel.

    Omni Channel password login page with company name, username and password fields
  3. 3

    Once logged in click Mr.VoIP API in the left side menu. There you can see the free and paid API list.

    Mr.VoIP API page in Omni Channel listing each API with a Free or Buy Now label
  4. 4

    In every free API list there will be an icon which will redirect us to a knowledge base which contains the API functionality calling procedures.

    List of available APIs with the knowledge-base book icon next to Make Call highlighted
    Help Docs knowledge-base article for the Make Call API, showing the request URL, request method and a Generate API panel
  5. 5

    In the knowledge base you can find the Request URL, Request Method, Request Parameters and Possible Errors.

  6. 6

    In the right side of the knowledge base there will be a Generate API which helps you to generate the API request to your preferred language. For that you need to give the FQDN, action and request parameters and click generate.

    Generate API form with the PBX URL, action, from number and to number filled in
  7. 7

    After clicking the generate button the API request will be convert to preferred languages. It will also show the sample response how the actual response will be.

    Generated cURL sample request and sample JSON response for the Make Call API, with Curl and PHP tabs
  8. 8

    Once you buy the paid API it will show the API calling procedure and the expiry date.

    API list showing which APIs are free and which are paid, with the days left until each paid API expires

Ready to get your free APIs?

It's super easy and requires no upfront commitment. Fill in the form and you'll receive an email with instructions on setting up and configuring your APIs.

Get your free APIs