PHP Example

This example written in PHP allows users to manage VoipNow accounts and fetch call statistics.

How To Install It

Setup

Please follow these steps:

STEP 1: Files are located in our GitHub repository. Copy the files using:

git clone https://github.com/4psa/systemapi-example-php.git

STEP 2: Extract the files and copy them to a directory that can be accessed over the Web.

STEP 3: In order to use the tool, you must configure it. To do so, please open the config.php file located in the <PATH_TO_SYSTEMAPI_PHP_TOOL>/config directory, and set the variables as explained below.

STEP 4: Set the $voipnow_ip variable to the IP or hostname of your VoipNow server.

How To Use It

Authentication

Every SOAP request needs to contain the credentials in order to authenticate a user to the SystemAPI.

Set the $voipnow_access_token in the configuration file to the oauth token of the account you want to use.

Examples

To access the interface, simply visit https://<IP>/<PATH_TO_SYSTEMAPI_TOOL>/index.php.

Please note that you cannot access the application unless you have set it up before. Otherwise, you will receive a warning message with the issues you need to fix, just as shown below:

Once the configuration process is complete, you can access the interface and use the following features:

• Adding accounts - allows you to add service providers, organizations, users and extensions;
• Call costs - allows you to fetch statistics for certain accounts.

Add Accounts

In this section of the application, you can add accounts to VoipNow. The following information can be set using the form:

Set the $account_type in the configuration file to the account type you want to add:

• If you want to add a Service Provider account, you can set the variable $account_type = "service provider", or simply select this account type in the form.
• If you want to add an Organization account, you must set the $serviceprovider_id to the ID of the service provider that owns the new organization. You can set the variable $account_type = "organization", or simply select this account type in the form.
• If you want to add a User account, you must set the $organization_id to the ID of the organization that owns the new user.You can set the variable $account_type = "user", or simply select this account type in the form.
• If you want to add an Extension account, you must set the $user_id to the ID of the user that owns the new extension. You can set the variable $account_type = "extension", or simply select this account type in the form.

To create a user by means of a template, you must set the configuration variable $template_id to a valid VoipNow template ID. The SystemAPI web service allows you to get the list of all the templates in the system by calling GetTemplates, an operation available under the PBX component. For more details on how to use this operation, please read SystemAPI documentation.

To create a user by means of a charging plan, you must set the configuration variable $billing_plan_id to a valid VoipNow charging plan ID. The SystemAPI web service allows you to get the list of all the charging plans in the system by calling GetTemplates, an operation available under the PBX component. For more details on how to use this operation, please read SystemAPI documentation.

Call Costs

By using this section of the application, you can fetch call stats for a specific user, month, and year from the VoipNow system. You can set the information using the form, as explained below: