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

MR119-0Customer

get_abbreviated_dialing_number_list
get_vd_notification_list

validate_customer_info
get_customer_info
get_customer_list
get_my_info

The "description" field will now be returned as an empty string (instead of "null") for both Oracle and MySQL.

The "baddr1", "address_line_2", "city", "companyname", "cont1", "cont2", "country", "daily_allowance", "description", "faxnum", "firstname", "lastname", "midinit", "phone1", "phone2", "salutation", "state" fields will now be returned as an empty string (instead of "null") for both Oracle and MySQL.

YesNoYT:BA-36046An empty string should be expected for specified fields when they are empty (stored as None in the db).
MR119-0IVRApplicationget_access_number_info
get_access_number_list

The "description" field will now be returned as an empty string (instead of "null") for both Oracle and MySQL.

YesNoYT:BA-36046An empty string should be expected for specified fields when they are empty (stored as None in the db).
MR119-0AccessPolicyget_access_policy_info
get_access_policy_list

The "description" field will now be returned as an empty string (instead of "null") for both Oracle and MySQL.

YesNoYT:BA-36046An empty string should be expected for specified fields when they are empty (stored as None in the db).
MR119-0AccessRoleget_access_role_info
get_access_role_list

The "description" field will now be returned as an empty string (instead of "null") for both Oracle and MySQL.

YesNoYT:BA-36046An empty string should be expected for specified fields when they are empty (stored as None in the db).
MR119-0Account

get_assigned_commitment_terms
get_assigned_commitment_record_info
get_assigned_commitment_record_list
get_vd_notification_list


get_simple_account_info

The "description" field will now be returned as an empty string (instead of "null") for both Oracle and MySQL.


The "baddr1", "address_line_2", "city", "companyname", "cont1", "cont2", "country", "daily_allowance", "description", "faxnum", "firstname", "lastname", "midinit", "phone1", "phone2", "salutation", "state" fields will now be returned as an empty string (instead of "null") for both Oracle and MySQL.

YesNoYT:BA-36046An empty string should be expected for specified fields when they are empty (stored as None in the db).
MR119-0CCStaffget_cc_staff_info
get_cc_staff_list

The "baddr1", "address_line_2", "city", "companyname", "cont1", "cont2", "country", "daily_allowance", "description", "faxnum", "firstname", "lastname", "midinit", "phone1", "phone2", "salutation", "state" fields will now be returned as an empty string (instead of "null") for both Oracle and MySQL.

YesNoYT:BA-36046An empty string should be expected for specified fields when they are empty (stored as None in the db).
MR119-0MeasuredServicesget_metric_charge_methods_list

The "description" field will now be returned as an empty string (instead of "null") for both Oracle and MySQL.

YesNoYT:BA-36046An empty string should be expected for specified fields when they are empty (stored as None in the db).
MR119-0Commitmentget_commitment_info
get_commitment_list

The "description" field will now be returned as an empty string (instead of "null") for both Oracle and MySQL.

YesNoYT:BA-36046An empty string should be expected for specified fields when they are empty (stored as None in the db).
MR119-0CustomerClassget_customer_class_info
get_customer_class_list
get_notification_list
get_notification_category_list

The "description" field will now be returned as an empty string (instead of "null") for both Oracle and MySQL.

YesNoYT:BA-36046An empty string should be expected for specified fields when they are empty (stored as None in the db).
MR119-0DIDget_customer_numbers
get_number_info
get_did_group_list
get_owner_batch_info
get_owner_batch_list
get_vendor_batch_info
get_vendor_batch_list

The "description" field will now be returned as an empty string (instead of "null") for both Oracle and MySQL.

YesNoYT:BA-36046An empty string should be expected for specified fields when they are empty (stored as None in the db).
MR119-0BillingSessionget_active_sessions_list
get_active_calls_list

The "baddr1", "address_line_2", "city", "companyname", "cont1", "cont2", "country", "daily_allowance", "description", "faxnum", "firstname", "lastname", "midinit", "phone1", "phone2", "salutation", "state" fields will now be returned as an empty string (instead of "null") for both Oracle and MySQL.

YesNoYT:BA-36046An empty string should be expected for specified fields when they are empty (stored as None in the db).
MR119-0Destinationmatch_destination_groups
get_dest_group_info
get_dest_group_list
get_dest_group_set_list

