Release MR120

update_assigned_commitment_record

The input was extended with 2 new properties - penalty_period_from and penalty_period_to. This enables predefining the penalty period.

add_options_template

get_options_template_info

get_options_template_list

update_options_template

delete_options_template

Add methods to work with config templates that allows to set up buttons for particular CPE profile, assign them to UAs and regenerate actual config file for phone.

get_ua_profile_metainfo

Allow internal method for admin, reseller and customer realms

add_phone_directory
update_phone_directory
delete_phone_directory
get_phone_directory_info
get_phone_directory_list

Methods to work with UA Config phone directories have been added.

add_options_template

get_options_template_info

get_options_template_list

update_options_template

Add directories_options and directory_poll_interval fields to OptionsTemplateInfo structure (input and output).

update_assigned_commitment_record

The input was extended with 2 new properties - min_terminate_date and sale_discount_configuration_list. This allows changing the regular discount period, add new sale discounts for an active commitment or update existing ones, e.g., changing the discount amount or the period.

Service

get_service_list

The API field 'get_total' has been updated: the data type has changed from 'char' to 'int'.

UA

add_options_template
update_options_template
get_options_template_info
get_options_template_list

Key info was extended with a new "extras" field. The list of keys is located in OptionsTemplateInfo->keys_options and the field location is OptionsTemplateInfo->keys_options->[]->extras

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.

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.

DiscountPlan

add_discount_plan
update_discount_plan
get_discount_plan_info
get_discount_plan_list

Extended DiscountPlanInfo with new fields - 'keep_remaining_days_on_renew' and 'renew_period_days'

GroupRate

cleanup_inactive_rates

Add method to cleanup group rates with effective_from date in the future of the specified tariff.

Method is analogous to Rate/cleanup_inactive_rates but for group rates.

UA

get_ua_profile_metainfo

Extended UAProfileKeysInfo structure with a new field (list of strings) - 'extras_attributes'

Tariff

test_tariff_rating

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

UA

get_options_template_list

Add "i_ua_type" and "name" filters to the request.

RoutingPlan

get_route_list

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

GroupRate

get_rate_list

Add 'file_format' (enum: xls, xlsx) to request. This field used to download rates in the file.

get_rate_list

Add 'destination_groups' field to filter result by the list of destination groups (primary rates only).

add_dest_group_set
get_dest_group_set_info
get_dest_group_set_list
get_dest_group_list 

The field 'complete_match' of Destination Group Set now can have value 'U' (Unique).

add_dest_group
update_dest_group

When new destination is added to the destination group via 'add_destinations' field, the error will be raised if the destination group belongs to the destination group set with 'complete_match' in (Y - Complete, U - Unique), and this destination already added to another group of this set.

get_price_selection_list

get_rate_list

Updated the 'get_total' API field type to 'int'.

Previously, the 'get_total' API field accepted 'Y/N' values; now, it expects '1/0' values.

get_phone_directory_list

Updated the 'get_total' API field type to 'int'.

Previously, the 'get_total' API field accepted 'Y/N' values; now, it expects '1/0' values.

get_rate_match_mode_list

Method is allowed for reseller.

Service

add_service_pool

The method has been marked as deprecated.

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

Service

add_service

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

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

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'

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

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'

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

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'

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

PortalView

get_portal_list

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

UA

get_ua_type_list

The method has been extended to provide the new directory_supported field to indicate which manufacturers allow directory generation.

CallControl

get_sip_calls_list

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

Customer

get_customer_list

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

Tariff

test_tariff_rating

Added a new API field, 'simulation_mode', as a replacement for the legacy field 'mode', which is now deprecated. The possible values for the new field are the strings: 'funds' and 'quantity'.

Tariff

get_tariff_list

Added a new API field, 'name', which can be used to filter tariffs by name. Unlike the 'search' filter, it does not apply to the 'description' field.

Subscription

add_subscription
update_subscription

Added 999 as the maximum limit for subscription_info→minimum_period field (it had no max. limit before)

Subscriptions with (minimum_period > 999) will stay in the system as is - it's just impossible to create them with too high minimum_period (or update this value to more than 999).

UA

add_options_template
update_options_template

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

Having 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.

Tariff

add_tariff

i_dest_group_set is mandatory for grouped tariff

There was an error without i_dest_group_set, so this change doesn't broke compatibility.

Account

get_account_list

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

Customer

get_customer_list

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

GroupRate

add_price_selection

i_op1_period, i_op2_period are mandatory depending on the used i_price_selection_type

Having a price selection rule of the 'Off-Peak' type is useless without off-peak periods assigned.

GroupRate

add_rate

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

The 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.

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"

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.

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.

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.

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

GroupRate

get_price_selection_type_list

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

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.

Account

get_assigned_commitment_terms

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

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.

UA

get_ua_type_info

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

UA

get_phone_directory_list

Method is allowed for the account realm.

UA

get_phone_directory_info

Method is allowed for the account realm.

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.

TimePeriod

get_time_period_list

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

GroupRate

add_price_selection

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

UI already has this field mandatory

Vendor

Account

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

Customer

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

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).

Vendor

get_xdr_list

Add the 'customer_name' field to the VendorXDRInfo structure.

TrafficProfile

update_traffic_profile

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

Previously the error was returned

Customer

get_custom_fields_values
update_custom_fields_values

API methods are now allowed for distributor realm.

DiscountPlan

get_discount_plan_info

The API method is now allowed for the Distributor realm.

Template

add_tariff_download_template

get_template_list

Methods are allowed for the reseller realm

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.

Customer

get_subscriptions

Add a new field "activation_fee" to the response to display the subscription activation price on the UI.

Account

get_subscriptions

Add a new field "activation_fee" to the response to display the subscription activation price on the UI.

Subscription

estimate_subscription_price

Method is allowed for the account realm.

Customer

Add the 'beneficiary_billing_model' field to the CustomerXDRInfo structure.

The 'beneficiary_billing_model' field specifies the type of the beneficiary account if the service was consumed by a beneficiary.

Account

Add the 'beneficiary_billing_model' field to the AccountXDRInfo structure.

The 'beneficiary_billing_model' field specifies the type of the beneficiary account if the service was consumed by a beneficiary.

DiscountPlan

Change "offset" param type to "int" and set default value to 0

Notification

The API param 'variables.value' has been made not mandatory

Account

get_mailbox_message_list

Add new fields "from", "to" (values of From and To headers of the message) to the response.

Response fields (i_brand_panel, color_scheme, html) were wrapped into brand_panel_info field

Overview:  new "brand_panel_info" wrapping object has been added that contains all of the original response fields.
Symptoms/Impact:  external application doesn't find original fields in the response or treat them as null (i_brand_panel, color_scheme, html)
Actions: Switch the application to look for the attributes inside of the brand_panel_info object that is now returned in the response.

BillingSession

Add the 'billing_model' field to the ActiveSessionInfo structure.