View source for TuCloudAPI addextension

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

== Description ==
Create an extension. The server derives num (max+1, else 200; 112->113), the SIP user (pbxname+num) and — unless password is supplied — a random SIP password; root/tucloudpbx_id come from the tenant. Every lookup id is validated to belong to this PBX. Unique (pbx,num) -> {ok:false,conflict}. The SIP peer + voicemail are created automatically by the DB trigger. Requires a non-readonly ukey. Password is NOT returned (use getextqr).

== Call ==
 GET  https://tucloudapi.7kas.com:9087/tucloud?func=addextension&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>name</code> || string || Yes || — || Display name (required, max 64).
|-
| <code>cli_id</code> || integer || Yes || — || Outgoing caller ID id (required; from getextlookups.clis).
|-
| <code>ringtime</code> || integer || No || <code>0</code> || Ring seconds: 0 (PBX default) or 5-50.
|-
| <code>internalcli_id</code> || integer || No || <code>0</code> || Internal/mobile CLI id (0 = none).
|-
| <code>teamsopt</code> || string || No || <code>S</code> || T=Teams, S=VoIP, TS=both.
|-
| <code>teamsnum</code> || string || No || — || Teams number (digits only, max 64; unique).
|-
| <code>pickupgroup</code> || integer || No || <code>0</code> || Pickup group 0-999.
|-
| <code>toext_id</code> || integer || No || <code>0</code> || Send-to extension id (0 = registered SIP mode).
|-
| <code>password</code> || string || No || — || Explicit SIP password (blank = auto-generate).
|-
| <code>backupnum</code> || string || No || — || Backup number (digits and +, max 64).
|-
| <code>backupmonpeer</code> || string || No || — || Extension num to monitor for backup.
|-
| <code>music</code> || integer || No || <code>0</code> || Music-on-hold id (0 = default).
|-
| <code>tom</code> || integer || No || <code>0</code> || 0=tone, 1=music.
|-
| <code>voicemail</code> || integer || No || <code>0</code> || 1=enable voicemail.
|-
| <code>email</code> || string || No || — || Voicemail/notification email.
|-
| <code>incom_only_contacts</code> || integer || No || <code>0</code> || 1=accept only contacts/extensions.
|-
| <code>fwdshowcaller</code> || integer || No || <code>0</code> || 1=show original caller on forward.
|-
| <code>fwd_cli</code> || integer || No || <code>0</code> || External-forward caller-ID (0=Si,1=No; inverse).
|-
| <code>fwd</code> || integer || No || <code>0</code> || External forward: 0=off,1=all,2=busy,3=noanswer,4=busy/noanswer.
|-
| <code>fwdnum</code> || string || No || — || External forward destination.
|-
| <code>fwd_internal</code> || integer || No || <code>0</code> || Internal forward (same 0-4 scale).
|-
| <code>fwdnum_internal</code> || string || No || — || Internal forward destination.
|-
| <code>recoutgoing</code> || integer || No || <code>0</code> || 1=record outgoing calls.
|-
| <code>only_contacts</code> || integer || No || <code>0</code> || 1=restrict outbound to contacts.
|-
| <code>outs_id</code> || integer || No || <code>0</code> || Outgoing service id (0 = none).
|-
| <code>nota</code> || string || No || — || Free note (max 256).
|}
== Example ==
 <nowiki>https://tucloudapi.7kas.com:9087/tucloud?func=addextension&ukey=KEY&pbx=tucall&name=Recepcion&cli_id=81324</nowiki>

== Response ==
{ok, ext:{...}} (no password).

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