Integration guide for 3rd party application with VAC PBX
This guide provides instructions for integrating a 3rd Party Application
with a VAC PBX. The integration involves using various APIs provided by the
VAC Team and the 3rd Party Application to enable seamless communication
and data exchange. Below are the steps for each API integration:
API Details:
1. Click to call
a. URL:
https://vacpbxip/VAC/API/api.php?from=XXXX&to=YYYYYYY&o
peration=dial
b. Method: GET
c. Params:
i. from – Extension Number.
ii. to – Customer Number
d. Explanation : This functionality helps to trigger the call directly
from the 3rd Party Application by clicking.
2. Incoming Call - Popup
a. 3rd Party Team should provide the API to open a Call Popup.
b. Explanation: This function helps to open CRM Popup while
receiving incoming calls.
a. 3rd Party Team should provide the API to post the incoming Call
Details after call is completed.
b. Explanation: This function helps to send the incoming calling
details to 3
rd Party application.
a. 3rd Party Team should provide the API to post the outgoing Call
Details after the call is completed.
b. Explanation: This function helps to send the outgoing calling
details to 3rd Party application.
a. 3rd Party Team should provide the API to post the missed calls
after the call is dropped.
b. Explanation: This function helps to send the missed calls
details to 3rd Party application.
a. URL:
https://vacpbxip/VAC/API/api.php?from=XXXXXX&to=YYYYYY&
operation=transferCall
b. Method: GET
c. Params:
i. from – Extension Number. Here, 101 (for test env.)
ii. to – Customer Number
d. Explanation: This functionality helps to transfer the call from
one extension to other number.
a. URL:
https://vacpbxip/VAC/API/api.php?from=XXXXXX&to=YYYYYY&
operation=monitor
b. Method: GET
c. Parameters:
i. From – Extension where you want to listen the other
extension
ii. To – Extension which you want to listen.
d. Explanation: This functionality helps to listen other extension
calls.
a. URL:
https://vacpbxip/VAC/API/api.php?from=XXXXXX&to=YYYYYY&
operation=whisper
b. Method: GET
c. Parameters:
i. From – Extension where you want to whisper the other
extension
ii. To – Extension which you want to whisper.
d. Explanation: This functionality helps to whisper other
extension calls.
a. URL:
https://vacpbxip/VAC/API/api.php?from=XXXXXX&to=YYYYYY&
operation=barge
b. Method: GET
c. Parameters:
i. From – Extension where you want to barge the other
extension
ii. To – Extension which you want to barge.
d. Explanation: This functionality helps to barge other extension
calls.
a. URL: https://vacpbxip/VAC/API/api.php?operation=viewCDR
b. Method: GET
c. Explanation: This functionality helps to view the Call Detail
Reports
a. URL: https://vacpbxip/VAC/API/api.php?operation=viewMsd
b. Method: GET
c. Explanation: This functionality helps to view the list of Missed
Calls
1. Obtain the API endpoints and parameters from both the VAC
Team and the 3rd Party Application.
2. Configure your 3rd Party Application to call the respective APIs
based on the required actions (e.g., click to call, and other APIs).
3. Ensure that the parameters are correctly passed in the API calls
for seamless integration.
4. Test the integration thoroughly to verify functionality and data
exchange between the applications.
5. Monitor and troubleshoot any issues that may arise during
integration to ensure smooth operation.
By following these steps, you can successfully integrate your 3rd Party Application with the VAC PBX system, enabling enhanced communication capabilities and streamlined call management.