The "description" field will now be returned as an empty string (instead of "null") for both Oracle and MySQL.

YesNoYT:BA-36046An empty string should be expected for specified fields when they are empty (stored as None in the db).
MR119-0Vendorget_connection_destination_group_list

The "description" field will now be returned as an empty string (instead of "null") for both Oracle and MySQL.

YesNoYT:BA-36046An empty string should be expected for specified fields when they are empty (stored as None in the db).
MR119-0DialingRuleget_dialing_rule_info
get_dialing_rule_list

The "description" field will now be returned as an empty string (instead of "null") for both Oracle and MySQL.

YesNoYT:BA-36046An empty string should be expected for specified fields when they are empty (stored as None in the db).
MR119-0DiscountPlanget_discount_plan_info
get_discount_plan_list

The "description" field will now be returned as an empty string (instead of "null") for both Oracle and MySQL.

YesNoYT:BA-36046An empty string should be expected for specified fields when they are empty (stored as None in the db).
MR119-0Envget_env_info
get_env_list

The "baddr1", "address_line_2", "city", "companyname", "cont1", "cont2", "country", "daily_allowance", "description", "faxnum", "firstname", "lastname", "midinit", "phone1", "phone2", "salutation", "state" fields will now be returned as an empty string (instead of "null") for both Oracle and MySQL.

YesNoYT:BA-36046An empty string should be expected for specified fields when they are empty (stored as None in the db).
MR119-0ContentBasedCharginhget_marketing_group_info
get_marketing_group_list
get_rating_group_list
get_rating_group_info

The "description" field will now be returned as an empty string (instead of "null") for both Oracle and MySQL.

YesNoYT:BA-36046An empty string should be expected for specified fields when they are empty (stored as None in the db).
MR119-0User

get_notification_list
get_notification_category_list

get_user_list
get_user_info

The "description" field will now be returned as an empty string (instead of "null") for both Oracle and MySQL.

YesNoYT:BA-36046An empty string should be expected for specified fields when they are empty (stored as None in the db).
MR119-0Productget_product_info
get_product_info_detailed
get_product_list_detailed
get_product_list
get_product_discount_plan_list
get_subscriptions
get_subscription_info

The "description", "end_user_description", "end_user_name", "info_url", "realm" fields will now be returned as an empty string (instead of "null") for both Oracle and MySQL.

YesNoYT:BA-36046An empty string should be expected for specified fields when they are empty (stored as None in the db).
MR119-0Rateget_rate_list
get_rate_info

The "description" field will now be returned as an empty string (instead of "null") for both Oracle and MySQL.

YesNoYT:BA-36046An empty string should be expected for specified fields when they are empty (stored as None in the db).
MR119-0RoutingPlanget_rp_category_list

The "description" field will now be returned as an empty string (instead of "null") for both Oracle and MySQL.

YesNoYT:BA-36046An empty string should be expected for specified fields when they are empty (stored as None in the db).
MR119-0RouteCategoriesget_route_category_info
get_route_category_list

The "description" field will now be returned as an empty string (instead of "null") for both Oracle and MySQL.

YesNoYT:BA-36046An empty string should be expected for specified fields when they are empty (stored as None in the db).
MR119-0ServicePolicyget_service_policy_list
get_service_policy_info
get_attribute_list

The "description" field will now be returned as an empty string (instead of "null") for both Oracle and MySQL.

YesNoYT:BA-36046An empty string should be expected for specified fields when they are empty (stored as None in the db).
MR119-0SIMCardget_card_info
get_card_list

The "description" field will now be returned as an empty string (instead of "null") for both Oracle and MySQL.

YesNoYT:BA-36046An empty string should be expected for specified fields when they are empty (stored as None in the db).
MR119-0Subscriptionget_subscription_list
get_subscription_info

The "description" field will now be returned as an empty string (instead of "null") for both Oracle and MySQL.

YesNoYT:BA-36046An empty string should be expected for specified fields when they are empty (stored as None in the db).
MR119-0UAget_ua_list
get_ua_info
get_ua_profile_list
get_ua_type_list
get_ua_profile_info
get_ua_profile_metainfo

The "description" field will now be returned as an empty string (instead of "null") for both Oracle and MySQL.

YesNoYT:BA-36046An empty string should be expected for specified fields when they are empty (stored as None in the db).
MR119-0TaxationPluginget_tax_transaction_code_list
get_tax_transaction_code_info

The "description" field will now be returned as an empty string (instead of "null") for both Oracle and MySQL.

YesNoYT:BA-36046An empty string should be expected for specified fields when they are empty (stored as None in the db).
MR119-0

Generic

get_extended_data_list

The "i_role" field has been added to the response.

YesYesYT:BA-41810
MR119-0

Account

add_phonebook_record

update_phonebook_record

The unlock_time  field cannot be provided or set through these requests.

YesNoYT:BA-41685
MR119-0

TraceSession

get_trace_session_list

The "cld_unmasked" and "cli_unmasked" fields have been added to the TraceSessionInfo structure.
These fields will contain the original values of the "cld" and "cli" fields, respectively, when masking is enabled. Specifically, "cld_unmasked" reflects the original value when CLD masking is enabled in the Configurator (section "CLDMasking", option "Enable"), and "cli_unmasked" reflects the original value when the caller has requested privacy ("Hide CLI" feature enabled).

 YesYesYT:BA-41916
MR119-0

BillingSession

get_active_sessions_list

The "i_master_account" and "master_account_id" fields have been added to the ActiveSessionInfo structure.
These fields will contain the main account's information for alias-initiated sessions and the sponsor account's information for beneficiary sessions.

YesYesYT:BA-37278
MR119-0

TraceSession

get_trace_session_list

The "i_master_account" and "master_account_id" fields have been added to the TraceSessionInfo structure.
These fields will contain the main account's information for alias-initiated sessions and the sponsor account's information for beneficiary sessions.

YesYesYT:BA-37278
MR119-0

GroupRate

get_price_selection_info
get_price_selection_list

Add "is_used" field to the response.

YesYesYT:BA-42359
MR119-0

Customer

get_my_info

get_customer_info

Deprecate the has_custom_fields  field starting from MR115-3

YesNoYT:BA-42198

Previously, this field showed whether the parent entity (administrator or reseller) managed any custom fields that could be applied to the customer.

It is now necessary to explicitly check for the presence of custom fields in the parent entity using the /CustomFields/get_custom_field_list API method.

MR119-0

Account

get_account_info

Deprecate the has_custom_fields  field starting from MR115-3

YesNoYT:BA-42198

Previously, this field showed whether the parent entity (administrator or reseller) managed any custom fields that could be applied to the account.

It is now necessary to explicitly check for the presence of custom fields in the parent entity using the /CustomFields/get_custom_field_list API method.

MR119-0

Rate

add_rate_match_mode

update_rate_match_mode

delete_rate_match_mode

Add new API methods.

YesYesYT:BA-42334


MR119-0

Destination

upload

The 'number_format' API field now includes a new 'auto_detect' value, which is set as the default.

YesNoYT:BA-20816

Previously, if the number_format field in the API wasn’t explicitly set, it defaulted to E.164. Now, the number format is automatically detected by default.

MR119-0

Rate

get_rate_match_mode_info

get_rate_match_mode_list

Make API methods public

YesYesYT:BA-42285


MR119-0

CallControl

get_sip_calls_list

In the response the following fields have been marked as mandatory:

'call', 'state', 'type', 'caller', 'callee', 'tracking_id', 'update_time'.

YesYes YT:BA-42189


MR119-0

CallControl

originate_advanced_call

The 'caller_id' API field in the request has been marked as mandatory.

YesNoYT:BA-42189


MR119-0

CallControl

join_on_spot_conference

The 'call' API field has been removed from the response.

YesNoYT:BA-42189


MR119-0

CallControl

get_on_spot_conference_list

The 'name' and 'owner_id' fields are now marked as non-mandatory in the request.

The 'conference_list' field is marked as mandatory in the response.

YesYesYT:BA-42189


MR119-0

CallControl

get_on_spot_conference_participant_list

The 'participant_list' is marked as mandatory in the response.

API fields 'lang' and 'max_participants' are removed from the response.

YesNoYT:BA-42189


MR119-0

CallControl

update_on_spot_conference_participant

The 'participant_id' field is now marked as mandatory in the request.

The following fields have been removed from the request:

  • caller_id
  • max_participants
  • moderator
  • wait_for_moderator
  • quiet_mode
  • lang
  • announced_conference_name_url
  • join_time
  • leave_time
  • play_announce
