Accounts

About Accounts

Accounts are the container for most things in Kazoo. They typically represent an office, business, family, etc. Kazoo arranges accounts into a tree structure, where parent accounts can access their sub accounts but not their ancestor accounts.

About the Account Tree

Since accounts can be the child of 0 or more parent accounts, it is necessary to track each account’s lineage. This is tracked in the account document (_id = ID of the account) in the pvt_tree array. The order of the list is from most-ancestral to parent.

So given "pvt_tree":["1", "2", "3"], it can be determined that “3” is the parent account, “2” the grand-parent, and “1” is the great-grandparent. "pvt_tree":[] indicates the master (or Highlander) account; there should only be one!

Schema

Accounts represent tenants or customers on the system. Each account represents an individual dataset or sandbox that only one tenant can access. The data set is architecturally independent from other tenants.

Key	Description	Type	Default	Required	Support Level
call_recording.account	endpoint recording settings	#/definitions/call_recording		false
call_recording.endpoint	endpoint recording settings	#/definitions/call_recording		false
call_recording	call recording configuration	object()		false
call_restriction	Account level call restrictions for each available number classification	object()	{}	false
call_waiting	Parameters for server-side call waiting	#/definitions/call_waiting		false
caller_id	The account default caller ID parameters	#/definitions/caller_id		false
caller_id_options.outbound_privacy	Determines what appears as caller id for offnet outbound calls. Values: full - hides name and number; name - hides only name; number - hides only number; none - hides nothing	`string(‘full'	'name'	'number'	'none’)`
caller_id_options.show_rate	Whether to show the rate	boolean()		false
caller_id_options	custom properties for configuring caller_id	object()		false
dial_plan	A list of default rules used to modify dialed numbers	#/definitions/dialplans		false
do_not_disturb.enabled	The default value for do-not-disturb	boolean()		false
do_not_disturb		object()		false
enabled	Determines if the account is currently enabled	boolean()	true	false	supported
flags.[]		string()		false	supported
flags	Flags set by external applications	array(string())		false	supported
formatters	Schema for request formatters	#/definitions/formatters		false
language	The language for this account	string()		false	supported
metaflows	Actions applied to a call outside of the normal callflow, initiated by the caller(s)	#/definitions/metaflows		false
music_on_hold.media_id	The ID of a media object that should be used as the default music on hold	string(0..2048)		false
music_on_hold	The default music on hold parameters	object()	{}	false
name	A friendly name for the account	string(1..128)		true	supported
notifications.first_occurrence.sent_initial_call	has the account made their first call	boolean()	false	false
notifications.first_occurrence.sent_initial_registration	has the account registered their first device	boolean()	false	false
notifications.first_occurrence	send emails on these account-firsts	object()		false
notifications.low_balance.enabled	should the account be checked for this alert	boolean()		false
notifications.low_balance.last_notification	Timestamp, in Gregorian seconds, of when the last low_balance alert was sent	integer()		false
notifications.low_balance.sent_low_balance	has the alert been sent (avoids duplication/spamming)	boolean()		false
notifications.low_balance.threshold	account balance to send alert on	number()		false
notifications.low_balance	Low balance settings	object()		false
notifications	account notification settings	object()		false
org	Full legal name of the organization	string()		false
preflow.always	The ID of a callflow to always execute prior to processing the callflow with numbers/patterns matching the request	string()		false
preflow	Each property provides functionality that can be applied to calls using the callflow application	object()	{}	false
realm	The realm of the account, ie: ‘account1.2600hz.com’	string(4..253)		false	supported
ringtones.external	The alert info SIP header added when the call is from internal sources	string(0..256)		false
ringtones.internal	The alert info SIP header added when the call is from external sources	string(0..256)		false
ringtones	Ringtone Parameters	object()	{}	false
timezone	The default timezone	string(5..32)		false	supported
topup.threshold	The account balance when topup occurs	number()		false
topup	Topup settings for the account	object()		false
voicemail.notify.callback	Schema for a callback options	#/definitions/notify.callback		false
voicemail.notify		object()		false
voicemail		object()		false
zones	A priority ordered mapping of zones for the account	object()		false

