API and AMI – VitalPBX Wiki https://wiki.vitalpbx.org Learn how our latest VitalPBX version will enhance your business communication Mon, 18 Dec 2023 14:31:16 +0000 en-US hourly 1 https://wordpress.org/?v=6.5.3 https://wiki.vitalpbx.org/wp-content/uploads/2023/11/cropped-vitalbpxwikiicon-8-32x32.png API and AMI – VitalPBX Wiki https://wiki.vitalpbx.org 32 32 Introduction https://wiki.vitalpbx.org/wiki/api-and-ami/introduction-26/ https://wiki.vitalpbx.org/wiki/api-and-ami/introduction-26/#respond Mon, 18 Dec 2023 13:41:08 +0000 https://wiki.vitalpbx.org/?post_type=docs&p=2666 You can integrate third-party applications with VitalPBX. For this, we have our API and AMI (Asterisk Management Interface) capabilities. Here, we will show you how to create the users and keys so you can integrate third-party applications with VitalPBX.

]]>
https://wiki.vitalpbx.org/wiki/api-and-ami/introduction-26/feed/ 0
API https://wiki.vitalpbx.org/wiki/api-and-ami/api/ https://wiki.vitalpbx.org/wiki/api-and-ami/api/#respond Mon, 18 Dec 2023 13:49:07 +0000 https://wiki.vitalpbx.org/?post_type=docs&p=2668 Admin […]]]> VitalPBX has an API that allows you to retrieve information from VitalPBX and any of its tenants. The VitalPBX is constantly growing and more features are added constantly. You can see our full API documentation in the following link.

https://documenter.getpostman.com/view/5481262/2s935hQmgP To create your API Key to use with third-party applications, go to Admin > Admin > Application Keys.

Here, you just need to enter a description to identify the key and select which tenant you wish to have the API connection with. You can choose a specific tenant, or select Any Tenant to be able to get API calls from any tenant.

You can enable or disable the API Key at any moment. Once done, click on Save. This will generate the API Key. If you go back to the Key you created, in the list button in the upper right-hand corner, you will see the API key you can copy and use with your third-party application.

]]>
https://wiki.vitalpbx.org/wiki/api-and-ami/api/feed/ 0
AMI (Asterisk Management Interface) https://wiki.vitalpbx.org/wiki/api-and-ami/ami-asterisk-management-interface/ https://wiki.vitalpbx.org/wiki/api-and-ami/ami-asterisk-management-interface/#respond Mon, 18 Dec 2023 13:52:44 +0000 https://wiki.vitalpbx.org/?post_type=docs&p=2671 Another way to integrate third-party applications is using the AMI or Asterisk Management Interface. This way, you can connect directly to the Asterisk layer VitalPBX uses and monitor and manage Asterisk directly. This is useful if you require real-time information to trigger events or monitor information on a third-party application.

You can see the full AMI documentation on the following link.

https://docs.asterisk.org/Configuration/Interfaces/Asterisk-Manager-Interface-AMI/ To create an AMI user in VitalPBX, go to Settings > PBX Settings > AMI Users. Here, you will create the AMI users that will connect directly with Asterisk.

You will need to define an AMI User and Secret. We generate a random password, and we recommend you use this randomly generated password for the best security. You will also need to enter a description to identify this user.

We also require you to use the Deny and Permit options for this user. With these fields, you specify the IP address or Network segment that can access Asterisk using this AMI user. It is important that you only allow the specific IP addresses that can connect to Asterisk using this AMI user as this is an extremely permissive user. An AMI user can affect your Asterisk directly, so we need to take all the precautions necessary.

You can also limit the read and write permissions, so the AMI users are only able to perform the tasks you need for your third-party application integration.

With everything set, you can Save and then Apply Changes.

With this, you are now able to connect directly with Asterisk and monitor and manage the Asterisk layer for VitalPBX from a third-party application.

]]>
https://wiki.vitalpbx.org/wiki/api-and-ami/ami-asterisk-management-interface/feed/ 0