YesNoYT:BA-42189

The removed fields have not been used previously, so there is no need to make any changes.

MR119-0

CallControl

delete_on_spot_conference_participant

The 'participant_id' field is now marked as mandatory in the request.

The following fields have been removed from the request:

  • caller_id
  • max_participants
  • moderator
  • wait_for_moderator
  • quiet_mode
  • lang
  • announced_conference_name_url
  • join_time
  • leave_time
  • mute
  • coach
  • hold
  • music_on_hold_url
YesNoYT:BA-42189

The removed fields have not been used previously, so there is no need to make any changes.

MR119-0

GroupRate

get_price_selection_type_list

get_price_selection_list

get_price_selection_info

add_price_selection

update_price_selection

delete_price_selection

get_rate_list

get_rate_info

delete_rate

add_rate

update_rate

Make methods public

NoYesYT:BA-42335

 

MR119-0

Account

schedule_commitment_record_replacement

The API field i_addon_product has been made non-mandatory.

NoYesYT:BA-42197

 

MR119-0

Account

get_account_followme

update_account_followme

The deprecated API field "mode" has been removed.

YesNoYT:BA-42280

The 'default_action' feature in service settings has fully replaced this field functionality.

MR119-0

Subscription

add_subscription

update_subscription

get_subscription_info

get_subscription_list

The deprecated API field "charge_suspended_customers" has been removed.

YesNoYT:BA-42280

Next fields have replaced this field functionality:

  • waive_charges_for_first_bp
  • waive_charges_for_regular_bp
  • waive_charges_for_last_bp
MR119-0

Customer

get_subscriptions

The deprecated API field "search" has been removed.

YesNoYT:BA-42280

The 'quick_search' field has replaced this field functionality.

MR119-0

Customer

get_taxation_info

update_taxation

The deprecated API field 'options_custom' has been removed.

YesNoYT:BA-42280

This field functionality has been replaced by the 'options_custom_plugin' -> 'option_list' field.

MR119-0

CustomerClass

get_taxation_info

update_taxation

The deprecated API field 'options_custom' has been removed.

YesNoYT:BA-42280

This field functionality has been replaced by the 'options_custom_plugin' -> 'option_list' field.

MR119-0

User

add_user

update_user

get_user_info

get_user_list

The deprecated API field 'ip_filter' has been removed.

YesNoYT:BA-42280

The 'login_allowed_ip_list' field has replaced this field functionality.

MR119-0

GroupRate

get_price_selection_list

Extend request by i_tariff field.

YesYesYT:BA-42510

 

MR119-0

Customer

add_subscription
update_subscription

The regular_discount_list and upcharge_list structures have been extended with "start_date" and "end_date" fields. These fields allow for the specification of exact timeframes for upcharges or discounts. While the older approach using "start_period" and "number_of_periods" remains supported, and only one approach may be used per item on the list.

 

YesYesYT:BA-42593

 

MR119-0

Account

add_subscription
update_subscription

The regular_discount_list and upcharge_list structures have been extended with "start_date" and "end_date" fields. These fields allow for the specification of exact timeframes for upcharges or discounts. While the older approach using "start_period" and "number_of_periods" remains supported, and only one approach may be used per item on the list.

YesYesYT:BA-42593

 

MR119-0

CallControl

play

get_input

New API methods have been added.

Yes YesYT:BA-41973

 

MR119-0

CallControl

start_dtmf_detect

stop_dtmf_detect

play_prompt

stop_play_prompt.

Methods are marked as deprecated.

YesYesYT:BA-41973

 

MR119-0

CallControl

get_sip_calls_list

The next fields have been marked as deprecated:

  • event
  • dtmf_duration
  • order
  • digit
YesYesYT:BA-41973

 

MR119-0

GroupRate

get_rate_list

get_rate_info

update_rate

add_rate


Extend GroupRateInfo structure with next_rate_list that contains info about rates for level 1.

Extend GroupRateInfo structure with rate_level and i_dest_group_set fields.

Allow to update inactive_from field of group rate.

Extend method get_rate_list with effective_only flag that allows to get only effective group rates (applied to level 0 and level 1).

Extend method get_rate_list with i_primary_rate parameter in order to obtain extra rates of the primary rate.