call_recording

endpoint recording settings

Key	Description	Type	Default	Required	Support Level
any	settings for any calls to/from the endpoint	#/definitions/call_recording.source		false
inbound	settings for inbound calls to the endpoint	#/definitions/call_recording.source		false
outbound	settings for outbound calls from the endpoint	#/definitions/call_recording.source		false

call_recording.parameters

Key	Description	Type	Default	Required	Support Level
enabled	is recording enabled	boolean()		false
format	What format to store the recording on disk	`string(‘mp3'	'wav’)`		false
record_min_sec	The minimum length, in seconds, the recording must be to be considered successful. Otherwise it is deleted	integer()		false
record_on_answer	Recording should start on answer	boolean()		false
record_on_bridge	Recording should start on bridge	boolean()		false
record_sample_rate	What sampling rate to use on the recording	integer()		false
time_limit	Time limit, in seconds, for the recording	integer()		false
url	The URL to use when sending the recording for storage	string()		false

call_recording.source

Key	Description	Type	Default	Required	Support Level
any	settings for calls from any network	#/definitions/call_recording.parameters		false
offnet	settings for calls from offnet networks	#/definitions/call_recording.parameters		false
onnet	settings for calls from onnet networks	#/definitions/call_recording.parameters		false

call_waiting

Parameters for server-side call waiting

Key	Description	Type	Default	Required	Support Level
enabled	Determines if server side call waiting is enabled/disabled	boolean()		false

caller_id

Defines caller ID settings based on the type of call being made

Key	Description	Type	Default	Required	Support Level
asserted.name	The asserted identity name for the object type	string(0..35)		false
asserted.number	The asserted identity number for the object type	string(0..35)		false
asserted.realm	The asserted identity realm for the object type	string()		false
asserted	Used to convey the proven identity of the originator of a request within a trusted network.	object()		false
emergency.name	The caller id name for the object type	string(0..35)		false
emergency.number	The caller id number for the object type	string(0..35)		false
emergency	The caller ID used when a resource is flagged as ‘emergency’	object()		false
external.name	The caller id name for the object type	string(0..35)		false
external.number	The caller id number for the object type	string(0..35)		false
external	The default caller ID used when dialing external numbers	object()		false
internal.name	The caller id name for the object type	string(0..35)		false
internal.number	The caller id number for the object type	string(0..35)		false
internal	The default caller ID used when dialing internal extensions	object()		false

dialplans

Permit local dialing by converting the dialed number to a routable form

Key	Description	Type	Default	Required	Support Level
system.[]		string()		false
system	List of system dial plans	array(string())		false

formatters

Schema for request formatters

Key	Description	Type	Default	Required	Support Level
^[[:alnum:]_]+$	Key to match in the route request JSON	`array(#/definitions/formatters.format_options)	#/definitions/formatters.format_options`		false

formatters.format_options

Schema for formatter options

Key	Description	Type	Default	Required	Support Level
direction	Only apply the formatter on the relevant request direction	`string(‘inbound'	'outbound'	'both’)`
match_invite_format	Applicable on fields with SIP URIs. Will format the username portion to match the invite format of the outbound request.	boolean()		false
prefix	Prepends value against the result of a successful regex match	string()		false
regex	Matches against the value, with optional capture group	string()		false
strip	If set to true, the field will be stripped from the payload	boolean()		false
suffix	Appends value against the result of a successful regex match	string()		false
value	Replaces the current value with the static value defined	string()		false

metaflow

A metaflow node defines a module to execute, data to provide to that module, and one or more children to branch to

