View source for TuCloudAPI addroute

''TuCloudAPI function to manage tucloud (PBX) services. Available to: '''SuperRoot, Operator, Client'''.''

== Description ==
Create an inbound route (header only; add steps with addroutestep). Server derives tucloudpbx_id + root. Requires a non-readonly ukey.

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

== Parameters ==
{| class="wikitable sortable"
! Parameter !! Type !! Required !! Default !! Meaning
|-
| <code>pbx</code> || string || Yes || — || TuCloud PBX NAME (e.g. tucall). The (ukey, pbx) pair is the tenant boundary; the server verifies the ukey owns this PBX.
|-
| <code>name</code> || string || Yes || — || Route name (required, max 32).
|-
| <code>nota</code> || string || No || — || Optional note (max 256).
|-
| <code>ref_id</code> || integer || No || <code>0</code> || Optional grouping reference (0 = none).
|}
== Example ==
 <nowiki>https://tucloudapi.7kas.com:9087/tucloud?func=addroute&ukey=KEY&pbx=tucall&name=Horario</nowiki>

== Response ==
{ok, route:{_id,name,nota,ref_id}}.

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