Maintenance script: API docs (generated from func=help)

2026-07-21T22:33:29Z

API docs (generated from func=help)

New page

''7Kas VoIP REST API function. 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 …/7Kas?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. (max 100)
|-
| <code>address</code> || string || No || — || Postal address. (max 200)
|-
| <code>phone</code> || string || No || — || Phone. (max 20)
|-
| <code>email</code> || string || No || — || Primary e-mail. (max 100)
|-
| <code>date_added</code> || string || No || — || Creation date. (max 20)
|-
| <code>description</code> || string || No || — || Free description. (max 200)
|-
| <code>language</code> || string || No || — || UI language code. (max 5)
|-
| <code>postal_code</code> || string || No || — || Postal code. (max 10)
|-
| <code>city</code> || string || No || — || City. (max 50)
|-
| <code>province</code> || string || No || — || Province. (max 50)
|-
| <code>nif</code> || string || No || — || Tax id (NIF/CIF). (max 20)
|-
| <code>blocked</code> || string || No || — || Blocked flag (SI/NO). (max 4)
|-
| <code>postpaid</code> || string || No || — || Postpaid flag. (max 4)
|-
| <code>admin</code> || string || No || — || Admin flag. (max 4)
|-
| <code>accountcode_comis</code> || string || No || — || Commissioner account this account belongs to. (max 20)
|-
| <code>comisionista</code> || string || No || — || Is-commissioner flag (SI/NO). (max 4)
|-
| <code>groups</code> || string || No || — || Group memberships. (max 100)
|-
| <code>movil_sms</code> || string || No || — || Mobile for SMS. (max 20)
|-
| <code>email2</code> || string || No || — || Secondary e-mail. (max 100)
|-
| <code>fax</code> || string || No || — || Fax. (max 20)
|-
| <code>nota</code> || string || No || — || Internal note. (max 500)
|-
| <code>web</code> || string || No || — || Website. (max 100)
|-
| <code>flags</code> || string || No || — || Account flags. (max 20)
|-
| <code>tariff</code> || string || No || — || Tariff code. (max 20)
|-
| <code>daycallmail</code> || string || No || — || Daily-call report e-mail(s). (max 100)
|-
| <code>root</code> || integer || No || — || Parent operator root. Forced to the caller's own unless SuperRoot. (numeric, max 10)
|-
| <code>credit_limit</code> || integer || No || — || Credit limit. (numeric)
|-
| <code>comis_minutos</code> || integer || No || — || Commission minutes. (numeric)
|-
| <code>ratio</code> || integer || No || — || Commission ratio. (numeric)
|-
| <code>creditalarm</code> || integer || No || — || Credit alarm threshold. (numeric)
|-
| <code>aindirecto_coste</code> || integer || No || — || Indirect-access cost. (numeric)
|-
| <code>intlimit</code> || integer || No || — || International limit. (numeric)
|-
| <code>daycall</code> || integer || No || — || Daily-call limit. (numeric)
|-
| <code>intlock</code> || integer || No || — || International lock flag. (numeric)
|}
== Example ==
<nowiki>https://api.7kas.com:9080/7Kas?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 [[API VoIP]] · '''[[API Console|▶ Try it live]]''' · Profiles: [[API profile SuperRoot]], [[API profile Operator]]
[[Category:API SuperRoot]][[Category:API Operator]][[Category:API function]]

API addaccountcode - Revision history

Maintenance script: API docs (generated from func=help)