Key	Description	Type	Default	Required	Support Level
children./.+/	A metaflow node defines a module to execute, data to provide to that module, and one or more children to branch to	#/definitions/metaflow		false
children	Children metaflows	object()		false
data	The data/arguments of the metaflow module	object()	{}	false
module	The name of the metaflow module to execute at this node	string(1..64)		true

metaflows

Actions applied to a call outside of the normal callflow, initiated by the caller(s)

Key	Description	Type	Default	Required	Support Level
binding_digit	What DTMF will trigger the collection and analysis of the subsequent DTMF sequence	`string(‘1'	'2'	'3'	'4'
digit_timeout	How long to wait between DTMF presses before processing the collected sequence (milliseconds)	integer()		false
listen_on	Which leg(s) of the call to listen for DTMF	`string(‘both'	'self'	'peer’)`
numbers./^[0-9]+$/	A metaflow node defines a module to execute, data to provide to that module, and one or more children to branch to	#/definitions/metaflow		false
numbers	A list of static numbers with their flows	object()		false
patterns./.+/	A metaflow node defines a module to execute, data to provide to that module, and one or more children to branch to	#/definitions/metaflow		false
patterns	A list of patterns with their flows	object()		false

notify.callback

Schema for a callback options

Key	Description	Type	Default	Required	Support Level
attempts	How many attempts without answer will system do	integer()		false
disabled	Determines if the system will call to callback number	boolean()		false
interval_s	How long will system wait between call back notification attempts	integer()		false
number	Number for callback notifications about new messages	string()		false
schedule	Schedules interval between callbacks	array(integer())		false
timeout_s	How long will system wait for answer to callback	integer()		false

Create New Account

PUT /v2/accounts

curl -v -X PUT \
    -H "X-Auth-Token: {AUTH_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"data":{"name":"child account"}}' \
    http://{SERVER}:8000/v2/accounts

{
    "auth_token": "{AUTH_TOKEN}",
    "data": {
        "billing_mode": "manual",
        "call_restriction": {},
        "caller_id": {},
        "created": 63621662701,
        "dial_plan": {},
        "enabled": true,
        "id": "{ACCOUNT_ID}",
        "is_reseller": false,
        "language": "en-us",
        "music_on_hold": {},
        "name": "child account",
        "preflow": {},
        "realm": "aeac33.sip.2600hz.com",
        "reseller_id": "undefined",
        "ringtones": {},
        "superduper_admin": false,
        "timezone": "America/Los_Angeles",
        "wnm_allow_additions": false
    },
    "request_id": "{REQUEST_ID}",
    "revision": "{REVISION}",
    "status": "success"
}

Remove an account

DELETE /v2/accounts/{ACCOUNT_ID}

curl -v -X DELETE \
    -H "X-Auth-Token: {AUTH_TOKEN}" \
    http://{SERVER}:8000/v2/accounts/{ACCOUNT_ID}

{
    "auth_token": "{AUTH_TOKEN}",
    "data": {
        "billing_mode": "manual",
        "call_restriction": {},
        "caller_id": {},
        "created": 63621662701,
        "dial_plan": {},
        "enabled": true,
        "id": "{ACCOUNT_ID}",
        "is_reseller": false,
        "language": "en-us",
        "music_on_hold": {},
        "name": "child account",
        "preflow": {},
        "realm": "aeac33.sip.2600hz.com",
        "reseller_id": "undefined",
        "ringtones": {},
        "superduper_admin": false,
        "timezone": "America/Los_Angeles",
        "wnm_allow_additions": false
    },
    "request_id": "{REQUEST_ID}",
    "revision": "{REVISION}",
    "status": "success"
}

Fetch the account doc

GET /v2/accounts/{ACCOUNT_ID}

curl -v -X GET \
    -H "X-Auth-Token: {AUTH_TOKEN}" \
    http://{SERVER}:8000/v2/accounts/{ACCOUNT_ID}

{
    "auth_token": "{AUTH_TOKEN}",
    "data": {
        "billing_mode": "manual",
        "call_restriction": {},
        "caller_id": {},
        "created": 63621662701,
        "dial_plan": {},
        "enabled": true,
        "id": "{ACCOUNT_ID}",
        "is_reseller": false,
        "language": "en-us",
        "music_on_hold": {},
        "name": "child account",
        "preflow": {},
        "realm": "aeac33.sip.2600hz.com",
        "reseller_id": "undefined",
        "ringtones": {},
        "superduper_admin": false,
        "timezone": "America/Los_Angeles",
        "wnm_allow_additions": false
    },
    "request_id": "{REQUEST_ID}",
    "revision": "{REVISION}",
    "status": "success"
}

Patch the account doc

PATCH /v2/accounts/{ACCOUNT_ID}

curl -v -X PATCH \
    -H "X-Auth-Token: {AUTH_TOKEN}" \
    -d '{"data":{"some_key":"some_value"}}' \
    http://{SERVER}:8000/v2/accounts/{ACCOUNT_ID}

{
    "auth_token": "{AUTH_TOKEN}",
    "data": {
        "billing_mode": "manual",
        "call_restriction": {},
        "caller_id": {},
        "created": 63621662701,
        "dial_plan": {},
        "enabled": true,
        "id": "{ACCOUNT_ID}",
        "is_reseller": false,
        "language": "en-us",
        "music_on_hold": {},
        "name": "child account",
        "preflow": {},
        "realm": "aeac33.sip.2600hz.com",
        "reseller_id": "undefined",
        "ringtones": {},
        "some_key":"some_value",
        "superduper_admin": false,
        "timezone": "America/Los_Angeles",
        "wnm_allow_additions": false
    },
    "request_id": "{REQUEST_ID}",
    "revision": "{REVISION}",
    "status": "success"
}

Change the account doc

POST /v2/accounts/{ACCOUNT_ID}

curl -v -X POST \
    -H "X-Auth-Token: {AUTH_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"data": {"billing_mode": "manual","call_restriction": {},"caller_id": {},"created": 63621662701,"dial_plan": {},"enabled": true,"is_reseller": false,"language": "en-us","music_on_hold": {},"name": "child account","preflow": {},"realm": "aeac33.sip.2600hz.com","reseller_id": "undefined","ringtones": {},"some_key":"some_value","superduper_admin": false,"timezone": "America/Los_Angeles","wnm_allow_additions": false}}' \
    http://{SERVER}:8000/v2/accounts/{ACCOUNT_ID}

{
    "auth_token": "{AUTH_TOKEN}",
    "data": {
        "billing_mode": "manual",
        "call_restriction": {},
        "caller_id": {},
        "created": 63621662701,
        "dial_plan": {},
        "enabled": true,
        "id": "{ACCOUNT_ID}",
        "is_reseller": false,
        "language": "en-us",
        "music_on_hold": {},
        "name": "child account",
        "preflow": {},
        "realm": "aeac33.sip.2600hz.com",
        "reseller_id": "undefined",
        "ringtones": {},
        "some_key":"some_value",
        "superduper_admin": false,
        "timezone": "America/Los_Angeles",
        "wnm_allow_additions": false
    },
    "request_id": "{REQUEST_ID}",
    "revision": "{REVISION}",
    "status": "success"
}

Create a new child account

Puts the created account under {ACCOUNT_ID}

PUT /v2/accounts/{ACCOUNT_ID}

curl -v -X PUT \
    -H "X-Auth-Token: {AUTH_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"data":{"name":"child account"}}' \
    http://{SERVER}:8000/v2/accounts/{ACCOUNT_ID}

{
    "auth_token": "{AUTH_TOKEN}",
    "data": {
        "billing_mode": "manual",
        "call_restriction": {},
        "caller_id": {},
        "created": 63621662701,
        "dial_plan": {},
        "enabled": true,
        "id": "{CHILD_ACCOUNT_ID}",
        "is_reseller": false,
        "language": "en-us",
        "music_on_hold": {},
        "name": "child account",
        "preflow": {},
        "realm": "aeac33.sip.2600hz.com",
        "reseller_id": "undefined",
        "ringtones": {},
        "superduper_admin": false,
        "timezone": "America/Los_Angeles",
        "wnm_allow_additions": false
    },
    "request_id": "{REQUEST_ID}",
    "revision": "{REVISION}",
    "status": "success"
}

Fetch the parent account IDs

GET /v2/accounts/{ACCOUNT_ID}/parents

curl -v -X GET \
    -H "X-Auth-Token: {AUTH_TOKEN}" \
    http://{SERVER}:8000/v2/accounts/{ACCOUNT_ID}/parents

{
    "auth_token": "{AUTH_TOKEN}",
    "data": [
        {
            "id": "{PARENT_ACCOUNT_ID}",
            "name": "{PARENT_ACCOUNT_NAME}"
        }
    ],
    "page_size": 1,
    "request_id": "{REQUEST_ID}",
    "revision": "{REVISION}",
    "status": "success"
}

Fetch an account’s ancestor tree

GET /v2/accounts/{ACCOUNT_ID}/tree

curl -v -X GET \
    -H "X-Auth-Token: {AUTH_TOKEN}" \
    http://{SERVER}:8000/v2/accounts/{ACCOUNT_ID}/tree

{
    "auth_token": "{AUTH_TOKEN}",
    "data": [
        {
            "id": "{PARENT_ACCOUNT_ID}",
            "name": "{PARENT_ACCOUNT_NAME}"
        }
    ],
    "page_size": 1,
    "request_id": "{REQUEST_ID}",
    "revision": "{REVISION}",
    "status": "success"
}

Fetch the account’s API key

The API key is used by the api_auth API to obtain an auth_token. This is intended for use by applications talking to kazoo and provides a mechanism for authentication that does not require storing a username and password in the application. The API key can be obtained via the accounts API’s endpoint api_key.

GET /v2/accounts/{ACCOUNT_ID}/api_key

curl -v -X GET \
    -H "X-Auth-Token: {AUTH_TOKEN}" \
     http://{SERVER}:8000/v2/accounts/{ACCOUNT_ID}/api_key

{
    "auth_token": "{AUTH_TOKEN}",
    "data": {
        "api_key": "{API_KEY}"
    },
    "request_id": "{REQUEST_ID}",
    "revision": "{REVISION}",
    "status": "success"
}

Re-create the account’s API key

If you think that your account’s API key might be exposed you can create a new one with api_key endpoint. Issuing a PUT request to this endpoint will generates a new API key for the account and will returned it in response.

PUT /v2/accounts/{ACCOUNT_ID}/api_key

curl -v -X PUT \
    -H "X-Auth-Token: {AUTH_TOKEN}" \
     http://{SERVER}:8000/v2/accounts/{ACCOUNT_ID}/api_key

{
    "auth_token": "{AUTH_TOKEN}",
    "data": {
        "api_key": "{API_KEY}"
    },
    "request_id": "{REQUEST_ID}",
    "revision": "{REVISION}",
    "status": "success"
}

Fetch sibling accounts

By default a user account under an admin/reseller account can view all the other accounts under that reseller. If you would like current account only will be able to query its child accounts’ sibling and not other accounts then set allow_sibling_listing in system_config/crossbar.accounts to false. Admin account can unrestrictedly list siblings.

GET /v2/accounts/{ACCOUNT_ID}/siblings

curl -v -X GET \
    -H "X-Auth-Token: {AUTH_TOKEN}" \
    http://{SERVER}:8000/v2/accounts/{ACCOUNT_ID}/siblings

{
    "auth_token": "{AUTH_TOKEN}",
    "data": [
        {
            "descendants_count": 1,
            "id": "{ACCOUNT_ID}",
            "name": "{ACCOUNT_NAME}",
            "realm": "{ACCOUNT_REALM}"
        }
    ],
    "page_size": 1,
    "request_id": "{REQUEST_ID}",
    "revision": "{REVISION}",
    "start_key": "",
    "status": "success"
}

Fetch all descendants of an account

This will include children, grandchildren, etc

GET /v2/accounts/{ACCOUNT_ID}/descendants

curl -v -X GET \
    -H "X-Auth-Token: {AUTH_TOKEN}" \
    http://{SERVER}:8000/v2/accounts/{ACCOUNT_ID}/descendants

{
    "auth_token": "{AUTH_TOKEN}",
    "data": [
        {
            "id": "{CHILD_ACCOUNT}",
            "name": "{CHILD_NAME}",
            "realm": "{CHILD_REALM}",
            "tree": [
                "{ACCOUNT_ID}"
            ]
        }
    ],
    "page_size": 1,
    "request_id": "{REQUEST_ID}",
    "revision": "{REVISION}",
    "start_key": "",
    "status": "success"
}

Fetch immediate children of an account

GET /v2/accounts/{ACCOUNT_ID}/children

curl -v -X GET \
    -H "X-Auth-Token: {AUTH_TOKEN}" \
    http://{SERVER}:8000/v2/accounts/{ACCOUNT_ID}/children

{
    "auth_token": "{AUTH_TOKEN}",
    "data": [
        {
            "id": "{CHILD_ACCOUNT}",
            "name": "{CHILD_NAME}",
            "realm": "{CHILD_REALM}",
            "tree": [
                "{ACCOUNT_ID}"
            ]
        }
    ],
    "page_size": 1,
    "request_id": "{REQUEST_ID}",
    "revision": "{REVISION}",
    "start_key": "",
    "status": "success"
}

Demote a reseller

Requires superduper admin auth token

DELETE /v2/accounts/{ACCOUNT_ID}/reseller

curl -v -X DELETE \
    -H "X-Auth-Token: {AUTH_TOKEN}" \
    http://{SERVER}:8000/v2/accounts/{ACCOUNT_ID}/reseller

Promote a reseller

Requires superduper admin auth token

PUT /v2/accounts/{ACCOUNT_ID}/reseller

curl -v -X PUT \
    -H "X-Auth-Token: {AUTH_TOKEN}" \
    http://{SERVER}:8000/v2/accounts/{ACCOUNT_ID}/reseller

Move an account

An account can only be moved by a “superduper_admin” or if enabled by anyone above the desired account.

NOTE: Kazoo does NOT support moving accounts between reseller accounts.

You can enable that feature by editing the document crossbar.accounts in your system_config database and set the value to tree.

Key	Value	Description
allow_move	enum(“tree”, “superduper_admin”)	Who can move a sub-account

POST /v2/accounts/{ACCOUNT_ID}/move

curl -v -X POST \
    -H "X-Auth-Token: {AUTH_TOKEN}" \
    -d '{"data": {"to": "{ACCOUNT_ID_DESTINATION}"}}' \
    http://{SERVER}:8000/v2/accounts/{ACCOUNT_ID}/move

{
    "auth_token": "{AUTH_TOKEN}",
    "data": {
        "billing_mode": "manual",
        "call_restriction": {},
        "caller_id": {},
        "created": 63621662701,
        "dial_plan": {},
        "enabled": true,
        "id": "{ACCOUNT_ID}",
        "is_reseller": false,
        "language": "en-us",
        "music_on_hold": {},
        "name": "child account",
        "preflow": {},
        "realm": "aeac33.sip.2600hz.com",
        "reseller_id": "undefined",
        "ringtones": {},
        "superduper_admin": false,
        "timezone": "America/Los_Angeles",
        "wnm_allow_additions": false
    },
    "request_id": "{REQUEST_ID}",
    "revision": "{REVISION}",
    "status": "success"
}