1.13 VSM4 APi (Pro license)

NOTE : The API is accessible only for customers with VSM4 Pro licenses!!!

How to access and use the API:

For security reasons, access to all methods is protected by the HTTP mechanism, i.e. basic authentication. Additionally, access to the API is secured with an SSL (Secure Sockets Layer)certificate.

Main VSM4 admin account can be used to access the API or separate account can be created.

API Direct URL https://your domain name/vsm4/api

API can be accessible from the browser using this url https://your domain name/vsm4/Docs/  and each of the method can be tested separately.

If you want to check any of the method available on the Doc site. You need to enter basic authentication details first.

For the reference please see the below screenshot:

Sample request1: 

/OwnerClientsRetail/GetClientsRetailsSimpleList

This method  return a list of all retail clients (it can be filtered with * sign), inf format: ID of the retail client and login (name):

Sample request2: 

/OwnerCdrs/GetCdrsList

This method return CDR from all the type of accounts (use filters if you want to return specific CDR for specific time period or for a specific user etc...)

Below example return CDR for all type of clients for a specific time period 

Below is the request :

curl -X 'GET' \
'https://test.voipswitch.link/vsm4/api/OwnerCdrs/GetCdrsList?draw=0&start=0&length=10&clientType=-1&billingType=calls&status=completed&dateFrom=2023-11-21&dateTo=2023-11-28&tariffId=-1&routeType=-1' \
-H 'accept: application/json' \
-H 'authorization: Basic xxxxxxxxxxxx'