Devices

About Devices

Devices are the endpoints assigned to an account that serve that account’s needs. Devices like fax machines, SIP phones, soft phone clients, and cell phones (via call forwarding), among others, can be represented by Kazoo devices.

Schema

A device be it a SIP phone or landline number

Key	Description	Type	Default	Required	Support Level
`addresses`	Device addresses	`object()`		`false`
`call_failover`	The device call failover parameters, to replace the device with an extension/phone number when device is offline.	#/definitions/call_failover		`false`
`call_forward`	Call forward settings	#/definitions/call_forward		`false`
`call_limits`	Schema for call limits	#/definitions/call_limits		`false`
`call_recording`	endpoint recording settings	#/definitions/call_recording		`false`
`call_restriction`	Device 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 device caller ID parameters	#/definitions/caller_id		`false`
`caller_id_options`	custom properties for configuring caller_id	#/definitions/caller_id_options		`false`
`contact_list.exclude`	If set to true the device is excluded from the contact list	`boolean()`		`false`	`supported`
`contact_list`	Contact List Parameters	`object()`	`{}`	`false`
`device_type`	Arbitrary device type used by the UI and billing system	`string()`		`false`
`dial_plan`	A list of rules used to modify dialed numbers	#/definitions/dialplans		`false`
`do_not_disturb.enabled`	Is do-not-disturb enabled for this device?	`boolean()`		`false`
`do_not_disturb`	DND Parameters	`object()`		`false`
`enabled`	Determines if the device is currently enabled	`boolean()`	`true`	`false`	`supported`
`exclude_from_queues`	Do not ring this device when calling user/agent in queue	`boolean()`	`false`	`false`
`flags.[]`		`string()`		`false`	`supported`
`flags`	Flags set by external applications	`array(string())`		`false`	`supported`
`formatters`	Schema for request formatters	#/definitions/formatters		`false`
`hotdesk.users./^[a-zA-Z0-9]{32}$/`	user-specific hotdesk settings	`object()`		`false`
`hotdesk.users`	The user(s) currently hotdesked into the device	`object()`		`false`
`hotdesk`	The hotdesk status of this device	`object()`		`false`
`language`	The language for the device	`string()`		`false`	`supported`
`mac_address`	The MAC Address of the device (if applicable)	`string()`		`false`	`supported`
`media`	Configure audio/video/etc media options for this device	#/definitions/endpoint.media		`false`
`metaflows`	The device metaflow parameters	#/definitions/metaflows		`false`
`mobile.mdn`	The MDN - mobile device number	`string()`		`false`
`mobile`	KAZOO devices that integrate with mobile providers	`object()`		`false`
`music_on_hold.media_id`	The ID of a media object that should be used as the music on hold	`string(0..2048)`		`false`
`music_on_hold.options.[]`		`string(‘preserve-position'	'random-start’)`		`false`
`music_on_hold.options`	Options for playing music on hold	`array(string(‘preserve-position'	'random-start’))`		`false`
`music_on_hold`	The music on hold parameters used if not a property of the device owner	`object()`	`{}`	`false`
`mwi_unsolicited_updates`	When true enables unsolicited mwi notifications	`boolean()`	`true`	`false`
`name`	A friendly name for the device	`string(1..128)`		`true`	`supported`
`outbound_flags`	List of flags (features) this device requires when making outbound calls	`array(string())	object()`		`false`
`owner_id`	The ID of the user object that ‘owns’ the device	`string(32)`		`false`
`presence_aliases`	Presence Aliases	#/definitions/presence_aliases		`false`
`presence_id`	Static presence ID (used instead of SIP username)	`string()`		`false`	`supported`
`provision.check_sync_event`	Value to use in Event header for device reload/reboot	`string()`		`false`
`provision.check_sync_reboot`	Value to append to ‘check-sync’ event if phone should reboot after reloading settings	`string()`	`reboot=true`	`false`
`provision.check_sync_reload`	Value to append to ‘check-sync’ event if phone should not reboot after reloading settings	`string()`	`reboot=false`	`false`
`provision.combo_keys./^[0-9]+$/`	Device provisioner Combo/Feature Key	#/definitions/devices.combo_key		`false`
`provision.combo_keys`		`object()`		`false`
`provision.endpoint_brand`	Brand of the phone	`string()`		`false`
`provision.endpoint_family`	Family name of the phone	`string()`		`false`
`provision.endpoint_model`	Model name of the phone	`string()	integer()`		`false`
`provision.feature_keys./^[0-9]+$/`	Device provisioner Combo/Feature Key	#/definitions/devices.combo_key		`false`
`provision.feature_keys`		`object()`		`false`
`provision.id`	Provisioner Template ID	`string()`		`false`
`provision`	Provision data	`object()`		`false`
`register_overwrite_notify`	When true enables overwrite notifications	`boolean()`	`false`	`false`
`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`
`sip.custom_sip_headers.in`	Custom SIP Headers to be applied to calls inbound to Kazoo from the endpoint	#/definitions/custom_sip_headers		`false`
`sip.custom_sip_headers.out`	Custom SIP Headers to be applied to calls outbound from Kazoo to the endpoint	#/definitions/custom_sip_headers		`false`
`sip.custom_sip_headers.^[a-zA-z0-9_\-]+$`	The SIP header to add	`string()	boolean()	integer()`
`sip.custom_sip_headers`	A property list of SIP headers	`object()`		`false`
`sip.custom_sip_interface`	If the bridge string should target a different SIP interface	`string()`		`false`
`sip.expire_seconds`	The time, in seconds, sent to the provisioner for the registration period that the device should be configured with.	`integer()`	`300`	`false`	`supported`
`sip.forward`	Forward IP to use	`string()`		`false`
`sip.ignore_completed_elsewhere`	When set to false the phone should not consider ring group calls answered elsewhere as missed	`boolean()`		`false`
`sip.invite_format`	The SIP request URI invite format	`string(‘username'	'npan'	'1npan'	'e164'
`sip.ip`	IP address for this device	`string()`		`false`	`supported`
`sip.method`	Method of authentication	`string(‘password'	'ip'	'authorization’)`	`password`
`sip.number`	The number used if the invite format is 1npan, npan, or e164 (if not set the dialed number is used)	`string()`		`false`
`sip.password`	SIP authentication password	`string(5..32)`		`false`	`supported`
`sip.proxy`	Proxy IP address to use	`string()`		`false`
`sip.realm`	The realm this device should use, overriding the account realm. Should rarely be necessary.	`string(4..253)`		`false`
`sip.route`	The SIP URL used if the invite format is ‘route’	`string()`		`false`	`supported`
`sip.static_invite`	SIP To user	`string()`		`false`
`sip.static_route`	Sends all inbound calls to this string (instead of dialed number or username)	`string()`		`false`
`sip.transport`	SIP Transport to use	`string()`		`false`
`sip.username`	SIP authentication username	`string(2..32)`		`false`	`supported`
`sip`	SIP Parameters	`object()`	`{}`	`false`
`suppress_unregister_notifications`	When true disables deregister notifications	`boolean()`	`false`	`false`
`timezone`	Device’s timezone	#/definitions/timezone		`false`	`supported`

addresses

Account, user or device addresses

Key	Description	Type	Default	Required
`emergency.additional_information`	Additional location information. Example: Room 543	`string()`		`false`
`emergency.callback_cid_number`	10-digit DID used as caller ID to PSAP, overrides CID	`string(10)`		`false`
`emergency.country`	The country is identified by the two-letter ISO 3166 code. Example: US	`string()`		`true`
`emergency.county`	County, parish, gun (JP), district (IN). Example: King’s County	`string()`		`false`
`emergency.delivery_method`	How the emergency call is routed by the destination handler (not applicable to all providers)	`string(‘direct'	'three_way'	'security_desk’)`
`emergency.floor`	Floor. Example: 4	`integer()`		`false`
`emergency.house_number`	House number, numeric part only. Example: 123	`integer()`		`true`
`emergency.house_number_suffix`	House number suffix. Example: A, 1/2	`string()`		`false`
`emergency.latitude`	The geo-position of a location, north or south of the equator, using WGS84 formatting	`string(0..11)`		`false`
`emergency.locality`	City, township, shi (JP). Example: New York	`string()`		`true`
`emergency.location_identifier`	United States unique 10-digit number known as an E911 location identifier (ELIN)	`integer()`		`false`
`emergency.longitude`	The geo-position of a location, east or west of the prime meridian, using WGS84 formatting	`string(0..11)`		`false`
`emergency.name`	Name (residence, business or office occupant). Example: Joe’s Barbershop	`string()`		`true`
`emergency.postal_code`	Postal code. Example: 10027-0401	`string()`		`true`
`emergency.region`	National subdivisions (state, region, province, prefecture). Example: New York	`string()`		`true`
`emergency.street`	Primary road or street. Example: Broadway	`string()`		`true`
`emergency.street_direction`	Leading street direction. Example: N, W	`string()`		`false`
`emergency.street_suffix`	Trailing street suffix. Example: SW	`string()`		`false`
`emergency.street_type`	Street type. Example: Avenue, Platz, Street	`string()`		`false`
`emergency`	Emergency address	`object()`		`false`

call_failover

The device call failover parameters, to replace the device with an extension/phone number when device is offline.

Key	Description	Type	Default	Required	Support Level
`direct_calls_only`	Determines if the calls that are not directly sent to the device should be forwarded	`boolean()`	`false`	`false`	`supported`
`enabled`	Determines if the call failover should be used when device is offline	`boolean()`	`false`	`false`
`ignore_early_media`	The option to determine if early media from the call forwarded number should ignored	`boolean()`	`true`	`false`
`keep_caller_id`	Determines if the caller id is kept when the call is forwarded, if not the devices caller id is used	`boolean()`	`true`	`false`	`supported`
`number`	The number to forward calls to	`string(0..35)`		`false`	`supported`
`require_keypress`	Determines if the callee is prompted to press 1 to accept the call	`boolean()`	`true`	`false`

call_forward

Call Forward

Key	Description	Type	Default	Required
`busy`	Call Forward Properties	`object()`		`false`
`direct_calls_only`		`boolean()`	`false`	`false`
`enabled`		`boolean()`	`false`	`true`
`ignore_early_media`		`boolean()`	`true`	`false`
`keep_caller_id`		`boolean()`	`true`	`false`
`no_answer`	Call Forward Properties	`object()`		`false`
`number`		`string(0..35)`		`false`
`require_keypress`		`boolean()`	`true`	`false`
`selective.direct_calls_only`		`boolean()`	`false`	`false`
`selective.enabled`		`boolean()`	`false`	`false`
`selective.ignore_early_media`		`boolean()`	`true`	`false`
`selective.keep_caller_id`		`boolean()`	`true`	`false`
`selective.number`		`string(0..35)`		`false`
`selective.require_keypress`		`boolean()`	`true`	`false`
`selective.rules.[].direct_calls_only`		`boolean()`	`false`	`false`
`selective.rules.[].enabled`		`boolean()`	`false`	`false`
`selective.rules.[].ignore_early_media`		`boolean()`	`true`	`false`
`selective.rules.[].keep_caller_id`		`boolean()`	`true`	`false`
`selective.rules.[].match_list_id`		`string()`		`false`
`selective.rules.[].number`		`string(0..35)`		`false`
`selective.rules.[].require_keypress`		`boolean()`	`true`	`false`
`selective.rules`	Match list rules to check for call forwarding	`array(object())`		`false`
`selective`	Conditionally check match lists to determine if call forwarding should be used	`object()`		`false`
`substitute`	Determines if the call forwarding replaces the device	`boolean()`	`true`	`false`
`unconditional`	Call Forward Properties	`object()`		`false`

call_forward_type

Call Forward Properties

Key	Type	Default	Required
`direct_calls_only`	`boolean()`	`false`	`false`
`enabled`	`boolean()`	`false`	`true`
`ignore_early_media`	`boolean()`	`true`	`false`
`keep_caller_id`	`boolean()`	`true`	`false`
`number`	`string(0..35)`		`false`
`require_keypress`	`boolean()`	`true`	`false`

call_limits

Schema for call limits

Key	Description	Type	Default	Required	Support Level
`max_concurrent`	Maximum number of concurrent calls allowed per endpoint	`integer()`		`false`

call_recording

endpoint recording settings

Key	Description	Type	Required
`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`
`should_announce_when_recording`	Whether or not a prompt should be played (after bridge) when the call is being recorded	`boolean()`		`false`
`should_record_feature_calls`	Toggles whether to start a recording for calls to feature codes	`boolean()`	`true`	`false`
`time_limit`	Time limit, in seconds, for the recording	`integer(5..10800)`		`false`
`url`	The URL to use when sending the recording for storage	`string(6..)`		`false`

call_recording.source

Key	Description	Type	Required
`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	Required
`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`

