View source for TuCloudAPI addtask

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

{{Note|Requires the <code>pbx</code> parameter (the PBX '''name''', e.g. <code>tucall</code>). The server verifies your <code>ukey</code> owns that PBX; otherwise it returns <code>{"ok":false,"code":"forbidden"}</code>.}}

== Description ==
Create a scheduled task (status forced 0). name required.

== Call ==
 GET  https://tucloudapi.7kas.com:9087/tucloud?func=addtask&ukey=YOUR_KEY&pbx=PBX_NAME
Requires the <code>ukey</code> parameter. Always HTTP 200; response is a JSON envelope.

== 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>name</code> || string || Yes || — || Task name (required).
|-
| <code>description</code> || string || No || — || Optional description.
|-
| <code>time</code> || string || No || <code>00:00</code> || Time of day HH:MM.
|-
| <code>second</code> || integer || No || <code>0</code> || Second 0-59 (cron runner).
|-
| <code>month</code> || integer || No || <code>0</code> || Month 1-12; 0 = any.
|-
| <code>dayofmonth</code> || integer || No || <code>0</code> || Day of month 1-31; 0 = any.
|-
| <code>dayofweek</code> || integer || No || <code>0</code> || Day of week 0-6; 7 = any.
|-
| <code>hold</code> || integer || No || <code>0</code> || 1 = recurring, 0 = one-shot.
|}
== Example ==
 <nowiki>https://tucloudapi.7kas.com:9087/tucloud?func=addtask&ukey=KEY&pbx=tucall&name=Verano&time=00:00&hold=1</nowiki>

== Response ==
{ok, task:TASK}.

== Errors ==
Always HTTP 200. On failure the body is <code>{"ok":false,"code":"...","message":"..."}</code>. Codes: <code>missing_pbx</code>, <code>unknown_pbx</code>, <code>forbidden</code>, <code>invalid_param</code>, <code>not_found</code>, <code>db_error</code>, <code>server_busy</code>.

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