View source for TuCloudAPI getroute

''TuCloudAPI function to manage FuturePBX (the cloud PBX). Available to: '''SuperRoot, Operator, Client'''.''

== Description ==
Get one route header plus its ordered steps (destinations). 404-style not_found if not in the caller's PBX.

== Call ==
 GET  https://tucloudapi.7kas.com:9087/tucloud?func=getroute&ukey=YOUR_KEY
Requires the <code>ukey</code> parameter.

== Parameters ==
{| class="wikitable sortable"
! Parameter !! Type !! Required !! Default !! Meaning
|-
| <code>pbx</code> || string || Yes || — || FuturePBX NAME (e.g. tucall). The (ukey, pbx) pair is the tenant boundary; the server verifies the ukey owns this PBX.
|-
| <code>id</code> || integer || Yes || — || Route id (_id).
|}
== Example ==
 <nowiki>https://tucloudapi.7kas.com:9087/tucloud?func=getroute&ukey=KEY&pbx=tucall&id=197</nowiki>

== Response ==
{ok, route:{_id,name,nota,ref_id}, steps:[{_id,priority,app,app_label,appdata,dest_label,timer}]}.

----
Back to [[TuCloudAPI]]
[[Category:TuCloudAPI SuperRoot]][[Category:TuCloudAPI Operator]][[Category:TuCloudAPI Client]][[Category:TuCloudAPI]]