caller_id_options

Caller ID options for endpoints

Key	Description	Type	Default	Required	Support Level
`format./.+/.prefix`	Prefix to add to captured group of regex	`string()`		`false`
`format./.+/.regex`	Regexp to match normalized CID and use first capture group	`string()`		`false`
`format./.+/.suffix`	Prefix to add to captured group of regex	`string()`		`false`
`format./.+/`	Format to use for the CID classification	`object()`		`false`
`format.all.prefix`	Prefix to add to captured group of regex	`string()`		`false`
`format.all.regex`	Regexp to match normalized CID and use first capture group	`string()`		`false`
`format.all.suffix`	Prefix to add to captured group of regex	`string()`		`false`
`format.all`	Format to use for all CID formatting needs (vs per-classifier)	`object()`		`false`
`format`	Object for CID formatters based on number classifiers	`object()`		`false`
`ignore_completed_elsewhere`	Suppress the completed elsewhere cause	`boolean()`		`false`
`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’)`
`privacy_method`	Method to use for anonymizing CID	`string(‘sip'	'none'	'kazoo’)`
`show_rate`	Whether to show the rate	`boolean()`		`false`
`type`	Caller ID on endpoint to choose	`string(‘internal'	'external'	'emergency’)`

codecs.audio

A list of audio codecs the endpoint supports

