KAZOO 5.1 to 5.3 API Breaking Changes
Change in response data of some APIs
Historically, Kazoo would set some useful but internal and/or unchangeable data under data._read_only when fetching a single entity. Starting from the Kazoo 5.3 release, some APIs response data have been changed in which the internal and/or non-changeable fields are moved to a top level field called metadata.
The change also may include any fields that previously where under _read_only in data field of response.
This change does not applied to any API that returns a list of entities, unless otherwise is noted.
🔥 Please be informed that this only affects the APIs that returned a single entity (an account object for example), and not endpoints that operates on a list of entities, for example fetching a list of users, conferences unless otherwise noted.
All API response now should include an extra field in response payload like:
{
"data": {
// ... some field from here are moved to metadata
"_read_only": {
// these fields are now moved to metadata, _read_only does not be exists anymore
}
},
"metadata": {
// new in 5.3, includes internal fields previously included in data
}
// ... as before
}
metadata also now includes generic fields (if there are any) such as:
id: ID of the documentcreated: the UTC Gregorian seconds the document is createdmodified: the UTC Gregorian seconds the document is last updateddeleted: Indicates the document is deleted, presents on DELETE operations (soft delete or hard delete)
Impacted fields
Here you can find a list of all fields.
/accounts
Single account object returned by this API is changed.
From under data | From under data._read_only | To metadata |
|---|
wnm_allow_additions | | wnm_allow_additions |
superduper_admin | | superduper_admin |
api_key | | api_key |
created | | created |
enabled | | enabled |
reseller_id | | reseller_id |
is_reseller | | is_reseller |
billing_mode | | billing_mode |
/conferences
All real time data of conference are moved to metadata when fetching a single conference object.
From under data | From under data._read_only | To metadata |
|---|
| - | members | members |
| moderators | moderators |
| duration | duration |
| is_locked | is_locked |
| participants | participants |
| conferences | conferences |
| conference_id | conference_id |
| answered | answered |
| custom_conference_vars | custom_conference_vars |
| dynamic | dynamic |
| locked | locked |
| participants_count | participants_count |
| run_time | run_time |
| running | running |
| start_time | start_time |
| switch_external_ip | switch_external_ip |
| switch_hostname | switch_hostname |
| switch_url | switch_url |
| uuid | uuid |
| zone | zone |
| call_interaction_id | call_interaction_id |
| (ANY Other conference real time) | (ANY Other conference real time) |
/desktop
From under data | From under data._read_only | To metadata |
|---|
| - | switch_hostname | switch_hostname |
/faxes
From under data | From under data._read_only | To metadata |
|---|
| - | created | created |
| status | status |
/faxboxes
Single entity Fax box object has been changed.
From under data | From under data._read_only | To metadata |
|---|
| - | custom_smtp_address | custom_smtp_address |
/limits
From under data | From under data._read_only | To metadata |
|---|
allow_postpay | - | allow_postpay |
max_postpay_amount | - | max_postpay_amount |
/ips
From under data | From under data._read_only | To metadata |
|---|
| id | id |
| created | created |
| modified | modified |
| vsn | pvt_vsn |
| status | pvt_status |
| type | pvt_type |
| zone | pvt_zone |
| host | pvt_host |
| rev | _rev |
| | |
/multi_factor
From under data | From under data._read_only | To metadata |
|---|
| id | id |
| created | created |
| modified | modified |
/notifications
From under data | From under data._read_only | To metadata |
|---|
| id | | id |
/phone_numbers
From under data | From under data._read_only | To metadata |
|---|
id (unchanged, still accessible under data) | | id |
| carrier_module | carrier_module |
| created | created |
features (unchanged, still accessible under data) | features | features |
| is_deleted | is_deleted |
| modified | modified |
| port_id | port_id |
| port_state | port_state |
/port_requests
From under data | From under data._read_only | To metadata |
|---|
| account_id | account_id |
| account_name | account_name |
| port_authority | port_authority |
| port_authority_name | port_authority_name |
| ported_numbers | ported_numbers |
| id (unchanged) | | - |
| created (unchanged) | | - |
| modified (unchanged) | | - |
| updated (unchanged) | | |
/screenpops
From under data | From under data._read_only | To metadata |
|---|
| id | id |
| create | create |
| modified | modified |
/tasks
From under data | From under data._read_only | To metadata |
|---|
| id | id |
| node | node |
| account_id | account_id |
| auth_account_id | auth_account_id |
| category | category |
| action | action |
| file_name | file_name |
| created | created |
| start_timestamp | start_timestamp |
| end_timestamp | end_timestamp |
| total_count | total_count |
| failure_count | failure_count |
| success_count | success_count |
| status | status |
| csvs | csvs |
| submit_timestamp | submit_timestamp |
/webhooks
From under data | From under data._read_only | To metadata |
|---|
disable_reason | | disable_reason |
