API Changelog

Version 8.2 (from 8.1)​

🚨 Breaking Changes​

High Severity

• GET /org/{tenant}/v2/ai/providers — for the query request parameter page, default value 1.00 was removed
• GET /org/{tenant}/v2/departments — for the query request parameter page, default value 1.00 was removed
• GET /org/{tenant}/v2/extensions — for the query request parameter page, default value 1.00 was removed
• PATCH /org/{tenant}/v2/extensions/{id}/enhanced-services/caller-id — the default_trunk request property type changed from any to object
• POST /org/{tenant}/v2/sms/messages — added the pattern ^(default|\d{3})$ to the path request parameter tenant
• GET /org/{tenant}/v2/uads — for the query request parameter page, default value 1.00 was removed
• GET /system/v2/ai/providers — for the query request parameter page, default value 1.00 was removed
• GET /system/v2/service-plans — for the query request parameter page, default value 1.00 was removed
• GET /system/v2/tenant-packages — for the query request parameter page, default value 1.00 was removed
• GET /system/v2/tenants — for the query request parameter page, default value 1.00 was removed
• GET /system/v2/tenants/{id} — the dispatchable_locations/device_location_id response's property type changed from integer to string for status 200
• GET /system/v2/trunks — for the query request parameter page, default value 1.00 was removed

Low Severity

