Proxyapi: Difference between revisions
No edit summary |
|||
(27 intermediate revisions by the same user not shown) | |||
Line 3: | Line 3: | ||
Proxyapi can be used by each tenant using an API key generated in the Configuration/Settings page. Two kinds of keys can be generated, one allowing Read/Write access and one allowing only read-only operations. | Proxyapi can be used by each tenant using an API key generated in the Configuration/Settings page. Two kinds of keys can be generated, one allowing Read/Write access and one allowing only read-only operations. | ||
The latest syntax for the operations can be retrieved by proxyapi itself, like for example: https://demo.mirtapbx.com/mirtapbx/proxyapi.php?key= | The latest syntax for the operations can be retrieved by proxyapi itself, like for example: https://demo.mirtapbx.com/mirtapbx/proxyapi.php?key=FwLjNxpSyN8tNKmD&reqtype=HELP | ||
Some usage example examples (please note the URL on the demo server is slightly different than on production servers - mirtapbx/pbx): | Some usage example examples (please note the URL on the demo server is slightly different than on production servers - mirtapbx/pbx): | ||
== INFO - SIMPLECDRS / Get the list of calls == | |||
https://demo.mirtapbx.com/mirtapbx/proxyapi.php?key=NLbP7GFNVRqu9SDm&reqtype=INFO&info=SIMPLECDRS&tenant=DEVEL&calleridnum=103,104&start=2020-01-01&end=2020-12-31 | |||
== INFO - CDRS / Get the list of calls == | |||
https://demo.mirtapbx.com/mirtapbx/proxyapi.php?key=NLbP7GFNVRqu9SDm&reqtype=INFO&info=CDRS&tenant=DEVEL&phone=103,104&start=2019-12-01&end=2022-12-31 | |||
If the amount of fields is too large and confusing, you can select the fields to return using a XML template defined in Configuration/Settings - XML Template and then use in the proxyapi request. | |||
Let's name this XML template as Test_CSV | |||
<pre> | |||
{row_loop}{$uniqueid},{$ID},{$te_id},{$realsrc},{$lastdst},{$start},{$duration},{$answer},{$direction},{$direction},{$disposition} | |||
{/row_loop} | |||
</pre> | |||
You can use as | |||
https://demo.mirtapbx.com/mirtapbx/proxyapi.php?key=NLbP7GFNVRqu9SDm&reqtype=INFO&info=CDRS&tenant=DEVEL&phone=103,104&start=2019-12-01&end=2022-12-31&format=xml&template=Test_CSV | |||
== INFO - DIDS / Get the list of DIDs for one tenant == | |||
https://demo.mirtapbx.com/mirtapbx/proxyapi.php?key=NLbP7GFNVRqu9SDm&reqtype=INFO&info=DIDS&tenant=DEVEL | |||
== INFO - DIDS / Get the list of DIDs for all tenants == | |||
https://demo.mirtapbx.com/mirtapbx/proxyapi.php?key=NLbP7GFNVRqu9SDm&reqtype=INFO&info=DIDS | |||
== INFO - Flow / Get the state of a flow == | |||
https://demo.mirtapbx.com/mirtapbx/proxyapi.php?key=NLbP7GFNVRqu9SDm&reqtype=INFO&info=FLOW&id=61&tenant=DEVEL | |||
== INFO - Variable / Get the value of a variable == | |||
https://devel.mirtapbx.com/mirtapbx/proxyapi.php?key=NLbP7GFNVRqu9SDm&reqtype=INFO&info=variable&id=61&tenant=DEVEL | |||
== DIAL / Call an extension and then dial a number == | == DIAL / Call an extension and then dial a number == | ||
Line 28: | Line 65: | ||
The variable will be available in the dial plan as "TENANTCODE-variable". In this example as DEVEL-callid | The variable will be available in the dial plan as "TENANTCODE-variable". In this example as DEVEL-callid | ||
== HANGUP / Hangup a call by extension == | |||
https://demo.mirtapbx.com/mirtapbx/proxyapi.php?key=NLbP7GFNVRqu9SDm&reqtype=HANGUP&extension=103-DEVEL&tenant=DEVEL | |||
== AGENT / Pause agent from queue == | == AGENT / Pause agent from queue == | ||
Line 36: | Line 77: | ||
https://demo.mirtapbx.com/mirtapbx/proxyapi.php?key=NLbP7GFNVRqu9SDm&reqtype=MEDIAFILE&tenant=DEVEL&id=19&action=GETAUDIO&objectid=3619 | https://demo.mirtapbx.com/mirtapbx/proxyapi.php?key=NLbP7GFNVRqu9SDm&reqtype=MEDIAFILE&tenant=DEVEL&id=19&action=GETAUDIO&objectid=3619 | ||
== QUEUE / Get the list of agents == | |||
https://demo.mirtapbx.com/mirtapbx/proxyapi.php?key=NLbP7GFNVRqu9SDm&reqtype=QUEUE&tenant=DEVEL&action=list&number=9200 | |||
== QUEUE / Add an agent to a queue == | |||
https://demo.mirtapbx.com/mirtapbx/proxyapi.php?key=NLbP7GFNVRqu9SDm&reqtype=QUEUE&tenant=DEVEL&action=add&number=9200&extension=103 | |||
== VOICEMAIL == | == VOICEMAIL == | ||
Line 60: | Line 109: | ||
Based on your browser settings, you can force the browser to play the recording using the "playrecording" info parameter | Based on your browser settings, you can force the browser to play the recording using the "playrecording" info parameter | ||
== PHONEBOOKS == | |||
=== Search for an entry === | |||
https://demo.mirtapbx.com/mirtapbx/proxyapi.php?key=NLbP7GFNVRqu9SDm&reqtype=PHONEBOOK&subreqtype=query&tenant=DEVEL&phonebook=Default&field=name&value=Ben | |||
=== Add an entry === | |||
<pre> | |||
<?php | |||
$phonebook['NAME']="Ross"; | |||
$phonebook['PHONE1']="3564732920"; | |||
$url = "https://demo.mirtapbx.com/mirtapbx/proxyapi.php?key=NLbP7GFNVRqu9SDm&reqtype=PHONEBOOK&subreqtype=add&phonebook=Default&tenant=DEVEL"; | |||
$resource = curl_init(); | |||
curl_setopt($resource, CURLOPT_URL, $url); | |||
curl_setopt($resource, CURLOPT_RETURNTRANSFER, 1); | |||
curl_setopt($resource, CURLOPT_VERBOSE, true); | |||
curl_setopt($resource, CURLOPT_POSTFIELDS, "values=".urlencode(json_encode($phonebook))); | |||
$data = curl_exec($resource); | |||
curl_close($resource); | |||
print_r($data); | |||
?> | |||
</pre> | |||
== FAX == | == FAX == | ||
Line 141: | Line 218: | ||
</Result> | </Result> | ||
</pre> | </pre> | ||
= ManageDB = | |||
Any ManageDB action requires an admin key | |||
== ManageDB / Custom Destination Types == | == ManageDB / Custom Destination Types == | ||
Line 231: | Line 312: | ||
<pre> | <pre> | ||
$config['te_name']="Relax and entertainment"; | $config['te_name']="Relax and entertainment"; | ||
$config['pk_end']=820; | $config['pk_end']=820; | ||
Line 294: | Line 374: | ||
</pre> | </pre> | ||
== Manage media files == | == Manage DB / media files == | ||
=== Getting the media file list === | === Getting the media file list === | ||
Line 403: | Line 483: | ||
print_r($data); | print_r($data); | ||
?> | ?> | ||
</pre> | |||
=== Adding a SIP extension === | |||
$config['ex_number']="1100"; | |||
$config['ex_name']='Test extension'; | |||
$config['ex_tech']='SIP'; | |||
$config['secret']='hackmeifyoucan'; | |||
$url = "https://devel.mirtapbx.com/mirtapbx/proxyapi.php?key=NLbP7GFNVRqu9SDm&reqtype=MANAGEDB&action=add&object=extension&tenant=DEVEL"; | |||
$resource = curl_init(); | |||
curl_setopt($resource, CURLOPT_URL, $url); | |||
curl_setopt($resource, CURLOPT_RETURNTRANSFER, 1); | |||
curl_setopt($resource, CURLOPT_VERBOSE, true); | |||
curl_setopt($resource, CURLOPT_POSTFIELDS, "jsondata=".urlencode(json_encode($config))); | |||
$data = curl_exec($resource); | |||
curl_close($resource); | |||
print_r($data); | |||
=== Adding a PJSIP extension === | |||
<pre> | |||
$config['ex_number']="1100"; | |||
$config['ex_name']='Test PJSIP extension'; | |||
$config['password']='hackmeifyoucan'; | |||
$config['ex_tech']='PJSIP'; | |||
$url = "https://devel.mirtapbx.com/mirtapbx/proxyapi.php?key=NLbP7GFNVRqu9SDm&reqtype=MANAGEDB&action=add&object=extension&tenant=DEVEL"; | |||
$resource = curl_init(); | |||
curl_setopt($resource, CURLOPT_URL, $url); | |||
curl_setopt($resource, CURLOPT_RETURNTRANSFER, 1); | |||
curl_setopt($resource, CURLOPT_VERBOSE, true); | |||
curl_setopt($resource, CURLOPT_POSTFIELDS, "jsondata=".urlencode(json_encode($config))); | |||
$data = curl_exec($resource); | |||
curl_close($resource); | |||
print_r($data); | |||
</pre> | |||
== ManageDB / Users == | |||
=== Getting the user list === | |||
https://demo.mirtapbx.com/mirtapbx/proxyapi.php?key=NLbP7GFNVRqu9SDm&reqtype=MANAGEDB&object=user&action=list | |||
=== Getting the details for an user === | |||
https://demo.mirtapbx.com/mirtapbx/proxyapi.php?key=NLbP7GFNVRqu9SDm&reqtype=MANAGEDB&object=user&action=get&objectid=3635 | |||
=== Creating an user === | |||
<pre> | |||
<?php | |||
$user['us_username']='Leandro71'; | |||
$user['us_password']=hash('sha256','nabucco347'); | |||
$user['us_up_id']=1; | |||
$url = "https://demo.mirtapbx.com/mirtapbx/proxyapi.php?key=NLbP7GFNVRqu9SDm&reqtype=MANAGEDB&action=add&object=user"; | |||
$resource = curl_init(); | |||
curl_setopt($resource, CURLOPT_URL, $url); | |||
curl_setopt($resource, CURLOPT_RETURNTRANSFER, 1); | |||
curl_setopt($resource, CURLOPT_VERBOSE, true); | |||
curl_setopt($resource, CURLOPT_POSTFIELDS, "jsondata=".urlencode(json_encode($user))); | |||
$data = curl_exec($resource); | |||
curl_close($resource); | |||
print_r($data); | |||
?> | |||
</pre> | |||
== ManageDB / Conferences == | |||
=== Creating a conference === | |||
<pre> | |||
<?php | |||
$config['cr_number']="887"; | |||
$config['cr_name']='Test conference'; | |||
$config['pin']='5678'; | |||
$url = "https://demo.mirtapbx.com/mirtapbx/proxyapi.php?key=NLbP7GFNVRqu9SDm&reqtype=MANAGEDB&action=add&object=conference&tenant=DEVEL"; | |||
$resource = curl_init(); | |||
curl_setopt($resource, CURLOPT_URL, $url); | |||
curl_setopt($resource, CURLOPT_RETURNTRANSFER, 1); | |||
curl_setopt($resource, CURLOPT_VERBOSE, true); | |||
curl_setopt($resource, CURLOPT_POSTFIELDS, "jsondata=".urlencode(json_encode($config))); | |||
$data = curl_exec($resource); | |||
curl_close($resource); | |||
print_r($data); | |||
?> | |||
</pre> | |||
== ManageDB / Providers == | |||
=== Getting the provider list === | |||
https://demo.mirtapbx.com/mirtapbx/proxyapi.php?key=NLbP7GFNVRqu9SDm&reqtype=MANAGEDB&object=provider&action=list | |||
=== Getting the details for a provider (SIP) === | |||
https://demo.mirtapbx.com/mirtapbx/proxyapi.php?key=NLbP7GFNVRqu9SDm&reqtype=MANAGEDB&object=provider&action=get&objectid=1027 | |||
=== Update a provider === | |||
<pre> | |||
<?php | |||
$config['pr_peername']="test_extradevel"; | |||
$config['pr_name']='Test extradevel'; | |||
$url = "https://devel.mirtapbx.com/mirtapbx/proxyapi.php?key=NLbP7GFNVRqu9SDm&reqtype=MANAGEDB&action=update&object=provider&objectid=1027"; | |||
$resource = curl_init(); | |||
curl_setopt($resource, CURLOPT_URL, $url); | |||
curl_setopt($resource, CURLOPT_RETURNTRANSFER, 1); | |||
curl_setopt($resource, CURLOPT_VERBOSE, true); | |||
curl_setopt($resource, CURLOPT_POSTFIELDS, "jsondata=".urlencode(json_encode($config))); | |||
$data = curl_exec($resource); | |||
curl_close($resource); | |||
print_r($data); | |||
?> | |||
</pre> | |||
=== Insert a provider === | |||
<pre> | |||
<?php | |||
$config['pr_peername']="new_provider"; | |||
$config['pr_name']='New Provider'; | |||
$config['pr_tech']='SIP'; | |||
$config['pr_userealtime']='on'; | |||
$config['allow']='alaw:20;ulaw:20;gsm:20'; | |||
$config['host']='172.16.1.100'; | |||
$url = "https://demo.mirtapbx.com/mirtapbx/proxyapi.php?key=NLbP7GFNVRqu9SDm&reqtype=MANAGEDB&action=add&object=provider"; | |||
$resource = curl_init(); | |||
curl_setopt($resource, CURLOPT_URL, $url); | |||
curl_setopt($resource, CURLOPT_RETURNTRANSFER, 1); | |||
curl_setopt($resource, CURLOPT_VERBOSE, true); | |||
curl_setopt($resource, CURLOPT_POSTFIELDS, "jsondata=".urlencode(json_encode($config))); | |||
$data = curl_exec($resource); | |||
curl_close($resource); | |||
print_r($data); | |||
</pre> | |||
?> | |||
== ManageDB / Routing Profiles == | |||
=== Getting the routing profiles list === | |||
https://demo.mirtapbx.com/mirtapbx/proxyapi.php?key=NLbP7GFNVRqu9SDm&reqtype=MANAGEDB&object=routingprofile&action=list | |||
=== Getting the details for a routing profile === | |||
https://demo.mirtapbx.com/mirtapbx/proxyapi.php?key=NLbP7GFNVRqu9SDm&reqtype=MANAGEDB&object=routingprofile&action=get&objectid=99 | |||
=== Getting the list of routes for a routing profile === | |||
https://demo.mirtapbx.com/mirtapbx/proxyapi.php?key=NLbP7GFNVRqu9SDm&reqtype=MANAGEDB&object=routingprofile&action=listroutes&objectid=99 | |||
=== Adding a routing profile === | |||
<pre> | |||
<?php | |||
$config['rp_name']='Only National'; | |||
$config['rp_type']='VOICE'; | |||
$url = "https://devel.mirtapbx.com/mirtapbx/proxyapi.php?key=NLbP7GFNVRqu9SDm&reqtype=MANAGEDB&action=add&object=routingprofile"; | |||
$resource = curl_init(); | |||
curl_setopt($resource, CURLOPT_URL, $url); | |||
curl_setopt($resource, CURLOPT_RETURNTRANSFER, 1); | |||
curl_setopt($resource, CURLOPT_VERBOSE, true); | |||
curl_setopt($resource, CURLOPT_POSTFIELDS, "jsondata=".urlencode(json_encode($config))); | |||
$data = curl_exec($resource); | |||
curl_close($resource); | |||
print_r($data); | |||
?> | |||
</pre> | |||
=== Update a routing profile === | |||
<?php | |||
$config['rp_name']='Only National calls'; | |||
$url = "https://devel.mirtapbx.com/mirtapbx/proxyapi.php?key=NLbP7GFNVRqu9SDm&reqtype=MANAGEDB&action=update&object=routingprofile&objectid=275"; | |||
$resource = curl_init(); | |||
curl_setopt($resource, CURLOPT_URL, $url); | |||
curl_setopt($resource, CURLOPT_RETURNTRANSFER, 1); | |||
curl_setopt($resource, CURLOPT_VERBOSE, true); | |||
curl_setopt($resource, CURLOPT_POSTFIELDS, "jsondata=".urlencode(json_encode($config))); | |||
$data = curl_exec($resource); | |||
curl_close($resource); | |||
print_r($data); | |||
?> | |||
== ManageDB / Routes == | |||
=== Getting the route list === | |||
https://demo.mirtapbx.com/mirtapbx/proxyapi.php?key=NLbP7GFNVRqu9SDm&reqtype=MANAGEDB&object=route&action=list | |||
=== Getting the route list for a routing profile === | |||
https://demo.mirtapbx.com/mirtapbx/proxyapi.php?key=NLbP7GFNVRqu9SDm&reqtype=MANAGEDB&object=route&routingprofileid=1&action=list | |||
=== Getting the details for a route === | |||
https://demo.mirtapbx.com/mirtapbx/proxyapi.php?key=NLbP7GFNVRqu9SDm&reqtype=MANAGEDB&object=route&action=get&objectid=69 | |||
=== Adding a route to a routing profile === | |||
<pre> | |||
<?php | |||
$config['dl_rp_id']='1'; | |||
$config['dl_name']='Free Numbers'; | |||
$config['dl_regex']='^800.*'; | |||
$config['dl_pr_id']='89'; | |||
$url = "https://devel.mirtapbx.com/mirtapbx/proxyapi.php?key=NLbP7GFNVRqu9SDm&reqtype=MANAGEDB&action=add&object=route"; | |||
$resource = curl_init(); | |||
curl_setopt($resource, CURLOPT_URL, $url); | |||
curl_setopt($resource, CURLOPT_RETURNTRANSFER, 1); | |||
curl_setopt($resource, CURLOPT_VERBOSE, true); | |||
curl_setopt($resource, CURLOPT_POSTFIELDS, "jsondata=".urlencode(json_encode($config))); | |||
$data = curl_exec($resource); | |||
curl_close($resource); | |||
print_r($data); | |||
?> | |||
</pre> | |||
=== Update a route === | |||
<pre> | |||
<?php | |||
$config['dl_emergencyroute']=''; | |||
$config['dl_usepin']='on'; | |||
$url = "https://demo.mirtapbx.com/mirtapbx/proxyapi.php?key=NLbP7GFNVRqu9SDm&reqtype=MANAGEDB&action=update&object=route&objectid=69"; | |||
$resource = curl_init(); | |||
curl_setopt($resource, CURLOPT_URL, $url); | |||
curl_setopt($resource, CURLOPT_RETURNTRANSFER, 1); | |||
curl_setopt($resource, CURLOPT_VERBOSE, true); | |||
curl_setopt($resource, CURLOPT_POSTFIELDS, "jsondata=".urlencode(json_encode($config))); | |||
$data = curl_exec($resource); | |||
curl_close($resource); | |||
print_r($data); | |||
?> | |||
</pre> | |||
== ManageDB / DIDs == | |||
=== Listing the DIDs for a tenant === | |||
https://demo.mirtapbx.com/mirtapbx/proxyapi.php?key=NLbP7GFNVRqu9SDm&reqtype=MANAGEDB&object=DID&action=LIST&tenant=DEVEL | |||
=== Getting more info for a DID === | |||
https://demo.mirtapbx.com/mirtapbx/proxyapi.php?key=NLbP7GFNVRqu9SDm&reqtype=MANAGEDB&object=DID&action=GET&objectid=27699&tenant=DEVEL | |||
=== Updating a DID === | |||
<pre> | |||
<?php | |||
$config['di_comment']='Test DID'; | |||
$config['di_recording']='yes'; | |||
$url = "https://demo.mirtapbx.com/mirtapbx/proxyapi.php?key=NLbP7GFNVRqu9SDm&reqtype=MANAGEDB&action=update&object=did&objectid=27699"; | |||
$resource = curl_init(); | |||
curl_setopt($resource, CURLOPT_URL, $url); | |||
curl_setopt($resource, CURLOPT_RETURNTRANSFER, 1); | |||
curl_setopt($resource, CURLOPT_VERBOSE, true); | |||
curl_setopt($resource, CURLOPT_POSTFIELDS, "jsondata=".urlencode(json_encode($config))); | |||
$data = curl_exec($resource); | |||
curl_close($resource); | |||
print_r($data); | |||
?> | |||
</pre> | |||
== ManageDB / Destinations == | |||
=== Getting the destinations for a DID === | |||
https://demo.mirtapbx.com/mirtapbx/proxyapi.php?key=NLbP7GFNVRqu9SDm&reqtype=MANAGEDB&object=DESTINATION&action=LIST&typesrc=DID&typeidsrc=27699&tenantid=1 | |||
=== Replace the destinations for a DID === | |||
<pre> | |||
<?php | |||
$config[]='PLAYBACK-60'; | |||
$config[]='EXT-29379'; | |||
$url = "https://demo.mirtapbx.com/mirtapbx/proxyapi.php?key=NLbP7GFNVRqu9SDm&reqtype=MANAGEDB&object=DESTINATION&action=replace&typesrc=DID&typeidsrc=27699&tenant=DEVEL"; | |||
$resource = curl_init(); | |||
curl_setopt($resource, CURLOPT_URL, $url); | |||
curl_setopt($resource, CURLOPT_RETURNTRANSFER, 1); | |||
curl_setopt($resource, CURLOPT_VERBOSE, true); | |||
curl_setopt($resource, CURLOPT_POSTFIELDS, "jsondata=".urlencode(json_encode($config))); | |||
$data = curl_exec($resource); | |||
curl_close($resource); | |||
print_r($data); | |||
?> | |||
</pre> | </pre> |
Revision as of 05:37, 19 November 2021
Proxyapi is the way to manage your PBX from external softwares. It allows easy access to calls, phone status and more. It allows also to create, delete and edit records, even if in a limited way.
Proxyapi can be used by each tenant using an API key generated in the Configuration/Settings page. Two kinds of keys can be generated, one allowing Read/Write access and one allowing only read-only operations.
The latest syntax for the operations can be retrieved by proxyapi itself, like for example: https://demo.mirtapbx.com/mirtapbx/proxyapi.php?key=FwLjNxpSyN8tNKmD&reqtype=HELP
Some usage example examples (please note the URL on the demo server is slightly different than on production servers - mirtapbx/pbx):
INFO - SIMPLECDRS / Get the list of calls
INFO - CDRS / Get the list of calls
If the amount of fields is too large and confusing, you can select the fields to return using a XML template defined in Configuration/Settings - XML Template and then use in the proxyapi request.
Let's name this XML template as Test_CSV
{row_loop}{$uniqueid},{$ID},{$te_id},{$realsrc},{$lastdst},{$start},{$duration},{$answer},{$direction},{$direction},{$disposition} {/row_loop}
You can use as
INFO - DIDS / Get the list of DIDs for one tenant
INFO - DIDS / Get the list of DIDs for all tenants
https://demo.mirtapbx.com/mirtapbx/proxyapi.php?key=NLbP7GFNVRqu9SDm&reqtype=INFO&info=DIDS
INFO - Flow / Get the state of a flow
INFO - Variable / Get the value of a variable
DIAL / Call an extension and then dial a number
This command returns a call id like:
Success|Originate successfully queued|15a4cfe6429054|
The call id can be used to retrieve the recording with
It will be contained in the "OriginateID" field in the cdr table
You can provide variables to the dial plan, by using the var parameter like:
%3D is the URL encoded equivalent of =
The variable will be available in the dial plan as "TENANTCODE-variable". In this example as DEVEL-callid
HANGUP / Hangup a call by extension
AGENT / Pause agent from queue
MEDIAFILE / Retrieve a media file by its ID
QUEUE / Get the list of agents
QUEUE / Add an agent to a queue
VOICEMAIL
Get all voicemails for a tenant
Get info about voicemails in a mailbox
Get the binary audio for a message
COUNTCALLS / Count the calls on a system
https://demo.mirtapbx.com/mirtapbx/proxyapi.php?key=NLbP7GFNVRqu9SDm&reqtype=COUNTCALLS
RECORDINGS / Get or play a recording
Based on your browser settings, you can force the browser to play the recording using the "playrecording" info parameter
PHONEBOOKS
Search for an entry
Add an entry
<?php $phonebook['NAME']="Ross"; $phonebook['PHONE1']="3564732920"; $url = "https://demo.mirtapbx.com/mirtapbx/proxyapi.php?key=NLbP7GFNVRqu9SDm&reqtype=PHONEBOOK&subreqtype=add&phonebook=Default&tenant=DEVEL"; $resource = curl_init(); curl_setopt($resource, CURLOPT_URL, $url); curl_setopt($resource, CURLOPT_RETURNTRANSFER, 1); curl_setopt($resource, CURLOPT_VERBOSE, true); curl_setopt($resource, CURLOPT_POSTFIELDS, "values=".urlencode(json_encode($phonebook))); $data = curl_exec($resource); curl_close($resource); print_r($data); ?>
FAX
Send a fax
<?php $postfields = array( 'filename' => '@protected/FAXtestPage.pdf' ); $ch = curl_init(); curl_setopt($ch, CURLOPT_URL, "https://demo.mirtapbx.com/mirtapbx/proxyapi.php?key=NLbP7GFNVRqu9SDm&reqtype=FAX&action=send&number=99397654321&source_number=123412345&tenant=DEVEL"); curl_setopt($ch, CURLOPT_POST, 1 ); curl_setopt($ch, CURLOPT_POSTFIELDS, $postfields); curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1); $postResult = curl_exec($ch); if (curl_errno($ch)) { print curl_error($ch); } curl_close($ch);
INFO
Get the cdr for a tenant in CSV format
Get the cdr for all tenants in CSV format
Please note, when getting the CSV for a single tenant, the CSV format used is the tenant one, when getting the CSV for multiple tenants, the Admin format is used
Get the queue log for a tenant in CSV format
Getting response paths results
Getting the latest one for a given Response Path
It returns something like:
UniqueID|Type|Type ID|Value|Type Name|Value Name srv02-1509806457.625|START|0|2017-11-04 15:41:01|| srv02-1509806457.625|CALLERID|0|Susan <1132555678>|| srv02-1509806457.625|VARIABLE|85|36985|| srv02-1509806457.625|VARIABLE|144|56896|| srv02-1509806457.625|QUEUE|281||| srv02-1509806457.625|ANSWER|0|105-DEVEL|| srv02-1509806457.625|HANGUP|0|||
Getting the latest one for a given Response Path for agent 104-DEVEL
Getting the latest one for a given Response Path for agent 104-DEVEL in xml format
Based on the xml format shown in the manual, it returns something like:
<?xml version="1.0"> <Result> <Agent>105-DEVEL</Agent> <Status>NOT ACTIVE</Status> <Queue>supportQ</Queue> <ClientID>1234</MemberNumber> <OrderNumber>11223344</MemberNumber> <Caller>Manuel <7171345678></Caller> <VoiceFile>3619</VoiceFile> </Result>
ManageDB
Any ManageDB action requires an admin key
ManageDB / Custom Destination Types
Getting the custom destination type list
ManageDB / Custom Destinations
Getting the custom destination list
Getting info for a custom destination
Creating a custom destination
$config['cu_name']="Boss phone"; $config['cu_ct_id']=1; $config['cu_param1']="3564732920"; $config['cu_param2']="INCOMINGDID"; $config['cu_param3']="30"; $url = "https://demo.mirtapbx.com/mirtapbx/proxyapi.php?key=NLbP7GFNVRqu9SDm&reqtype=MANAGEDB&action=add&object=custom&tenant=DEVEL"; $resource = curl_init(); curl_setopt($resource, CURLOPT_URL, $url); curl_setopt($resource, CURLOPT_RETURNTRANSFER, 1); curl_setopt($resource, CURLOPT_VERBOSE, true); curl_setopt($resource, CURLOPT_POSTFIELDS, "jsondata=".urlencode(json_encode($config))); $data = curl_exec($resource); curl_close($resource); print_r($data);
Updating a custom destination
$config['cu_name']="Boss private phone"; $config['cu_id']=286; $config['cu_param1']="0636287454"; $url = "https://demo.mirtapbx.com/mirtapbx/proxyapi.php?key=NLbP7GFNVRqu9SDm&reqtype=MANAGEDB&action=update&object=custom&tenant=DEVEL&objectid=286"; $resource = curl_init(); curl_setopt($resource, CURLOPT_URL, $url); curl_setopt($resource, CURLOPT_RETURNTRANSFER, 1); curl_setopt($resource, CURLOPT_VERBOSE, true); curl_setopt($resource, CURLOPT_POSTFIELDS, "jsondata=".urlencode(json_encode($config))); $data = curl_exec($resource); curl_close($resource); print_r($data);
ManageDB / Tenants
Getting the tenant list
Getting info for a tenant
Creating a tenant
$config['te_code']="RELAX"; $config['te_name']="Relax & entertainment"; $config['pk_start']=800; $config['pk_end']=810; $url = "https://demo.mirtapbx.com/mirtapbx/proxyapi.php?key=NLbP7GFNVRqu9SDm&reqtype=MANAGEDB&action=add&object=tenant"; $resource = curl_init(); curl_setopt($resource, CURLOPT_URL, $url); curl_setopt($resource, CURLOPT_RETURNTRANSFER, 1); curl_setopt($resource, CURLOPT_VERBOSE, true); curl_setopt($resource, CURLOPT_POSTFIELDS, "jsondata=".urlencode(json_encode($config))); $data = curl_exec($resource); curl_close($resource); print_r($data);
Updating a tenant
$config['te_name']="Relax and entertainment"; $config['pk_end']=820; $url = "https://demo.mirtapbx.com/mirtapbx/proxyapi.php?key=NLbP7GFNVRqu9SDm&reqtype=MANAGEDB&action=update&object=tenant&objectid=460"; $resource = curl_init(); curl_setopt($resource, CURLOPT_URL, $url); curl_setopt($resource, CURLOPT_RETURNTRANSFER, 1); curl_setopt($resource, CURLOPT_VERBOSE, true); curl_setopt($resource, CURLOPT_POSTFIELDS, "jsondata=".urlencode(json_encode($config))); $data = curl_exec($resource); curl_close($resource); print_r($data);
ManageDB / Phones
Getting the phones list
Getting info for a phone
Creating a phone
$config['ph_name']="George Basement"; $config['ph_mac']='AA:BB:CC:DD:EE:FF:00:11'; $config['ph_pm_id']=5; $url = "https://demo.mirtapbx.com/mirtapbx/proxyapi.php?key=NLbP7GFNVRqu9SDm&reqtype=MANAGEDB&action=add&object=phones&tenant=DEVEL"; $resource = curl_init(); curl_setopt($resource, CURLOPT_URL, $url); curl_setopt($resource, CURLOPT_RETURNTRANSFER, 1); curl_setopt($resource, CURLOPT_VERBOSE, true); curl_setopt($resource, CURLOPT_POSTFIELDS, "jsondata=".urlencode(json_encode($config))); $data = curl_exec($resource); curl_close($resource); print_r($data);
Updating a phone
$config['ph_name']="George Lower Basement"; $url = "https://demo.mirtapbx.com/mirtapbx/proxyapi.php?key=NLbP7GFNVRqu9SDm&reqtype=MANAGEDB&action=update&object=phone&objectid=207&tenant=DEVEL"; $resource = curl_init(); curl_setopt($resource, CURLOPT_URL, $url); curl_setopt($resource, CURLOPT_RETURNTRANSFER, 1); curl_setopt($resource, CURLOPT_VERBOSE, true); curl_setopt($resource, CURLOPT_POSTFIELDS, "jsondata=".urlencode(json_encode($config))); $data = curl_exec($resource); curl_close($resource); print_r($data);
Manage DB / media files
Getting the media file list
Getting info for a media file
Getting the binary part of a media file
Updating a media file
$config['me_name']="Beep"; $url = "https://demo.mirtapbx.com/mirtapbx/proxyapi.php?key=NLbP7GFNVRqu9SDm&reqtype=MANAGEDB&action=update&object=mediafile&objectid=10&tenant=DEVEL"; $resource = curl_init(); curl_setopt($resource, CURLOPT_URL, $url); curl_setopt($resource, CURLOPT_RETURNTRANSFER, 1); curl_setopt($resource, CURLOPT_VERBOSE, true); curl_setopt($resource, CURLOPT_POSTFIELDS, "jsondata=".urlencode(json_encode($config))); $data = curl_exec($resource); curl_close($resource); print_r($data);
Updating the binary part of a media file
<?php $postfields = array( 'filename' => '@audio.wav' ); $ch = curl_init(); curl_setopt($ch, CURLOPT_URL, "https://demo.mirtapbx.com/mirtapbx/proxyapi.php?key=NLbP7GFNVRqu9SDm&reqtype=MANAGEDB&object=MEDIAFILE&action=updatebinary&objectid=247&tenant=DEVEL"); curl_setopt($ch, CURLOPT_POST, 1 ); curl_setopt($ch, CURLOPT_POSTFIELDS, $postfields); curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1); $postResult = curl_exec($ch); if (curl_errno($ch)) { print curl_error($ch); } curl_close($ch);
ManageDB / Hunt Lists
Getting the hunt lists list
Getting the hunt lists extension list
Setting the hunt lists extension list
<?php $destinations=array('EXT-1701','EXT-1703','EXT-1705','CUSTOM-67'); $url = "https://demo.mirtapbx.com/mirtapbx/proxyapi.php?key=NLbP7GFNVRqu9SDm&reqtype=MANAGEDB&action=setextensions&object=huntlist&objectid=26&tenant=DEVEL"; $resource = curl_init(); curl_setopt($resource, CURLOPT_URL, $url); curl_setopt($resource, CURLOPT_RETURNTRANSFER, 1); curl_setopt($resource, CURLOPT_VERBOSE, true); curl_setopt($resource, CURLOPT_POSTFIELDS, "jsondata=".urlencode(json_encode($destinations))); $data = curl_exec($resource); curl_close($resource); print_r($data); ?>
ManageDB / Extensions
Getting the extension list
Updating the security for an extension
<?php $value['ex_callallowed']='none'; //$value['ex_callallowed']='all'; $url = "https://demo.mirtapbx.com/mirtapbx/proxyapi.php?key=NLbP7GFNVRqu9SDm&reqtype=MANAGEDB&action=update&object=extension&objectid=1695&tenant=DEVEL"; $resource = curl_init(); curl_setopt($resource, CURLOPT_URL, $url); curl_setopt($resource, CURLOPT_RETURNTRANSFER, 1); curl_setopt($resource, CURLOPT_VERBOSE, true); curl_setopt($resource, CURLOPT_POSTFIELDS, "jsondata=".urlencode(json_encode($value))); $data = curl_exec($resource); curl_close($resource); print_r($data); ?>
Adding a SIP extension
$config['ex_number']="1100"; $config['ex_name']='Test extension'; $config['ex_tech']='SIP'; $config['secret']='hackmeifyoucan';
$url = "https://devel.mirtapbx.com/mirtapbx/proxyapi.php?key=NLbP7GFNVRqu9SDm&reqtype=MANAGEDB&action=add&object=extension&tenant=DEVEL"; $resource = curl_init(); curl_setopt($resource, CURLOPT_URL, $url); curl_setopt($resource, CURLOPT_RETURNTRANSFER, 1); curl_setopt($resource, CURLOPT_VERBOSE, true); curl_setopt($resource, CURLOPT_POSTFIELDS, "jsondata=".urlencode(json_encode($config))); $data = curl_exec($resource); curl_close($resource);
print_r($data);
Adding a PJSIP extension
$config['ex_number']="1100"; $config['ex_name']='Test PJSIP extension'; $config['password']='hackmeifyoucan'; $config['ex_tech']='PJSIP'; $url = "https://devel.mirtapbx.com/mirtapbx/proxyapi.php?key=NLbP7GFNVRqu9SDm&reqtype=MANAGEDB&action=add&object=extension&tenant=DEVEL"; $resource = curl_init(); curl_setopt($resource, CURLOPT_URL, $url); curl_setopt($resource, CURLOPT_RETURNTRANSFER, 1); curl_setopt($resource, CURLOPT_VERBOSE, true); curl_setopt($resource, CURLOPT_POSTFIELDS, "jsondata=".urlencode(json_encode($config))); $data = curl_exec($resource); curl_close($resource); print_r($data);
ManageDB / Users
Getting the user list
Getting the details for an user
Creating an user
<?php $user['us_username']='Leandro71'; $user['us_password']=hash('sha256','nabucco347'); $user['us_up_id']=1; $url = "https://demo.mirtapbx.com/mirtapbx/proxyapi.php?key=NLbP7GFNVRqu9SDm&reqtype=MANAGEDB&action=add&object=user"; $resource = curl_init(); curl_setopt($resource, CURLOPT_URL, $url); curl_setopt($resource, CURLOPT_RETURNTRANSFER, 1); curl_setopt($resource, CURLOPT_VERBOSE, true); curl_setopt($resource, CURLOPT_POSTFIELDS, "jsondata=".urlencode(json_encode($user))); $data = curl_exec($resource); curl_close($resource); print_r($data); ?>
ManageDB / Conferences
Creating a conference
<?php $config['cr_number']="887"; $config['cr_name']='Test conference'; $config['pin']='5678'; $url = "https://demo.mirtapbx.com/mirtapbx/proxyapi.php?key=NLbP7GFNVRqu9SDm&reqtype=MANAGEDB&action=add&object=conference&tenant=DEVEL"; $resource = curl_init(); curl_setopt($resource, CURLOPT_URL, $url); curl_setopt($resource, CURLOPT_RETURNTRANSFER, 1); curl_setopt($resource, CURLOPT_VERBOSE, true); curl_setopt($resource, CURLOPT_POSTFIELDS, "jsondata=".urlencode(json_encode($config))); $data = curl_exec($resource); curl_close($resource); print_r($data); ?>
ManageDB / Providers
Getting the provider list
Getting the details for a provider (SIP)
Update a provider
<?php $config['pr_peername']="test_extradevel"; $config['pr_name']='Test extradevel'; $url = "https://devel.mirtapbx.com/mirtapbx/proxyapi.php?key=NLbP7GFNVRqu9SDm&reqtype=MANAGEDB&action=update&object=provider&objectid=1027"; $resource = curl_init(); curl_setopt($resource, CURLOPT_URL, $url); curl_setopt($resource, CURLOPT_RETURNTRANSFER, 1); curl_setopt($resource, CURLOPT_VERBOSE, true); curl_setopt($resource, CURLOPT_POSTFIELDS, "jsondata=".urlencode(json_encode($config))); $data = curl_exec($resource); curl_close($resource); print_r($data); ?>
Insert a provider
<?php $config['pr_peername']="new_provider"; $config['pr_name']='New Provider'; $config['pr_tech']='SIP'; $config['pr_userealtime']='on'; $config['allow']='alaw:20;ulaw:20;gsm:20'; $config['host']='172.16.1.100'; $url = "https://demo.mirtapbx.com/mirtapbx/proxyapi.php?key=NLbP7GFNVRqu9SDm&reqtype=MANAGEDB&action=add&object=provider"; $resource = curl_init(); curl_setopt($resource, CURLOPT_URL, $url); curl_setopt($resource, CURLOPT_RETURNTRANSFER, 1); curl_setopt($resource, CURLOPT_VERBOSE, true); curl_setopt($resource, CURLOPT_POSTFIELDS, "jsondata=".urlencode(json_encode($config))); $data = curl_exec($resource); curl_close($resource); print_r($data);
?>
ManageDB / Routing Profiles
Getting the routing profiles list
Getting the details for a routing profile
Getting the list of routes for a routing profile
Adding a routing profile
<?php $config['rp_name']='Only National'; $config['rp_type']='VOICE'; $url = "https://devel.mirtapbx.com/mirtapbx/proxyapi.php?key=NLbP7GFNVRqu9SDm&reqtype=MANAGEDB&action=add&object=routingprofile"; $resource = curl_init(); curl_setopt($resource, CURLOPT_URL, $url); curl_setopt($resource, CURLOPT_RETURNTRANSFER, 1); curl_setopt($resource, CURLOPT_VERBOSE, true); curl_setopt($resource, CURLOPT_POSTFIELDS, "jsondata=".urlencode(json_encode($config))); $data = curl_exec($resource); curl_close($resource); print_r($data); ?>
Update a routing profile
<?php
$config['rp_name']='Only National calls';
$url = "https://devel.mirtapbx.com/mirtapbx/proxyapi.php?key=NLbP7GFNVRqu9SDm&reqtype=MANAGEDB&action=update&object=routingprofile&objectid=275"; $resource = curl_init(); curl_setopt($resource, CURLOPT_URL, $url); curl_setopt($resource, CURLOPT_RETURNTRANSFER, 1); curl_setopt($resource, CURLOPT_VERBOSE, true); curl_setopt($resource, CURLOPT_POSTFIELDS, "jsondata=".urlencode(json_encode($config))); $data = curl_exec($resource); curl_close($resource);
print_r($data); ?>
ManageDB / Routes
Getting the route list
Getting the route list for a routing profile
Getting the details for a route
Adding a route to a routing profile
<?php $config['dl_rp_id']='1'; $config['dl_name']='Free Numbers'; $config['dl_regex']='^800.*'; $config['dl_pr_id']='89'; $url = "https://devel.mirtapbx.com/mirtapbx/proxyapi.php?key=NLbP7GFNVRqu9SDm&reqtype=MANAGEDB&action=add&object=route"; $resource = curl_init(); curl_setopt($resource, CURLOPT_URL, $url); curl_setopt($resource, CURLOPT_RETURNTRANSFER, 1); curl_setopt($resource, CURLOPT_VERBOSE, true); curl_setopt($resource, CURLOPT_POSTFIELDS, "jsondata=".urlencode(json_encode($config))); $data = curl_exec($resource); curl_close($resource); print_r($data); ?>
Update a route
<?php $config['dl_emergencyroute']=''; $config['dl_usepin']='on'; $url = "https://demo.mirtapbx.com/mirtapbx/proxyapi.php?key=NLbP7GFNVRqu9SDm&reqtype=MANAGEDB&action=update&object=route&objectid=69"; $resource = curl_init(); curl_setopt($resource, CURLOPT_URL, $url); curl_setopt($resource, CURLOPT_RETURNTRANSFER, 1); curl_setopt($resource, CURLOPT_VERBOSE, true); curl_setopt($resource, CURLOPT_POSTFIELDS, "jsondata=".urlencode(json_encode($config))); $data = curl_exec($resource); curl_close($resource); print_r($data); ?>
ManageDB / DIDs
Listing the DIDs for a tenant
Getting more info for a DID
Updating a DID
<?php $config['di_comment']='Test DID'; $config['di_recording']='yes'; $url = "https://demo.mirtapbx.com/mirtapbx/proxyapi.php?key=NLbP7GFNVRqu9SDm&reqtype=MANAGEDB&action=update&object=did&objectid=27699"; $resource = curl_init(); curl_setopt($resource, CURLOPT_URL, $url); curl_setopt($resource, CURLOPT_RETURNTRANSFER, 1); curl_setopt($resource, CURLOPT_VERBOSE, true); curl_setopt($resource, CURLOPT_POSTFIELDS, "jsondata=".urlencode(json_encode($config))); $data = curl_exec($resource); curl_close($resource); print_r($data); ?>
ManageDB / Destinations
Getting the destinations for a DID
Replace the destinations for a DID
<?php $config[]='PLAYBACK-60'; $config[]='EXT-29379'; $url = "https://demo.mirtapbx.com/mirtapbx/proxyapi.php?key=NLbP7GFNVRqu9SDm&reqtype=MANAGEDB&object=DESTINATION&action=replace&typesrc=DID&typeidsrc=27699&tenant=DEVEL"; $resource = curl_init(); curl_setopt($resource, CURLOPT_URL, $url); curl_setopt($resource, CURLOPT_RETURNTRANSFER, 1); curl_setopt($resource, CURLOPT_VERBOSE, true); curl_setopt($resource, CURLOPT_POSTFIELDS, "jsondata=".urlencode(json_encode($config))); $data = curl_exec($resource); curl_close($resource); print_r($data); ?>