TuCloudAPI updatephonebookcontact: Difference between revisions
Appearance
API docs (generated from func=help) — add #48 adminusers + #52 pbxconfig |
TuCloudAPI reference: pbx param help -> FuturePBX (API surface unchanged) |
||
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
''TuCloudAPI function to manage | ''TuCloudAPI function to manage FuturePBX (the cloud PBX). Available to: '''SuperRoot, Operator, Client'''.'' | ||
== Description == | == Description == | ||
| Line 12: | Line 12: | ||
! Parameter !! Type !! Required !! Default !! Meaning | ! Parameter !! Type !! Required !! Default !! Meaning | ||
|- | |- | ||
| <code>pbx</code> || string || Yes || — || | | <code>pbx</code> || string || Yes || — || FuturePBX NAME (e.g. tucall). The (ukey, pbx) pair is the tenant boundary; the server verifies the ukey owns this PBX. | ||
|- | |- | ||
| <code>id</code> || integer || Yes || — || Contact id (_id). | | <code>id</code> || integer || Yes || — || Contact id (_id). | ||
Latest revision as of 14:31, 3 August 2026
TuCloudAPI function to manage FuturePBX (the cloud PBX). Available to: SuperRoot, Operator, Client.
Description
Edit a phonebook contact (tenant-checked via the row). Requires a non-readonly ukey.
Call
GET https://tucloudapi.7kas.com:9087/tucloud?func=updatephonebookcontact&ukey=YOUR_KEY
Requires the ukey parameter.
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. |
id |
integer | Yes | — | Contact id (_id). |
display_name |
string | Yes | — | Contact name (required, max 128). |
phone |
string | Yes | — | Phone number (required, digits/+, max 64). |
phone2 |
string | No | — | Second phone. |
email |
string | No | — | Email (max 128). |
company |
string | No | — | Company (max 128). |
notes |
string | No | — | Notes (max 512). |
speed_dial |
string | No | — | Speed-dial short code (digits, max 5). |
Example
https://tucloudapi.7kas.com:9087/tucloud?func=updatephonebookcontact&ukey=KEY&pbx=tucall&id=1&display_name=Juan&phone=600111222
Response
{ok, contacts:[{...}]}.
Back to TuCloudAPI