• POST /org/{tenant}/v2/extensions — the additional_configs → sip request property's maxLength was set to 4096
• POST /org/{tenant}/v2/extensions — removed the request property sms_number
• POST /org/{tenant}/v2/extensions — removed the optional property metadata/sms_number from the response with the 201 status
• POST /org/{tenant}/v2/extensions — removed the optional property sms_number from the response with the 201 status
• PATCH /org/{tenant}/v2/extensions/batch — the additional_configs → sip request property's maxLength was set to 4096
• PATCH /org/{tenant}/v2/extensions/batch — removed the request property sms_number
• POST /org/{tenant}/v2/extensions/batch — the additional_configs → sip request property's maxLength was set to 4096
• POST /org/{tenant}/v2/extensions/batch — removed the request property sms_number
• GET /org/{tenant}/v2/extensions/default — removed the optional property metadata/sms_number from the response with the 200 status
• GET /org/{tenant}/v2/extensions/default — removed the optional property sms_number from the response with the 200 status
• GET /org/{tenant}/v2/extensions/number/{number} — removed the optional property metadata/sms_number from the response with the 200 status
• GET /org/{tenant}/v2/extensions/number/{number} — removed the optional property sms_number from the response with the 200 status
• GET /org/{tenant}/v2/extensions/{id} — removed the optional property metadata/sms_number from the response with the 200 status
• GET /org/{tenant}/v2/extensions/{id} — removed the optional property sms_number from the response with the 200 status
• PATCH /org/{tenant}/v2/extensions/{id} — the additional_configs → sip request property's maxLength was set to 4096
• PATCH /org/{tenant}/v2/extensions/{id} — removed the request property sms_number
• PATCH /org/{tenant}/v2/extensions/{id} — removed the optional property metadata/sms_number from the response with the 200 status
• PATCH /org/{tenant}/v2/extensions/{id} — removed the optional property sms_number from the response with the 200 status
• PATCH /org/{tenant}/v2/extensions/{id}/enhanced-services/caller-id — default_trunk request property no longer includes TrunkCallerIDConf
• GET /system/v2/tenants — deleted the query request parameter limit
• GET /system/v2/tenants — deleted the query request parameter search
• GET /system/v2/tenants/{id} — removed the optional property administration/agi_port from the response with the 200 status
• GET /system/v2/tenants/{id} — removed the optional property administration/daemon_port from the response with the 200 status
• GET /system/v2/tenants/{id} — removed the optional property authentication/sso_enforced from the response with the 200 status
• GET /system/v2/tenants/{id} — removed the optional property auto_provisioning/tls_cert_validation from the response with the 200 status
• GET /system/v2/tenants/{id} — removed the optional property call_recording_transcription from the response with the 200 status
• GET /system/v2/tenants/{id} — removed the optional property text_to_speech from the response with the 200 status
• GET /system/v2/tenants/{id} — the features/dsm_enabled response property now accepts 3 new values: "", no, yes for the response status 200
• GET /system/v2/tenants/{id} — the features/ext_emergency_trunks response property now accepts 3 new values: "", no, yes for the response status 200
• GET /system/v2/tenants/{id} — the authentication/sso_token_expiry response property now accepts 3 new values: 1460.00, 2190.00, 730.00 for the response status 200
• GET /system/v2/tenants/{id} — the other/no_did_response response property now accepts 12 new values: 403.00, 404.00, 408.00, 410.00, 480.00, 484.00, 486.00, 488.00, 500.00, 501.00, 502.00, 503.00 for the response status 200
• GET /system/v2/trunks/{id} — for the path request parameter id, the min was set to 1.00
• GET /system/v2/trunks/{id} — removed the optional property additional from the response with the 200 status
• GET /system/v2/trunks/{id} — removed the optional property additional_headers from the response with the 200 status
• GET /system/v2/trunks/{id} — removed the optional property authentication from the response with the 200 status
• GET /system/v2/trunks/{id} — removed the optional property call_recording from the response with the 200 status
• GET /system/v2/trunks/{id} — removed the optional property caller_id from the response with the 200 status
• GET /system/v2/trunks/{id} — removed the optional property channels from the response with the 200 status
• GET /system/v2/trunks/{id} — removed the optional property codecs from the response with the 200 status
• GET /system/v2/trunks/{id} — removed the optional property country_id from the response with the 200 status
• GET /system/v2/trunks/{id} — removed the optional property dialed_num_minimum_length from the response with the 200 status
• GET /system/v2/trunks/{id} — removed the optional property dtmf_mode from the response with the 200 status
• GET /system/v2/trunks/{id} — removed the optional property e164_accepted from the response with the 200 status
• GET /system/v2/trunks/{id} — removed the optional property emergency_location_header from the response with the 200 status
• GET /system/v2/trunks/{id} — removed the optional property emergency_trunk from the response with the 200 status
• GET /system/v2/trunks/{id} — removed the optional property international_code from the response with the 200 status
• GET /system/v2/trunks/{id} — removed the optional property leave_national_code from the response with the 200 status
• GET /system/v2/trunks/{id} — removed the optional property local_area_code from the response with the 200 status
• GET /system/v2/trunks/{id} — removed the optional property national_code from the response with the 200 status
• GET /system/v2/trunks/{id} — removed the optional property network from the response with the 200 status
• GET /system/v2/trunks/{id} — removed the optional property no_did_sip_response from the response with the 200 status
• GET /system/v2/trunks/{id} — removed the optional property passthru_mode from the response with the 200 status
• GET /system/v2/trunks/{id} — removed the optional property send_history_info from the response with the 200 status
• GET /system/v2/trunks/{id} — removed the optional property status from the response with the 200 status
• GET /system/v2/trunks/{id} — removed the optional property trunk_prefix from the response with the 200 status
• GET /system/v2/trunks/{id} — removed the optional property trunk_prefix_emergency from the response with the 200 status
• GET /system/v2/trunks/{id} — removed the optional property trunk_test_number from the response with the 200 status
• GET /system/v2/trunks/{id} — removed the optional property user_language from the response with the 200 status
• GET /system/v2/trunks/{id} — removed the optional property user_type from the response with the 200 status

✨ New Endpoints​

