TuCloudAPI addcontact
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 contact. cname + phone required; prefix (speed-dial short code) optional. Dedup per tenant on phone AND on prefix -> {ok:false,conflict} (message "phone"/"prefix"). Server derives root. Requires a non-readonly ukey.
Call
https://tucloudapi.7kas.com:9087/tucloud?func=addcontact&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. |
cname |
string | Yes | — | Contact name (required, max 128). |
phone |
string | Yes | — | Phone number (required, digits/optional +, max 64). |
prefix |
string | No | — | Speed-dial short code (digits, max 5; dialed as **<prefix>). |
Example
https://tucloudapi.7kas.com:9087/tucloud?func=addcontact&ukey=KEY&pbx=tucall&cname=Soporte&phone=962929889&prefix=999
Response
{ok, contact:{_id,cname,phone,prefix}} 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