TuCloudAPI help: Difference between revisions
TuCloudAPI reference (generated from func=help) |
TuCloudAPI reference regenerated from func=help: tenancy rule, pbx notes on every PBX-scoped function, error codes |
||
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
{{Note|This is the '''self-discovery''' endpoint. It returns the functions your <code>ukey</code> can call, each fully documented. This TuCloudAPI wiki is generated from it.}} | {{Note|1=This is the '''self-discovery''' endpoint. It returns the functions your <code>ukey</code> can call, each fully documented. This TuCloudAPI wiki is generated from it.}} | ||
''TuCloudAPI function to manage | ''TuCloudAPI function to manage FuturePBX (the cloud PBX). Available to: '''SuperRoot, Operator, Client'''.'' | ||
== Description == | == Description == | ||
| Line 7: | Line 7: | ||
== Call == | == Call == | ||
https://tucloudapi.7kas.com:9087/tucloud?func=help&ukey=YOUR_KEY | |||
Requires the <code>ukey</code> parameter. | GET, or POST with the parameters form-urlencoded in the body. Requires the <code>ukey</code> parameter. | ||
== Parameters == | == Parameters == | ||
Latest revision as of 21:17, 8 October 2026
ℹ This is the self-discovery endpoint. It returns the functions your
ukey can call, each fully documented. This TuCloudAPI wiki is generated from it.TuCloudAPI function to manage FuturePBX (the cloud PBX). Available to: SuperRoot, Operator, Client.
Description
Lists the API functions available to the role of the calling ukey, with each function's description, parameters (meaning, optional/default), an example call and the response format. Optional name=<func> returns just that function.
Call
https://tucloudapi.7kas.com:9087/tucloud?func=help&ukey=YOUR_KEY
GET, or POST with the parameters form-urlencoded in the body. Requires the ukey parameter.
Parameters
| Parameter | Type | Required | Default | Meaning |
|---|---|---|---|---|
name |
string | No | — | Return only this function's documentation. Omit for the full catalogue. |
Example
https://api.7kas.com:9087/tucloud?func=help&ukey=KEY
Response
Object: {api, url, authentication, response_format, role, count, functions:[{name, category, description, parameters:[{name,type,required,default,description,notes}], example, response}]}.
Back to TuCloudAPI