View source for TuCloudAPI getschedules

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

== Description ==
List the PBX weekly schedules (the WHEN grid a CLI's schedule profile points at). Tenant from (ukey, pbx).

== Call ==
 GET  https://tucloudapi.7kas.com:9087/tucloud?func=getschedules&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>q</code> || string || No || — || Optional name/number search (contains).
|}
== Example ==
 <nowiki>https://tucloudapi.7kas.com:9087/tucloud?func=getschedules&ukey=KEY&pbx=tucall</nowiki>

== Response ==
{ok, rows:[{_id,template,name}]}.

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