TuCloudAPI addcli
TuCloudAPI function to manage FuturePBX (the cloud PBX). Available to: SuperRoot, Operator, Client.
pbx parameter (the PBX name, e.g. tucall). The server verifies that your ukey's own account owns that PBX, whatever its role; otherwise, and also for a PBX that does not exist, it returns {"ok":false,"code":"forbidden"}.Description
Create a CLI / DID. cli is required and GLOBALLY unique (-> conflict). The server derives tucloudpbx_id + root; cliid/voip_clis are trigger-managed. Every route id (defaultroute, timerstatic, all timer* slots) is validated to this PBX, template_h to the PBX schedule profiles. Send the timer matrix as the "timers" JSON string (POST body). Requires a non-readonly ukey.
Call
https://tucloudapi.7kas.com:9087/tucloud?func=addcli&ukey=YOUR_KEY&pbx=PBX_NAME
GET, or POST with the parameters form-urlencoded in the body. Requires the ukey parameter. Always HTTP 200; the response is a JSON envelope.
Parameters
| Parameter | Type | Required | Default | Meaning |
|---|---|---|---|---|
pbx |
string | Yes | — | FuturePBX NAME (e.g. tucall). The (ukey, pbx) pair is the tenant boundary; the server verifies the ukey owns this PBX. |
cli |
string | Yes | — | The DID/number (required, max 64, globally unique). |
nota |
string | No | — | Company/description (Empresa, max 64). |
cliid |
integer | No | 0 |
Line-code identifier 0-999. |
recincalls |
integer | No | 0 |
1 = record inbound calls. |
template_c |
integer | No | 0 |
Calendar template 0-99 (0 = none). |
template_h |
integer | No | 0 |
Schedule profile id (tucloud_pbx_sch); 0 = none. |
defaultroute |
integer | No | 0 |
Default route id (0 = none). |
timerstatic |
integer | No | 0 |
Forced/static route id (0 = none). |
timerstatic_ee |
integer | No | 0 |
Static-route inbound-routing flag 0/1. |
forcetimer |
integer | No | 0 |
Forced timer slot 0-12 (0 = none, 1=A..12=L). |
forcetimer_ee |
integer | No | 0 |
Forced-timer inbound-routing flag 0/1. |
nota2 |
string | No | — | Free note (max 32767). |
timers |
string | No | {} |
JSON object string of the weekday x slot route matrix: keys timer{a..l} and {monday..sunday}_timer{a..l} hold a route _id (blank/0 = none), and each paired ..._ee key is 0/1. Route ids are validated to this PBX. Sent by the portal as a POST body field. |
Example
https://tucloudapi.7kas.com:9087/tucloud?func=addcli&ukey=KEY&pbx=tucall&cli=960111222
Response
{ok, cli:{...}} or {ok:false,conflict}.
Errors
Always HTTP 200. On failure the body is {"ok":false,"code":"...","message":"..."}. Common codes: missing_pbx, forbidden, invalid_param, not_found, conflict, in_use, db_error, server_busy; the Response section above lists any specific to this function.
Back to TuCloudAPI