• GET /org/{tenant_code}/v2/calls
• POST /org/{tenant_code}/v2/calls
• DELETE /org/{tenant_code}/v2/calls/{uid}
• GET /org/{tenant_code}/v2/calls/{uid}
• PUT /org/{tenant_code}/v2/calls/{uid}/recording
• POST /org/{tenant_code}/v2/calls/{uid}/transfer
• POST /org/{tenant}/v2/ai/post-call-transcription/transcription
• GET /org/{tenant}/v2/ai/post-call-transcription/transcription/{uniqueid}
• GET /org/{tenant}/v2/contacts/favorites
• POST /org/{tenant}/v2/contacts/favorites
• DELETE /org/{tenant}/v2/contacts/favorites/{id}
• GET /org/{tenant}/v2/dial-groups
• POST /org/{tenant}/v2/dial-groups
• DELETE /org/{tenant}/v2/dial-groups/{id}
• GET /org/{tenant}/v2/dial-groups/{id}
• PATCH /org/{tenant}/v2/dial-groups/{id}
• GET /org/{tenant}/v2/dial-groups/{id}/operation-times
• PUT /org/{tenant}/v2/dial-groups/{id}/operation-times
• GET /org/{tenant}/v2/dids/{id}/operation-times
• PUT /org/{tenant}/v2/dids/{id}/operation-times
• GET /org/{tenant}/v2/ergs/{id}/operation-times
• PUT /org/{tenant}/v2/ergs/{id}/operation-times
• GET /org/{tenant}/v2/extensions/{id}/balance
• POST /org/{tenant}/v2/extensions/{id}/balance/credit
• POST /org/{tenant}/v2/extensions/{id}/balance/debit
• GET /org/{tenant}/v2/extensions/{id}/balance/transactions
• GET /org/{tenant}/v2/extensions/{id}/enhanced-services/call-forwarding
• PATCH /org/{tenant}/v2/extensions/{id}/enhanced-services/call-forwarding
• GET /org/{tenant}/v2/extensions/{id}/operation-times
• PUT /org/{tenant}/v2/extensions/{id}/operation-times
• GET /org/{tenant}/v2/files/announcements
• GET /org/{tenant}/v2/files/greetings
• GET /org/{tenant}/v2/files/rg-announcements
• GET /org/{tenant}/v2/files/rg-late-announcements
• GET /org/{tenant}/v2/ivrs/{id}/operation-times
• PUT /org/{tenant}/v2/ivrs/{id}/operation-times
• GET /org/{tenant}/v2/queues/{id}/operation-times
• PUT /org/{tenant}/v2/queues/{id}/operation-times
• GET /org/{tenant}/v2/reports/operation-times
• GET /org/{tenant}/v2/sms/numbers
• POST /org/{tenant}/v2/sms/numbers
• DELETE /org/{tenant}/v2/sms/numbers/{id}
• GET /org/{tenant}/v2/sms/numbers/{id}
• PUT /org/{tenant}/v2/sms/numbers/{id}
• DELETE /org/{tenant}/v2/sms/numbers/batch
• POST /org/{tenant}/v2/sms/numbers/batch
• PUT /org/{tenant}/v2/sms/numbers/batch
• GET /system/v2/ai/voice-agents/session/{unique_id}
• GET /system/v2/calls
• GET /system/v2/countries
• GET /system/v2/files/greetings
• GET /system/v2/providers
• GET /system/v2/providers/{id}
• GET /system/v2/routes/{id}/operation-times
• PUT /system/v2/routes/{id}/operation-times
• GET /system/v2/secret/{username}
• GET /system/v2/server-settings
• PATCH /system/v2/server-settings
• POST /system/v2/tenants
• DELETE /system/v2/tenants/{id}
• PATCH /system/v2/tenants/{id}
• GET /system/v2/tenants/{id}/operation-times
• PUT /system/v2/tenants/{id}/operation-times
• POST /system/v2/tenants/{id}/stir-shaken/certificates
• POST /system/v2/trunks
• DELETE /system/v2/trunks/{id}
• PATCH /system/v2/trunks/{id}

Other Changes​

