View source for TuCloudAPI addaccountcode

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

== Description ==
Creates a new account (client) under the caller. Requires write permission (operator/SuperRoot, not read-only). For non-SuperRoot the root is forced to the caller's own.

== Call ==
 GET  https://tucloudapi.7kas.com:9087/tucloud?func=addaccountcode&ukey=YOUR_KEY
Requires the <code>ukey</code> parameter.

== Parameters ==
{| class="wikitable sortable"
! Parameter !! Type !! Required !! Default !! Meaning
|-
| <code>accountcode</code> || string || Yes || — || Account code (login). Required. Max 20.
|-
| <code>credit</code> || string || Yes || — || Initial credit. Required. Max 20.
|-
| <code>password</code> || string || Yes || — || Account password. Required. Max 40.
|-
| <code>name</code> || string || Yes || — || Contact/holder name. Required. Max 100.
|-
| <code>company</code> || string || No || — || Company name. <small>(max 100)</small>
|-
| <code>address</code> || string || No || — || Postal address. <small>(max 200)</small>
|-
| <code>phone</code> || string || No || — || Phone. <small>(max 20)</small>
|-
| <code>email</code> || string || No || — || Primary e-mail. <small>(max 100)</small>
|-
| <code>date_added</code> || string || No || — || Creation date. <small>(max 20)</small>
|-
| <code>description</code> || string || No || — || Free description. <small>(max 200)</small>
|-
| <code>language</code> || string || No || — || UI language code. <small>(max 5)</small>
|-
| <code>postal_code</code> || string || No || — || Postal code. <small>(max 10)</small>
|-
| <code>city</code> || string || No || — || City. <small>(max 50)</small>
|-
| <code>province</code> || string || No || — || Province. <small>(max 50)</small>
|-
| <code>nif</code> || string || No || — || Tax id (NIF/CIF). <small>(max 20)</small>
|-
| <code>blocked</code> || string || No || — || Blocked flag (SI/NO). <small>(max 4)</small>
|-
| <code>postpaid</code> || string || No || — || Postpaid flag. <small>(max 4)</small>
|-
| <code>admin</code> || string || No || — || Admin flag. <small>(max 4)</small>
|-
| <code>accountcode_comis</code> || string || No || — || Commissioner account this account belongs to. <small>(max 20)</small>
|-
| <code>comisionista</code> || string || No || — || Is-commissioner flag (SI/NO). <small>(max 4)</small>
|-
| <code>groups</code> || string || No || — || Group memberships. <small>(max 100)</small>
|-
| <code>movil_sms</code> || string || No || — || Mobile for SMS. <small>(max 20)</small>
|-
| <code>email2</code> || string || No || — || Secondary e-mail. <small>(max 100)</small>
|-
| <code>fax</code> || string || No || — || Fax. <small>(max 20)</small>
|-
| <code>nota</code> || string || No || — || Internal note. <small>(max 500)</small>
|-
| <code>web</code> || string || No || — || Website. <small>(max 100)</small>
|-
| <code>flags</code> || string || No || — || Account flags. <small>(max 20)</small>
|-
| <code>tariff</code> || string || No || — || Tariff code. <small>(max 20)</small>
|-
| <code>daycallmail</code> || string || No || — || Daily-call report e-mail(s). <small>(max 100)</small>
|-
| <code>root</code> || integer || No || — || Parent operator root. Forced to the caller's own unless SuperRoot. <small>(numeric, max 10)</small>
|-
| <code>credit_limit</code> || integer || No || — || Credit limit. <small>(numeric)</small>
|-
| <code>comis_minutos</code> || integer || No || — || Commission minutes. <small>(numeric)</small>
|-
| <code>ratio</code> || integer || No || — || Commission ratio. <small>(numeric)</small>
|-
| <code>creditalarm</code> || integer || No || — || Credit alarm threshold. <small>(numeric)</small>
|-
| <code>aindirecto_coste</code> || integer || No || — || Indirect-access cost. <small>(numeric)</small>
|-
| <code>intlimit</code> || integer || No || — || International limit. <small>(numeric)</small>
|-
| <code>daycall</code> || integer || No || — || Daily-call limit. <small>(numeric)</small>
|-
| <code>intlock</code> || integer || No || — || International lock flag. <small>(numeric)</small>
|}
== Example ==
 <nowiki>https://api.7kas.com:9087/tucloud?func=addaccountcode&ukey=OPKEY&accountcode=NEW1&credit=0&password=secret&name=John</nowiki>

== Response ==
Object with the new account id / result of api_add_voip_user.

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