Key	Description	Type	Default	Required	Support Level

codecs.video

A list of video codecs the endpoint supports

Key	Description	Type	Default	Required	Support Level

custom_sip_headers

Custom SIP headers applied to an INVITE

Key	Description	Type	Default	Required	Support Level
`^[a-zA-z0-9_\-]+$`	The SIP header to add	`string()	boolean()	integer()`

devices.combo_key

Device provisioner Combo/Feature Key

Key	Description	Type	Default	Required	Support Level

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`

endpoint.media

Schema for endpoint media options

Key	Description	Type	Default	Required	Support Level
`audio.codecs`	A list of audio codecs the endpoint supports	#/definitions/codecs.audio		`false`
`audio`	The audio media parameters	`object()`	`{}`	`false`
`bypass_media`	Default bypass media mode (The string type is deprecated, please use this as a boolean)	`boolean()	string(‘auto'	'false'	'true’)`
`encryption.enforce_security`	Is Encryption Enabled?	`boolean()`	`false`	`false`
`encryption.methods.[]`		`string(‘zrtp'	'srtp’)`		`false`
`encryption.methods`	Supported Encryption Types	`array(string(‘zrtp'	'srtp’))`	`[]`	`false`
`encryption`	Encryption Parameters	`object()`	`{}`	`false`
`fax_option`	Is T.38 Supported?	`boolean()`		`false`
`ignore_early_media`	The option to determine if early media from the endpoint should always be ignored	`boolean()`		`false`
`progress_timeout`	The progress timeout to apply to the endpoint (seconds)	`integer()`		`false`
`video.codecs`	A list of video codecs the endpoint supports	#/definitions/codecs.video		`false`
`video`	The video media parameters	`object()`	`{}`	`false`
`webrtc`	If true, forces a WebRTC compatible SDP on the INVITE	`boolean()`		`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
`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
`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(0..)`		`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`

presence_aliases

Endpoint Presence Aliases

Key	Description	Type	Default	Required	Support Level

timezone

The default timezone

Key	Description	Type	Default	Required	Support Level

Call forwarding

Legacy format

Currently the call_forward object allows you to define call forwarding or failover but not both. If call_forward.enabled is true it will take precedence and settings will be used only for call forwarding. If call_forward.enabled is false and call_forward.failover is true, failover settings will be used.

5.2 and beyond

In 5.2, call forwarding is being retooled to allow more dynamic decision-making for when to use the forwarding settings, one example being only allow a list of caller IDs to be sent through to the call-forwarding settings if the device fails to be rung.

As such, the call_forward object (if it exists) will be transformed into a set of sub-objects representing the new call forwarding options.

KAZOO will automatically “fix” the legacy format to the new format when processing calls; saving of the device doc with “call_forward” in legacy mode will result in schema errors.

Mapping legacy settings to the new format

It is a straight-forward process to move to the new format.

For system admins, sup crossbar_maintenance migrate_call_forward {ACCOUNT_ID} will migrate individual accounts. Normal sup kapps_maintenance migrate will also walk the account databases and migrate necessary docs.

For API clients, move the legacy call forwarding settings under the unconditional key:

Legacy JSON:

{
  "call_forward": {
    "enabled": "{ENABLED}",
    "number": "{CFWD_DID}"
  }
}

Converts to:

{
  "call_forward": {
    "unconditional": {
      "enabled": "{ENABLED}",
      "number": "{CFWD_DID}"
    }
  }
}

Example `call_forward` settings

As noted above, to always forward the device/user to a PSTN number:

{
  "call_forward": {
    "unconditional": {
      "enabled": true,
      "number": "{PSTN_NUMBER}"
    }
  }
}

For forwarding only when the device/user doesn’t answer, replace unconditional with no_answer. For when a device/user is “busy”, use busy. The settings under those keys are identical.

Selective call forwarding

Selective call forwarding allows the device/user’s call forwarding settings to only apply in certain cases. For instance, you may want calls from your family to route to your cell phone instead of your SIP devices.

To do so, the selective settings for call forwarding include a list of rules that map to matchlists where you can configure the logic around when to call forward.

For example, a simple match list based on the caller ID number could be created thusly:

curl -X PUT \
    -X "X-Auth-Token: {AUTH_TOKEN}" \
    -d '{"data":{"name":"My Call Forwarding Rules","rules":[{"name":"Match CID","regex":"41588679\\d{2}","target":"caller_id_number","type":"regex"}]}} \
    http://{SERVER}:8000/v2/accounts/{ACCOUNT_ID}/match_lists

The match list JSON:

{
  "name": "My Call Forwarding Rules",
  "rules": [
    {
      "name": "Match CID",
      "regex": "41588679\\d{2}",
      "target": "caller_id_number",
      "type": "regex"
    }
  ]
}

Capture the match list ID from the response, then create the call_forward settings:

{
  "call_forward": {
    "enabled": true,
    "selective": {
      "enabled": true,
      "number": "+14158867900",
      "rules": [
        {
          "enabled": true,
          "match_list_id": "{MATCH_LIST_ID}"
        }
      ]
    }
  }
}

PUT/POST/PATCH that to the device/user and only calls with caller ID matching 41588679 plus any two digits will be forwarded to the number configured.

Fetch the device summary

Lists all devices in an account.

GET /v2/accounts/{ACCOUNT_ID}/devices

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

{
    "auth_token": "{AUTH_TOKEN}",
    "data": [
        {
            "id": "4ee2d01d474a92ca299bb311efd23cef",
            "name": "Device1 Admin",
            "enabled": true,
            "flags": [],
            "features": [],
            "owner_id": "96f99542f33c180790d1836192300c27",
            "device_type": "sip_device",
            "mac_address": "001122334455",
            "username": "user_meme"
        }
    ],
    "page_size": 1,
    "request_id": "{REQUEST_ID}",
    "revision": "{REVISION}",
    "status": "success"
}

New in Kazoo 5: List devices with their statuses

Using Kazoo 5+, If query string ?with_status=true is set result will also includes the device registration statuses (see Fetch registration statuses of all devices):

curl -v -X GET \
    -X "X-Auth-Token: {AUTH_TOKEN} \
    http://{SERVER}:8000/v2/accounts/{ACCOUNT_ID}/devices?with_status=true

{
    "auth_token": "{AUTH_TOKEN}",
    "data": [
        {
            "id": "4ee2d01d474a92ca299bb311efd23cef",
            "name": "Device1 Admin",
            "enabled": true,
            "flags": [],
            "features": [],
            "owner_id": "96f99542f33c180790d1836192300c27",
            "device_type": "sip_device",
            "mac_address": "001122334455",
            "username": "user_meme",
            "registrable": true,
            "registered": true
        }
    ],
    "page_size": 1,
    "request_id": "{REQUEST_ID}",
    "revision": "{REVISION}",
    "status": "success"
}

Create a new device

See the schema for available fields to include in the data portion

PUT /v2/accounts/{ACCOUNT_ID}/devices

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

{
    "auth_token": "{AUTH_TOKEN}",
    "data": {
        "call_restriction": {},
        "caller_id": {},
        "contact_list": {},
        "dial_plan": {},
        "enabled": true,
        "exclude_from_queues": false,
        "id": "{DEVICE_ID}",
        "media": {
            "audio": {
                "codecs": [
                    "PCMU"
                ]
            },
            "encryption": {
                "enforce_security": false,
                "methods": []
            },
            "video": {
                "codecs": []
            }
        },
        "music_on_hold": {},
        "mwi_unsolicited_updates": true,
        "name": "New Device",
        "register_overwrite_notify": false,
        "ringtones": {},
        "sip": {
            "invite_format": "username",
            "method": "password",
            "registration_expiration": 300
        },
        "suppress_unregister_notifications": false
    },
    "request_id": "{REQUEST_ID}",
    "revision": "{REVISION}",
    "status": "success"
}

Remove a device

DELETE /v2/accounts/{ACCOUNT_ID}/devices/{DEVICE_ID}

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

{
    "auth_token": "{AUTH_TOKEN}",
    "data": {
        "call_restriction": {},
        "caller_id": {},
        "contact_list": {},
        "dial_plan": {},
        "enabled": true,
        "exclude_from_queues": false,
        "id": "{DEVICE_ID}",
        "media": {
            "audio": {
                "codecs": [
                    "PCMU"
                ]
            },
            "encryption": {
                "enforce_security": false,
                "methods": []
            },
            "video": {
                "codecs": []
            }
        },
        "music_on_hold": {},
        "mwi_unsolicited_updates": true,
        "name": "New Device",
        "register_overwrite_notify": false,
        "ringtones": {},
        "sip": {
            "invite_format": "username",
            "method": "password",
            "registration_expiration": 300
        },
        "suppress_unregister_notifications": false
    },
    "request_id": "{REQUEST_ID}",
    "revision": "{REVISION}",
    "status": "success"
}

Fetch a device

GET /v2/accounts/{ACCOUNT_ID}/devices/{DEVICE_ID}

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

{
    "auth_token": "{AUTH_TOKEN}",
    "data": {
        "call_restriction": {},
        "caller_id": {},
        "contact_list": {},
        "dial_plan": {},
        "enabled": true,
        "exclude_from_queues": false,
        "id": "{DEVICE_ID}",
        "media": {
            "audio": {
                "codecs": [
                    "PCMU"
                ]
            },
            "encryption": {
                "enforce_security": false,
                "methods": []
            },
            "video": {
                "codecs": []
            }
        },
        "music_on_hold": {},
        "mwi_unsolicited_updates": true,
        "name": "New Device",
        "register_overwrite_notify": false,
        "ringtones": {},
        "sip": {
            "invite_format": "username",
            "method": "password",
            "registration_expiration": 300
        },
        "suppress_unregister_notifications": false
    },
    "request_id": "{REQUEST_ID}",
    "revision": "{REVISION}",
    "status": "success"
}

Change a device doc

Including "sync":true in the “data” will attempt to reboot the phone. See the sync section below.

POST /v2/accounts/{ACCOUNT_ID}/devices/{DEVICE_ID}

curl -v -X POST \
    -H "X-Auth-Token: {AUTH_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"data":{
        "name": "new device",
        "call_restriction": {},
        "caller_id": {},
        "contact_list": {},
        "dial_plan": {},
        "enabled": true,
        "exclude_from_queues": false,
        "media": {
            "audio": {"codecs": ["PCMU"]},
            "encryption": {"enforce_security": false, "methods": []},
            "video": {"codecs": []}
        },
        "music_on_hold": {},
        "mwi_unsolicited_updates": true,
        "register_overwrite_notify": false,
        "ringtones": {},
        "sip": {
            "invite_format": "username",
            "method": "password",
            "registration_expiration": 300
        },
        "suppress_unregister_notifications": false,
        "id": "4f3330e78e664bb57f8fb23fbaac2429"
        }}' \
    http://{SERVER}:8000/v2/accounts/{ACCOUNT_ID}/devices/{DEVICE_ID}

{
    "auth_token": "{AUTH_TOKEN}",
    "data": {
        "call_restriction": {},
        "caller_id": {},
        "contact_list": {},
        "dial_plan": {},
        "enabled": true,
        "exclude_from_queues": false,
        "id": "{DEVICE_ID}",
        "media": {
            "audio": {
                "codecs": [
                    "PCMU"
                ]
            },
            "encryption": {
                "enforce_security": false,
                "methods": []
            },
            "video": {
                "codecs": []
            }
        },
        "music_on_hold": {},
        "mwi_unsolicited_updates": true,
        "name": "new device",
        "register_overwrite_notify": false,
        "ringtones": {},
        "sip": {
            "invite_format": "username",
            "method": "password",
            "registration_expiration": 300
        },
        "suppress_unregister_notifications": false
    },
    "request_id": "{REQUEST_ID}",
    "revision": "{REVISION}",
    "status": "success"
}

Patch a device

PATCH /v2/accounts/{ACCOUNT_ID}/devices/{DEVICE_ID}

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

{
    "auth_token": "{AUTH_TOKEN}",
    "data": {
        "call_restriction": {},
        "caller_id": {},
        "contact_list": {},
        "dial_plan": {},
        "enabled": true,
        "exclude_from_queues": false,
        "id": "{DEVICE_ID}",
        "media": {
            "audio": {
                "codecs": [
                    "PCMU"
                ]
            },
            "encryption": {
                "enforce_security": false,
                "methods": []
            },
            "video": {
                "codecs": []
            }
        },
        "music_on_hold": {},
        "mwi_unsolicited_updates": true,
        "name": "new device",
        "presence_id":"dis_my_device",
        "register_overwrite_notify": false,
        "ringtones": {},
        "sip": {
            "invite_format": "username",
            "method": "password",
            "registration_expiration": 300
        },
        "suppress_unregister_notifications": false
    },
    "request_id": "{REQUEST_ID}",
    "revision": "{REVISION}",
    "status": "success"
}

Send a SIP NOTIFY to a device

Kazoo will generate the NOTIFY packet if the device is registered.

PUT body options:

Key	Description	Type	Required
`data.body.content_type`	The Content-Type of the data in the NOTIFY content body	`string()`	`true`
`data.body.data`	The NOTIFY content body	`string()`	`true`
`data.body`	Parameters of content body of SIP NOTIFY	`object()`	`false`
`data.event`	Event header value for SIP NOTIFY	`string()`	`true`
`data`	Action-specific parameters	`object()`	`true`

PUT /v2/accounts/{ACCOUNT_ID}/devices/{DEVICE_ID}

curl -v -X POST \
    -H "X-Auth-Token: {AUTH_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"action": "notify",
         "data":{
           "data": {
             "event": "event"
             ,"body":{
               "content_type":"application/xml"
               ,"data":"NOTIFY body content"
             }
           }
         }
        }' \
    http://{SERVER}:8000/v2/accounts/{ACCOUNT_ID}/devices/{DEVICE_ID}

An example for a Yealink might look like (thanks to forum user https://forums.2600hz.com/forums/topic/12045-sip-notify/#comment-62381 for the suggestion):

{
    "action": "notify"
    ,"data": {
        "data": {
            "event": "Yealink-xml",
            "body": {
                "data": "<YealinkIPPhoneTextScreen destroyOnExit=\"true\" Beep=\"true\" Timeout=\"0\" LockIn=\"false\"><Title wrap=\"true\">Title</Title><Text>Hello!</Text></YealinkIPPhoneTextScreen>",
                "content_type": "application/xml"
            }
        }
    }
}

Fetch registration statuses of all devices

This will fetch the current registrations of any devices.

New in Kazoo 5:

This will list all devices including non-registered devices. Some device types will never be expected to be registered. This list of device types are stored in System Config always_registered_device_types in crossbar.devices.

New field registrable is added to show if the device is registrable or not.

You can also use /v2/accounts/{ACCOUNT_ID}/devices?with_status=true if you need more info about the devices.

GET /v2/accounts/{ACCOUNT_ID}/devices/status

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

{
    "auth_token": "{AUTH_TOKEN}",
    "data": [
        {
            "device_id": "{DEVICE_ID_1}",
            "registrable": true,
            "registered": true
        },
        {
            "device_id": "{DEVICE_ID_2}",
            "registrable": false
        }
    ],
    "request_id": "{REQUEST_ID}",
    "revision": "{REVISION}",
    "status": "success"
}

Push payload to device

See pushes.md for information about this action.

Reboot a device

Some devices support receiving SIP NOTIFY packets with event = check-sync. This is typically used to reboot the phone if the configuration has changed. Kazoo will generate the NOTIFY packet if the device is registered.

POST /v2/accounts/{ACCOUNT_ID}/devices/{DEVICE_ID}/sync

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

{
    "auth_token": "{AUTH_TOKEN}",
    "data": "sync request sent",
    "request_id": "{REQUEST_ID}",
    "revision": "{REVISION}",
    "status": "success"
}

Reboot or not after syncing

If your device can support it, you can toggle whether to reboot the phone after it resyncs its configuration.

On the device document, set provision.check_sync_reboot to the suffix to add to the check-sync event when syncing the phone and rebooting.

On the device document, set provision.check_sync_reload to the suffix to add to the check-sync event when syncing the phone when not rebooting.

And of course you can override the check-sync prefix with provision.check_sync_event.

Rebooting example

The device settings:

{"provision":{
   "check_sync_reboot":"reboot=true"
 }
}

API to force the reboot: POST /v2/accounts/{ACCOUNT_ID}/devices/{DEVICE_ID}/sync?reboot=true

Will generate Event: check-sync;reboot=true in the SIP NOTIFY.

Reloading example

The device settings:

{"provision":{
   "check_sync_reload":"reboot=false"
 }
}

API to force the reboot: POST /v2/accounts/{ACCOUNT_ID}/devices/{DEVICE_ID}/sync?reboot=false

Will generate Event: check-sync;reboot=false in the SIP NOTIFY.

Check Sync Event

Should the device respond to a different value for the purposes of syncing, it can be overridden in the provision.check_sync_event.

There is also a system_config in crossbar.devices, check_sync_event, that can be set for defaults.

Quickcalls

See the quickcall docs for how to perform this action.

Adding Ringtones

You can setup internal and external ringtones by adding this:

{
    "name": "Device with custom ringtones",
    "ringtones": {
        "internal": "alert info SIP header",
        "external": "alert info SIP header"
    }
}

See, for instance, the Polycom example

Load a user’s devices

Often you’ll want to see what devices belong to a user, or devices that a user has hot-desked into.

Notice that the first device, {DEVICE_ID_1} is owned by {USER_ID} but the second device, {DEVICE_ID_2}, is owned by {OWNER_ID} and is currently hotdesked to {USER_ID} (see the "hotdesked":true attribute).

GET /v2/accounts/{ACCOUNT_ID}/users/{USER_ID}/devices

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

{
    "auth_token": "{AUTH_TOKEN}",
    "data": [
        {
            "device_type": "sip_device",
            "enabled": true,
            "hotdesked": false,
            "id": "{DEVICE_ID_1}",
            "mac_address": "",
            "name": "USER_ID_DEVICE",
            "owner_id": "{USER_ID}"
        },
        {
            "device_type": "sip_device",
            "enabled": true,
            "hotdesked": true,
            "id": "{DEVICE_ID_2}",
            "mac_address": "",
            "name": "OWNER_ID_DEVICE",
            "owner_id": "{OWNER_ID}"
        }
      ],
     "request_id": "{REQUEST_ID}",
     "revision": "{REVISION}",
     "status": "success"
}

Create an Authn-By-IP Device

Here is a minimal API request that creates a device that will authenticate by IP address instead of username/password

PUT /v2/accounts/{ACCOUNT_ID}/devices

    curl -v -X PUT \
    -H "X-Auth-Token: {AUTH_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"data":{"enabled":true,"name":"authn_by_ip","sip":{"invite_format":"e164", "ip":"{IP_ADDRESS}","method":"ip"}}}' \
    http://{SERVER}:8000/v2/accounts/{ACCOUNT_ID}/devices

{
    "auth_token": "{AUTH_TOKEN}",
    "data": {
        "call_restriction": {},
        "caller_id": {},
        "contact_list": {},
        "dial_plan": {},
        "enabled": true,
        "exclude_from_queues": false,
        "id": "{DEVICE_ID}",
        "media": {
            "audio": {
                "codecs": [
                    "PCMU"
                ]
            },
            "encryption": {
                "enforce_security": false,
                "methods": []
            },
            "video": {
                "codecs": []
            }
        },
        "music_on_hold": {},
        "mwi_unsolicited_updates": true,
        "name": "authn_by_ip",
        "register_overwrite_notify": false,
        "ringtones": {},
        "sip": {
            "invite_format": "e164",
            "ip": "{IP_ADDRESS}",
            "method": "ip",
            "registration_expiration": 300
        },
        "suppress_unregister_notifications": false
    },
    "request_id": "{REQUEST_ID}",
    "revision": "{REVISION}",
    "status": "success"
}

Devices

About Devices

Schema

addresses

call_failover

call_forward

call_forward_type

call_limits

call_recording

call_recording.parameters

call_recording.source

call_waiting

caller_id

caller_id_options

codecs.audio

codecs.video

custom_sip_headers

devices.combo_key

dialplans

endpoint.media

formatters

formatters.format_options

metaflow

metaflows

presence_aliases

timezone

Call forwarding

Legacy format

5.2 and beyond

Mapping legacy settings to the new format

Example call_forward settings

Selective call forwarding

Fetch the device summary

New in Kazoo 5: List devices with their statuses

Create a new device

Remove a device

Fetch a device

Change a device doc

Patch a device

Send a SIP NOTIFY to a device

Fetch registration statuses of all devices

Push payload to device

Reboot a device

Reboot or not after syncing

Rebooting example

Reloading example

Check Sync Event

Quickcalls

Adding Ringtones

Load a user’s devices

Create an Authn-By-IP Device

On this page

Example `call_forward` settings