• webhook summaryCompleted added
• webhook summaryFailed added
• webhook transcriptionCompleted added
• webhook transcriptionFailed added
• GET /org/{tenant_code}/v2/ai/voice-agents — added the optional property items/tools to the response with the 200 status
• POST /org/{tenant_code}/v2/ai/voice-agents — added the new optional request property tools
• POST /org/{tenant_code}/v2/ai/voice-agents — added the optional property tools to the response with the 201 status
• GET /org/{tenant_code}/v2/ai/voice-agents/{id} — added the optional property tools to the response with the 200 status
• PUT /org/{tenant_code}/v2/ai/voice-agents/{id} — added the new optional request property tools
• PUT /org/{tenant_code}/v2/ai/voice-agents/{id} — added the optional property tools to the response with the 200 status
• POST /org/{tenant}/v2/contacts — added the non-success response with the status 403
• POST /org/{tenant}/v2/contacts — added the non-success response with the status 404
• GET /org/{tenant}/v2/contacts/config — added the non-success response with the status 400
• GET /org/{tenant}/v2/contacts/csv/download — added the non-success response with the status 401
• GET /org/{tenant}/v2/contacts/csv/download — added the non-success response with the status 403
• GET /org/{tenant}/v2/contacts/csv/jobs — added the non-success response with the status 403
• DELETE /org/{tenant}/v2/contacts/csv/jobs/{job_id} — added the non-success response with the status 403
• DELETE /org/{tenant}/v2/contacts/csv/jobs/{job_id} — added the non-success response with the status 404
• GET /org/{tenant}/v2/contacts/csv/jobs/{job_id}/info — added the media type application/json for the response with the status 400
• GET /org/{tenant}/v2/contacts/csv/jobs/{job_id}/info — added the media type application/json for the response with the status 404
• GET /org/{tenant}/v2/contacts/csv/jobs/{job_id}/info — added the media type application/json for the response with the status 500
• GET /org/{tenant}/v2/contacts/csv/jobs/{job_id}/info — added the non-success response with the status 401
• GET /org/{tenant}/v2/contacts/csv/jobs/{job_id}/info — added the non-success response with the status 403
• GET /org/{tenant}/v2/contacts/csv/status — added the non-success response with the status 403
• GET /org/{tenant}/v2/contacts/csv/template — added the non-success response with the status 400
• GET /org/{tenant}/v2/contacts/csv/template — added the non-success response with the status 403
• POST /org/{tenant}/v2/contacts/csv/upload — added the non-success response with the status 401
• POST /org/{tenant}/v2/contacts/csv/upload — added the non-success response with the status 403
• POST /org/{tenant}/v2/contacts/merge/{id} — added the non-success response with the status 403
• GET /org/{tenant}/v2/contacts/{contact_id}/activities — added the non-success response with the status 400
• GET /org/{tenant}/v2/contacts/{contact_id}/activities — added the non-success response with the status 401
• GET /org/{tenant}/v2/contacts/{contact_id}/activities — added the non-success response with the status 404
• GET /org/{tenant}/v2/contacts/{contact_id}/activities — added the non-success response with the status 500
• DELETE /org/{tenant}/v2/contacts/{id} — added the non-success response with the status 403
• GET /org/{tenant}/v2/contacts/{id} — added the non-success response with the status 403
• PUT /org/{tenant}/v2/contacts/{id} — added the non-success response with the status 403
• PUT /org/{tenant}/v2/contacts/{id} — added the non-success response with the status 404
• POST /org/{tenant}/v2/extensions — added the new optional request property sms
• POST /org/{tenant}/v2/extensions — added the optional property sms to the response with the 201 status
• PATCH /org/{tenant}/v2/extensions/batch — added the new optional request property sms
• POST /org/{tenant}/v2/extensions/batch — added the new optional request property sms
• GET /org/{tenant}/v2/extensions/default — added the optional property sms to the response with the 200 status
• GET /org/{tenant}/v2/extensions/number/{number} — added the optional property sms to the response with the 200 status
• GET /org/{tenant}/v2/extensions/{id} — added the optional property sms to the response with the 200 status
• PATCH /org/{tenant}/v2/extensions/{id} — added the new optional request property sms
• PATCH /org/{tenant}/v2/extensions/{id} — added the optional property sms to the response with the 200 status
• GET /org/{tenant}/v2/extensions/{id}/enhanced-services — api tag enhanced-services added
• GET /org/{tenant}/v2/extensions/{id}/enhanced-services — api tag extensions removed
• PUT /org/{tenant}/v2/extensions/{id}/enhanced-services — api tag enhanced-services added
• PUT /org/{tenant}/v2/extensions/{id}/enhanced-services — api tag extensions removed
• GET /org/{tenant}/v2/extensions/{id}/enhanced-services/caller-id — api tag enhanced-services added
• GET /org/{tenant}/v2/extensions/{id}/enhanced-services/caller-id — api tag extensions removed
• GET /org/{tenant}/v2/extensions/{id}/enhanced-services/caller-id — added the non-success response with the status 400
• GET /org/{tenant}/v2/extensions/{id}/enhanced-services/caller-id — added the non-success response with the status 403
• GET /org/{tenant}/v2/extensions/{id}/enhanced-services/caller-id — added the non-success response with the status 500
• GET /org/{tenant}/v2/extensions/{id}/enhanced-services/caller-id — added the optional property default_trunk/caller_id to the response with the 200 status
• GET /org/{tenant}/v2/extensions/{id}/enhanced-services/caller-id — added the optional property default_trunk/privacy to the response with the 200 status
• GET /org/{tenant}/v2/extensions/{id}/enhanced-services/caller-id — default_trunk response property no longer includes TrunkCallerIDConf for the response status 200
• GET /org/{tenant}/v2/extensions/{id}/enhanced-services/caller-id — the default_trunk response's property type was narrowed from any to object for status 200
• PATCH /org/{tenant}/v2/extensions/{id}/enhanced-services/caller-id — api tag enhanced-services added
• PATCH /org/{tenant}/v2/extensions/{id}/enhanced-services/caller-id — api tag extensions removed
• PATCH /org/{tenant}/v2/extensions/{id}/enhanced-services/caller-id — added the new optional request property default_trunk/caller_id
• PATCH /org/{tenant}/v2/extensions/{id}/enhanced-services/caller-id — added the new optional request property default_trunk/privacy
• PATCH /org/{tenant}/v2/extensions/{id}/enhanced-services/caller-id — added the non-success response with the status 403
• PATCH /org/{tenant}/v2/extensions/{id}/enhanced-services/caller-id — added the non-success response with the status 500
• PATCH /org/{tenant}/v2/extensions/{id}/enhanced-services/caller-id — added the optional property default_trunk/caller_id to the response with the 200 status
• PATCH /org/{tenant}/v2/extensions/{id}/enhanced-services/caller-id — added the optional property default_trunk/privacy to the response with the 200 status
• PATCH /org/{tenant}/v2/extensions/{id}/enhanced-services/caller-id — default_trunk response property no longer includes TrunkCallerIDConf for the response status 200
• PATCH /org/{tenant}/v2/extensions/{id}/enhanced-services/caller-id — the default_trunk response's property type was narrowed from any to object for status 200
• POST /system/v2/tenant-packages — the request property call_monitoring became optional
• POST /system/v2/tenant-packages — the request property call_recordings became optional
• POST /system/v2/tenant-packages — the request property call_screening became optional
• POST /system/v2/tenant-packages — the request property restrict_service_plans became optional
• PUT /system/v2/tenant-packages/{id} — the request property call_monitoring became optional
• PUT /system/v2/tenant-packages/{id} — the request property call_recordings became optional
• PUT /system/v2/tenant-packages/{id} — the request property call_screening became optional
• PUT /system/v2/tenant-packages/{id} — the request property restrict_service_plans became optional
• GET /system/v2/tenants — added the new optional query request parameter order_by
• GET /system/v2/tenants — added the new optional query request parameter query
• GET /system/v2/tenants — added the new optional query request parameter size
• GET /system/v2/tenants — response body no longer includes Pagination, subschema #2 for the response status 200
• GET /system/v2/tenants — added the non-success response with the status 401
• GET /system/v2/tenants — added the non-success response with the status 403
• GET /system/v2/tenants — added the optional property data to the response with the 200 status
• GET /system/v2/tenants — added the optional property pagination to the response with the 200 status
• GET /system/v2/tenants/{id} — added the non-success response with the status 401
• GET /system/v2/tenants/{id} — added the non-success response with the status 403
• GET /system/v2/tenants/{id} — added the optional property administration/daemon_password to the response with the 200 status
• GET /system/v2/tenants/{id} — added the optional property administration/daemon_username to the response with the 200 status
• GET /system/v2/tenants/{id} — added the optional property authentication/enforce_sso_auth to the response with the 200 status
• GET /system/v2/tenants/{id} — added the optional property auto_provisioning/send_auto_provisioning_url to the response with the 200 status
• GET /system/v2/tenants/{id} — added the optional property auto_provisioning/tls_client_cert_validation to the response with the 200 status
• GET /system/v2/tenants/{id} — added the optional property call_recordings/ram_disk_size to the response with the 200 status
• GET /system/v2/tenants/{id} — added the optional property call_recordings/stereo_recording_enabled to the response with the 200 status
• GET /system/v2/tenants/{id} — added the optional property call_recordings/stereo_recording_format to the response with the 200 status
• GET /system/v2/tenants/{id} — added the optional property call_recordings/use_ram_disk to the response with the 200 status
• GET /system/v2/tenants/{id} — added the optional property dispatchable_locations/address_validation_method to the response with the 200 status
• GET /system/v2/tenants/{id} — added the optional property dispatchable_locations/custom_validation_api_key to the response with the 200 status
• GET /system/v2/tenants/{id} — added the optional property dispatchable_locations/custom_validation_url to the response with the 200 status
• GET /system/v2/tenants/{id} — added the optional property dispatchable_locations/delivery_format to the response with the 200 status
• GET /system/v2/tenants/{id} — added the optional property dispatchable_locations/emerg_pai_header to the response with the 200 status
• GET /system/v2/tenants/{id} — added the optional property dispatchable_locations/usps_oauth_credential_id to the response with the 200 status
• GET /system/v2/tenants/{id} — added the optional property other/channelbridge_address to the response with the 200 status
• GET /system/v2/tenants/{id} — added the optional property other/channelbridge_config to the response with the 200 status
• GET /system/v2/tenants/{id} — added the optional property other/channelbridge_enabled to the response with the 200 status
• GET /system/v2/tenants/{id} — added the optional property other/channelbridge_fssaddr to the response with the 200 status
• GET /system/v2/tenants/{id} — added the optional property other/ecbn_enable to the response with the 200 status
• GET /system/v2/tenants/{id} — added the optional property other/max_chan_exceeded_response to the response with the 200 status
• GET /system/v2/tenants/{id} — added the optional property other/terminate_on_sip_603 to the response with the 200 status
• GET /system/v2/tenants/{id} — added the optional property proxy_config to the response with the 200 status
• GET /system/v2/tenants/{id} — added the optional property sugar_crm to the response with the 200 status
• GET /system/v2/tenants/{id} — the dsm_enabled response's property default value `` was added for the status 200
• GET /system/v2/tenants/{id} — the ext_emergency_trunks response's property default value `` was added for the status 200
• GET /system/v2/tenants/{id} — the sso_token_expiry response's property default value changed from 1.00 to 730.00 for the status 200
• GET /system/v2/tenants/{id} — the other/no_did_response response property no longer accepts 12 values: 17.00, 18.00, 20.00, 21.00, 22.00, 27.00, 28.00, 29.00, 3.00, 38.00, 58.00, 66.00 for the response status 200
• GET /system/v2/tenants/{id} — the features/dsm_enabled response's property type was narrowed from any to string for status 200
• GET /system/v2/tenants/{id} — the features/ext_emergency_trunks response's property type was narrowed from any to string for status 200
• GET /system/v2/trunks — response body no longer includes Pagination, subschema #2 for the response status 200
• GET /system/v2/trunks — added the optional property data to the response with the 200 status
• GET /system/v2/trunks — added the optional property pagination to the response with the 200 status
• GET /system/v2/trunks/{id} — response body now includes TrunkBase for the response status 200
• GET /system/v2/trunks/{id} — added the optional property priority to the response with the 200 status
• GET /system/v2/trunks/{id} — the name response's property pattern ^[a-zA-Z0-9\-_.]+$ was added for the status 200