TuCloudAPI help

ℹ 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 tucloud (PBX) services. 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

GET  https://tucloudapi.7kas.com:9087/tucloud?func=help&ukey=YOUR_KEY

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