Build - the name of the maintenance release build the change was introduced in.

Service - the name of the service/services which is/are affected.

Method - the name of the method/methods which is/are affected.

Message - the message that explains what was changed.

Schema changed - shows whether it is required to rebuild WSDL/XSD-generated stubs for .net, Java and other static typing languages.

TT - a link to a ticket related to the change.

Build

Service

Method

Message

Schema changed

Backward compatible

TT

Resolution for system update

MR122-0UA

get_options_template_list

The method has been extended with the "model" field, where the device name will be returned (composed of: manufacturer + product + version).

YesYesYT:BA-43419
MR122-0

Customer

CustomerClass

get_taxation_info

update_taxation

The field 'options_billsoft' has been removed.

YesNoYT:BA-37429The Billsoft/EzTax taxation plugin has been completely removed from the system; alternative taxation plugins should be used instead.
MR122-0

UA

add_options_template
update_options_template

It is now forbidden to assign empty directories to UA configs.

NoNoYT:BA-43109Having an empty directory in config files makes no sense and may lead to errors (or unexpected and difficult-to-trace behavior). The directories should be populated with some contacts before they are assigned to the config file.
MR122-0

Tariff

schedule_tariff_cloning

Can be called for the grouped tariffs too.

NoYesYT:BA-42645 
MR122-0

Tariff

add_tariff

i_dest_group_set is mandatory for grouped tariff

NoYesYT:BA-43497There was an error without i_dest_group_set, so this change doesn't broke compatibility.
MR122-0

Vendor

get_xdr_list

The 'i_vendor' field is not mandatory in the request, even in the absence of the 'h323_conf_id' field.

NoYesYT:BA-43584 
MR122-0

Account

get_account_list

The 'dual_version_system' field is omitted in the retail, account, and reseller realms (for Dual Version systems only).

NoYesYT:BA-43751 
MR122-0

Customer

get_customer_list

The 'dual_version_system' field is omitted in the retail, account, and reseller realms (for Dual Version systems only).

NoYesYT:BA-43751 
MR122-0

GroupRate

add_price_selection

i_op1_period, i_op2_period are mandatory depending on the used i_price_selection_type

NoNoYT:BA-43612Having a price selection rule of the 'Off-Peak' type is useless without off-peak periods assigned.
MR122-0

GroupRate

add_rate

op1_*, op2_*  are mandatory depending on the type of the used price selection

NoNoYT:BA-43612The group rate with a price selection of the 'Off-Peak' type must include off-peak information. This was done on UI, but was missing on API level.
MR122-0

Vendor

get_xdr_list

Add the 'beneficiary_account_id', 'beneficiary_billing_model', and 'customer_name' fields to the VendorXDRInfo structure.

The 'beneficiary_account_id' and 'beneficiary_billing_model' fields specify the ID (PIN) and the type of the beneficiary account if the service was consumed by a beneficiary. The 'customer_name' field specifies the name of the customer associated with the xDR.

YesYesYT:BA-43671 
MR122-0

TraceSession

get_trace_session_list

Add the 'billing_model' field to the TraceSessionInfo structure.

The 'billing_model' field specifies the type of the account related to the session.

YesYesYT:BA-43671 
MR122-0

UA

add_phone_directory
update_phone_directory
delete_phone_directory

The methods will now produce different faultcodes for some errors, instead of the "internal_error":

"Server.UA.auto_sync_dir_exists" - customer already has an auto_sync
"Server.UA.phone_directory_name_already_in_use" - name in use
"Server.UA.phone_directory_in_use" - cannot delete dir in use

and for the general issues:
"Server.UA.phone_directory_not_created"
"Server.UA.phone_directory_not_updated"
"Server.UA.phone_directory_not_deleted"

NoYesYT:BA-43817
MR122-0

GroupRate

get_price_selection_info

The response no longer returns raw attributes directly. Instead, attributes are now wrapped in a 'price_selection_info' object, which should be used to retrieve their values.

YesNoYT:BA-43407Response attribute values should now be accessed through the new wrapper object.
MR122-0

GroupRate

get_rate_info

The response no longer returns raw attributes directly. Instead, attributes are now wrapped in a 'rate_info' object, which should be used to retrieve their values.

YesNoYT:BA-43407Response attribute values should now be accessed through the new wrapper object.
MR122-0

Vendor

get_vendor_list
get_connection_list

The "get_total" field is now correctly marked as an integer (previously - string).

YesNo (for SOAP/XML)YT:BA-34822The users should now provide the correct data type in the request.
MR122-0

Node

get_node_list

The "get_total" field is now correctly marked as an integer (previously - string).

YesNo (for SOAP/XML)YT:BA-34822The users should now provide the correct data type in the request.
MR122-0

GroupRate

get_rate_list

The "reverse_rating" field is now correctly marked as an string  (previously - integer).

YesNo (for SOAP/XML)YT:BA-34822The users should now provide the correct data type in the request.
MR122-0

DiscountPlan

get_discount_plan_list

The "offset" field is now correctly marked as an integer (previously - string).

YesNo (for SOAP/XML)YT:BA-34822The users should now provide the correct data type in the request.
MR122-0

DID

release_number

The "timestamp" field is now correctly marked as an integer (previously - string).

