TuCloudAPI getcredit: Difference between revisions
TuCloudAPI reference: product name -> FuturePBX (API surface unchanged); regenerated from func=help |
TuCloudAPI reference regenerated from func=help: tenancy rule, pbx notes on every PBX-scoped function, error codes |
||
| Line 5: | Line 5: | ||
== Call == | == Call == | ||
https://tucloudapi.7kas.com:9087/tucloud?func=getcredit&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:16, 8 October 2026
TuCloudAPI function to manage FuturePBX (the cloud PBX). Available to: SuperRoot, Operator, Client.
Description
Returns credit and status (credit, credit_limit, creditalarm, email, blocked). Any role: clients (and operators/SuperRoot without accountcode) get their own; operators/SuperRoot with accountcode query that account within their scope.
Call
https://tucloudapi.7kas.com:9087/tucloud?func=getcredit&ukey=YOUR_KEY
GET, or POST with the parameters form-urlencoded in the body. Requires the ukey parameter.
Parameters
| Parameter | Type | Required | Default | Meaning |
|---|---|---|---|---|
accountcode |
string | No | — | Account to query (operators/SuperRoot only). Omit for your own. (max length 20) |
Example
https://api.7kas.com:9087/tucloud?func=getcredit&ukey=KEY
Response
FillRecords2JSON: fields [credit, credit_limit, creditalarm, email, blocked].
Back to TuCloudAPI