View source for TuCloudAPI addcontact

''TuCloudAPI function to manage FuturePBX (the cloud PBX). Available to: '''SuperRoot, Operator, Client'''.''

== 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 ==
 GET  https://tucloudapi.7kas.com:9087/tucloud?func=addcontact&ukey=YOUR_KEY
Requires the <code>ukey</code> parameter.

== Parameters ==
{| class="wikitable sortable"
! Parameter !! Type !! Required !! Default !! Meaning
|-
| <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>cname</code> || string || Yes || — || Contact name (required, max 128).
|-
| <code>phone</code> || string || Yes || — || Phone number (required, digits/optional +, max 64).
|-
| <code>prefix</code> || string || No || — || Speed-dial short code (digits, max 5; dialed as **<prefix>).
|}
== Example ==
 <nowiki>https://tucloudapi.7kas.com:9087/tucloud?func=addcontact&ukey=KEY&pbx=tucall&cname=Soporte&phone=962929889&prefix=999</nowiki>

== Response ==
{ok, contact:{_id,cname,phone,prefix}} or {ok:false,conflict}.

----
Back to [[TuCloudAPI]]
[[Category:TuCloudAPI SuperRoot]][[Category:TuCloudAPI Operator]][[Category:TuCloudAPI Client]][[Category:TuCloudAPI]]