YesNo (for SOAP/XML)YT:BA-34822The users should now provide the correct data type in the request.
MR122-0

Account

set_mailbox_messages_flag

The 'action' API input field type has been changed from int to string, as the previous type definition was incorrect.

YesNo (for SOAP/XML)YT:BA-43407

The string data type must now be used in the request for the 'action' API field.

MR122-0

Customer

get_call_activity_metrics

New method to get call activity metrics is available for Customer realm

YesYesYT:BA-42971


MR122-0

Vendor

get_xdr_list

Add the 'connection_name' field to the VendorXDRInfo structure.

YesYesYT:BA-43838


MR122-0

GroupRate

get_price_selection_type_list

The 'price_levels' field has been added to price selection type info.

YesYesYT:BA-43734


MR122-0

Customer

add_callqueue

update_callqueue

add_customer_huntgroup

update_customer_huntgroup

Added a new field 'announce_position' to the API input.

Marked 'announce_number_of_callers' as deprecated.

YesYesYT:BA-43861

The 'announce_position' field should now be used in place of the deprecated 'announce_number_of_callers' when working with call queues.

MR122-0

Customer

get_callqueue_info

get_callqueue_list

get_huntgroup_info

get_huntgroup_list

Added a new field 'announce_position' to the API output.

Marked 'announce_number_of_callers' as deprecated.

YesYesYT:BA-43861

The 'announce_position' field should now be used in place of the deprecated 'announce_number_of_callers' when working with call queues.

MR122-0

Account

get_account_info
get_account_list

Added new possible value "S" for AccountInfo.bill_status field

Added new possible value "suspended" for AccountInfo.status field

YesYesYT:BA-42352


MR122-0

CustomerClass

add_customer_class
update_customer_class
get_customer_class_info
get_customer_class_list

Added new field "suspend_debit_on_insuff_funds" to the CustomerClassInfo structure

YesYesYT:BA-42352


MR122-0

Account

get_account_list

The 'skip_exported' field has been added to the GetAccountListRequest structure.

This field indicates whether to exclude accounts of exported customers from the response.

YesYesYT:BA-43918


MR122-0

Account

get_assigned_commitment_terms

The response structure was extended with a new field for an item in sale_discount_list - discount_priority.

YesYesYT:BA-43522


mr122-1

UA

get_options_template_info

Now we will return the model name in the get_options_template_info as the "model" field.

YesYesYT:BA-44140


MR122-1

UA

get_ua_type_list

Extend request input with "only_portable" and "with_configurable_keys" that allows user to get type list that support keys configuration via options templates.

Extend response of the method with "configurable_keys_supported"
flag that shows whether it is possible to set up keys configuration via options template for a type.

Extend logic of "directory_supported" response flag. It shows possibility of directory generation for a type.

YesYesYT:BA-43853


MR122-1

UA

get_ua_type_info

Add new method to get info of a single UA type.

YesYesYT:BA-43853


MR122-1

UA

get_phone_directory_list

Method is allowed for the account realm.

YesYesYT:BA-44007


MR122-1

UA

get_phone_directory_info

Method is allowed for the account realm.

YesYesYT:BA-44007


MR122-1

User

get_user_info

The response structure was extended with new fields for an user: "refunded" - total amount of refunded funds by the user. "refunded_today" - date and time of the first refund during this day.

YesYesYT:BA-33051


MR122-1
TimePeriod
get_time_period_list

Add field "with_shared" for Reseller to include time periods managed by admin

YesYesYT:BA-43508


MR122-1
GroupRate
add_price_selection

The field 'i_dest_group_set' is mandatory depending on the price selection type (with_reference=Y)

NoNoYT:BA-43874

UI already has this field mandatory

MR122-1

Vendor

Account

get_xdr_list

Added a new flag - with_cleanup_xdrs (false by default). 

YesNoYT:BA-43946


MR122-1

Customer

get_customer_xdrs

Added a new flag - with_cleanup_xdrs (false by default). 

YesNoYT:BA-43946


MR122-1

Rate

get_rate_match_mode_info

get_rate_match_mode_list

Added "is_used" flag to the RateMatchModeInfo. Flag indicates whether rate match mode is used or not. It is possible to update only "name" and "description" of the used rate match mode. Other fields cannot be updated for used rate match modes (i_service_type, pattern_keys).

YesYesYT:BA-43018


MR122-1

TrafficProfile

update_traffic_profile

Can assign i_dest_group_set for the used profile without code group set.

NoYesYT:BA-42519

Previously the error was returned

MR122-1

Customer

get_custom_fields_values
update_custom_fields_values

API methods are now allowed for distributor realm.

YesYesYT:BA-43984


MR122-1

DiscountPlan

get_discount_plan_info

The API method is now allowed for the Distributor realm.

YesYesYT:BA-44507


MR122-1

Template

add_tariff_download_template

get_template_list

Methods are allowed for the reseller realm

YesYesYT:BA-41013


MR122-1

UA

get_ua_profile_metainfo

get_ua_type_list

Add "no_cache" flag to the requests of the methods that allows to update local devices/profiles cache on demand. Default cache TTL is 7 days.

YesYesYT:BA-43069



  • No labels