Drop i_rate_lookup_context, i_next_rate_lookup_context fields from the schema as lookup context is internal entity and should not have public attributes.

YesNoYT:BA-42548

 

MR119-0

GroupRate

get_rate_list

Add filters for L0 (primary) rates: i_dest_group, effective_at, i_price_selection, reverse_rating, discontinued.

YesYesYT:BA-42566

 

MR119-0

Tariff

add_tariff

For tariffs with rating mode Grouped: add "i_dest_group_set" field, remove "rate_lookup_context" field.

YesNoYT:BA-42490

 

MR119-0

Service

get_service_list

The new filter, with_obsolete, has been added to the request's input fields.

It specifies whether obsolete services should be retrieved.

YesYesYT:BA-36452

 

MR119-0

Service

get_service_list

get_service_info

The new field, obsolete_from, has been added to the response.

It specifies the date and time when the service was marked as obsolete.

YesYesYT:BA-36452

 

MR119-0

Payment

get_payment_distribution_list

The new method was added to allow tracking how the amounts of the payments were distributed between different destinations (e.g. some part was applied to invoice #123 and the rest is currently unallocated).

YesYesYT:BA-42250


MR119-0

Invoice

get_applied_payment_list

The new method was added to allow tracking which parts of which payments were applied to the specific invoice.

YesYesYT:BA-42250


MR119-1

Customer

add_customer_individual

update_customer_individual

The API fields 'daily_allowance' and 'transaction_allowance' have been made mandatory for creating Reseller individuals.

Additionally, updating these fields to 'null' is now restricted.

YesNoYT:BA-42667

Previously, it was possible to create a Reseller individual without specifying the 'daily_allowance' and 'transaction_allowance' fields. However, these fields are now mandatory and must be provided with a value.

If a Reseller individual is not expected to have values for 'daily_allowance' or 'transaction_allowance', an explicit 0 should be set for these fields.

MR119-1

Tariff

test_tariff_rating

Added 'origination' input field. If provided multi-level charging (like CLD+CLI) is tested.

YesYesYT:BA-42655


MR119-1

RoutingPlan

get_route_list

Add 'rate_list' field to RouteInfo structure. This field will be present for routes associated with grouped tariffs.

YesYesYT:BA-43012


MR119-1

Service

add_service_pool

The method has been marked as deprecated.

YesYesYT:BA-42569

The 'Service Pool' service type is now deprecated. Please use other service pool types instead.

MR119-1

Service

add_service

Creating a service with i_service_type set to 18 (Service Pool) is now prohibited.

NoNoYT:BA-42569

The 'Service Pool' service type is now deprecated. Please use other service pool types instead.

MR119-1

Service

add_service_pool

update_service_pool

add_service

update_service

get_service_pool_info

get_service_pool_list

get_service_info

get_service_list

The following API fields that are exclusively used for the 'Service pool' service type are marked as deprecated now:

  • dest_group_set_name' 
  • 'i_dest_group_set'
  • 'service_pool_combination_list'
YesYesYT:BA-42569

The 'Service Pool' service type is now deprecated. Please use other service pool types instead.

MR119-1

Customer

vd_topup

vd_set_multiplier

get_full_vd_counter_info

The following API fields that are exclusively used for the 'Service pool' service type are marked as deprecated now:

  • dest_group_set_name' 
  • 'i_dest_group_set'
  • 'service_pool_combination_list'
YesYesYT:BA-42569

The 'Service Pool' service type is now deprecated. Please use other service pool types instead.

MR119-1

Account

vd_topup

get_full_vd_counter_info

The following API fields that are exclusively used for the 'Service pool' service type are marked as deprecated now:

  • dest_group_set_name' 
  • 'i_dest_group_set'
  • 'service_pool_combination_list'
YesYesYT:BA-42569

The 'Service Pool' service type is now deprecated. Please use other service pool types instead.

MR119-1

PortalView

get_portal_list

Added the "get_internal" key to retrieve both standard portals linked to an environment and internal portals.

YesYesYT:BA-43180


MR119-1

CallControl

get_sip_calls_list

The 'server_time' field in the response is now non-mandatory.

YesYesYT:BA-38900


MR119-1

Customer

get_customer_list

Added a new API field 'status', which currently supports filtering by the 'frozen' status.

YesYesYT:BA-42183



  • No labels