Release MR115

Method has been extended with park_id field

Methods are available for distributor

The "from_date" input parameter is now validated to reject values that are earlier than the expected lifetime
of the CDRs

add_service_and_rating

The method will now reject adding Usage Charges for Services not included in the Product.

Add "success" flag to the response.

Method request structures have been extended with batch_balance_update field

Method response structures have been extended with batch_balance_update field

Method request structures have been extended with batch_balance_update field

Method response structures have been extended with batch_balance_update field

Add "format" input parameter to choose the transcription result - as JSON (default), or as a plain text.

Methods is available for reseller

Account

Customer

The response was extended with new field - continued_money_amount.

This allows to obtain the amount of expenses (measured in the customer's currency) that were covered by the previous bundle in the current usage period before the bundle change (similarly to continued_unit_amount).

Account

The method has been extended with a "with_sim_card_info" flag that will allow to get "sim_card_info" structure that can
  include i_sim_card, iccid, imsi and description fields for the account.

CallControl

The method has been marked as deprecated.
participant_info.moderator and participant_info.wait_for_moderator fields are removed from input structure.

CallControl

The method has been added, the input structure is taken from CallControl/join_to_active_call

TraceSession

The method has been marked as deprecated.

TraceSession

The method has been added, the input structure is taken from TraceSession/send_to_rt.

By default, call logs will be sent to YT by email. That email can be changed by a new option in the configuration 'PortaCare' -> 'IssueTrackerEmail'.

add_rate_group (rate_info)
update_rate_group (rate_info)
add_rate (rate_info)
batch_add_rate (rate_list->item)
update_rate (rate_info)

The input validation was adjusted to prohibit negative values for the following input fields:

• price_1
• price_n
• op_price_1
• op_price_n
• special_price_1
• special_price_n

This does not affect business logic - although negative values were allowed, the system stored and operated with absolute values.

Methods are now accessible for use by resellers when using customer class assigned to reseller or shared for all resellers

get_traffic_profile_list
get_traffic_profile_info

Methods are now accessible for use by resellers when using customer class assigned to reseller or shared for all resellers

void_invoice

The method doesn't allow voiding invoices for the same customer simultaneously.

void_invoice_list

Add a new voiding method - void_invoice_list. This method utilizes the void_invoice method logic under the hood, but has several advantages:

• Invoices of different customers can be provided (customers should belong to the same environment).
• It can handle/process multiple invoices of the same customer.

get_huntgroup_list

Added new field to filter result list to contain only hunt groups assigned to it.

add_vendor_batch

update_vendor_batch

We will now allow "<" and ">" symbols for the vendor batch names.

add_account

get_account_info

update_account

validate_account_info

get_account_list

add_account_with_topup

get_simple_account_info

generate_accounts

Field 'i_acl' has been marked as deprecated.

add_subreseller

get_customer_list

add_customer

get_my_info

get_customer_info

update_customer

validate_customer_info

The "i_acl" field has been marked as deprecated.

add_user

get_user_info

update_user

The "i_acl" field has been marked as deprecated.

get_extended_data_list

The "i_acl" field has been marked as deprecated.

update_customer_class

add_customer_class

The "special_rounding" field has been marked as deprecated.

get_invoice_info

get_invoice_list

The "tax_method" field has been marked as deprecated.

The "i_billing_processor" field has been marked as deprecated.

get_rt_tickets_list

The "created" and "last_updated" fields have been marked as deprecated.

Use the "created_from" field, it has the same logic as "created" field.

Use the "last_updated_from" field, it has the same logic as "last_updated" field.

get_rt_ticket_list

The "created" and "last_updated" fields have been marked as deprecated.

Use the "created_from" field, it has the same logic as "created" field.

Use the "last_updated_from" field, it has the same logic as "last_updated" field.

login

refresh_access_token

login_to_realm

change_password

The "expires_at" field has been marked as deprecated.

Account

get_account_product_info

Output was extended with new field - included_services, that contains the list of IDs of service types that are provided by the account' main product.

DID

update_number_list

Set mandatory for number_list.i_did_number field.

Subscription

estimate_subscription_price

API method was extended with finish_date input param.

DiscountPlan

These API methods were allowed for account realm.

Accounts are only allowed to access info about bundles that are:

• assigned to add-ons with managed_by_user='Y';
• assigned to add-ons that are assigned to account (NOW < effective_to);
• assigned to the account's main product;
• completed only (drafts excluded).

Account

The "enable_balance_fraud_protection" API field has been marked as deprecated.

Added the new API field "enable_balance_overdraft_protection" to replace obsolete one.

Customer

The "enable_balance_fraud_protection" API field has been marked as deprecated.

Added the new API field "enable_balance_overdraft_protection" to replace obsolete one.

CustomerClass

add_customer_class

update_customer_class

The maximum limit for the 'purge_after_months' API field has been set to 9999 months.

IVRApplications

The method has been updated to be able to work with global IVR application settings.
Added i_param field to update exact parameter of global IVR application settings.

IVRApplications

The methods has been extended with i_voice_application field to get the global settings of the required IVR application type.

*

Some methods all over the API schema were updated:

If a method is called in async mode and this method has a 'limit' attribute with a default value, the default value will be increased tenfold.

If the method has a 'limit' field with a default value and a maximum value for this field, then in async mode, the maximum restriction is removed.

Destination

The "i_dest_group_set" request parameter is not mandatory anymore.
The DestinationGroupInfo output type was extended with a "dest_group_set_name" field.

Representative

The "country" field for the Representatives will now be validated in sync with other entities (like Customer). That is, only the 2-letter country code will be allowed.

CallControl

hold_call
join_calls
park_call
play_prompt
progress_call
ring_call
start_dtmf_detect
join_calls
stop_dtmf_detect
stop_play_prompt
terminate_call
transfer_call
unhold_call
unpark_call

The "tag" parameter of the "call" structure is now marked as a mandatory parameter.

DID

add_owner_batch
update_owner_batch

The "retention_time" field has been marked as deprecated, as it is not used and is always set to undef.

Generic

get_extended_data_list

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

Account

add_phonebook_record

update_phonebook_record

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

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

Customer

get_my_info

get_customer_info

Deprecate the has_custom_fields  field starting from MR115-3

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.

Account

get_account_info

Deprecate the has_custom_fields  field starting from MR115-3

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.

Account

schedule_commitment_record_replacement

The API field i_addon_product has been made non-mandatory.

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.

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

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

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

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.