Changelog
Every API change, in the open. Breaking changes get 90 days' notice and a migration guide.
Device user device list endpoint added
Introduced GET /v3/deviceuser/device allowing authenticated device users to retrieve their assigned non-fax devices scoped to their account.
VoIP WebSocket settings endpoint added
Added GET /v3/websocket/setting to retrieve WebSocket connection URLs, protocols, and conference/presence event subscription parameters.
Call routing destination options endpoint added
Added GET /v3/callrouting/options/:category to return available selectable destinations (label and ID) for a given call routing category.
Call routing category list endpoint added
Added GET /v3/callrouting/category/:model/:field to retrieve selectable destination categories based on the edited model and form field.
Fix user role mapping on Account details endpoint
Resolved an issue where GET /v3/account/:id?users=true returned identical roles across all users instead of their assigned roles.
Account list name filter support
Fixed GET /v3/account to properly respect the name query parameter with partial string matching and updated pagination counts.
Numeric ID field added to Account list response
Enhanced GET /v3/account response data objects to return the numeric id field alongside id26 for consistency with other resource endpoints.
Device user self-service call routing endpoint
Added GET /v3/deviceuser/callrouting to allow authenticated device users to retrieve their own call routing associations.
Webphone SIP credentials endpoint added
Added GET /v3/deviceuser/:input_param/webphone/sipcreds to retrieve webphone SIP authentication credentials and server details.
Device user lookup by device ID
Added GET /v3/device/:device_kazoo_id/deviceuser to retrieve the assigned device user and configuration details for a specific device.
Voicemail audio file and transcription endpoints added
Added GET /v3/voicemail/:id/file to download voicemail audio recordings and GET /v3/voicemail/:id/transcription to retrieve transcribed text.
Webhook API enabled for account and reseller clients
Unblocked the /v3/webhook endpoints to enable programmatic webhook registration and verification for event notifications (including e911 alerts).
Fix device line keys JSON serialization error
Fixed an issue where unescaped control characters in device line keys caused GET /v3/device pagination requests to fail with HTTP 400.
Fix invoice PDF download URL generation
Resolved an issue where GET /v3/finance/invoice/:invoice_id/pdf generated download URLs with a 0 account ID, unblocking PDF retrieval.
Fix device user payload when voicemail is disabled
Resolved an issue where GET /v3/deviceuser omitted assigned devices from the response when a device user had voicemail disabled.
Fix presence group settings and ID responses
Fixed SQL query errors on GET /v3/presencegroup/setting and added missing ID fields to presence group list and detail responses.
Call Recording V3 API suite released
Introduced GET /v3/callrecording list and detail endpoints featuring role-based access control, date filtering, pagination, and temporary signed audio download URLs.
Faxbox V3 endpoints unblocked
Enabled GET /v3/faxbox and GET /v3/faxbox/:faxbox_id for reseller and account-level authentication.
Finance Payment and Credit API validation enhancements
Enhanced GET /v3/finance/payment and GET /v3/finance/credit to validate page_size bounds (1–100), enforce date range ordering (start_date <= end_date), ensure inclusive end date matching, and reject invalid status values.
Finance Order cancelled accounts filter validation
Fixed include_canceled_accounts filter handling on GET /v3/finance/order to strictly validate boolean values and properly filter cancelled accounts.
Device user avatar retrieval endpoint added
Added GET /v3/deviceuser/{device_user_id}/avatar to retrieve a device user's avatar image or default silhouette.
Device user personal information endpoint added
Added GET /v3/deviceuser/{device_user_id}/myinfo to retrieve personal, account, and telephony configuration details for a device user.
Device user channel list endpoint added
Added GET /v3/deviceuser/channel to retrieve real-time channel and device connection state for the authenticated device user.
Phone number endpoints updated to include number type
Added the number_type classification field to GET /v3/phonenumber and GET /v3/phonenumber/{phone_number_id} response payloads.
Finance Order and Invoice query parameter validation fixes
Enhanced GET /v3/finance/order and GET /v3/finance/invoice with strict validation for sort formatting, status enumerations (paid, paid_partial, unpaid), date ordering, and inclusive end date filtering.