Release MR118

Removed file_name field from response structure.

CallControl

originate_call

Added new method. Doc: HLD - Originate a simple call via call control API without an automatic callback to the caller. Method should be used for Autodialer applications - to make a call to a certain phone number using API request, and when a call is connected, the custom IVR application will play prompts, collect DTMF, etc.

CallControl

connect_two_parties

Added new method. Doc: HLD - Originate a simple call via call control API without an automatic callback to the caller. Connect two parties and establish the call.

IVRApplications

obtain_access_number

Dropped.

IVRApplications

release_access_number

Dropped.

CallControl

enable_api_notifications

"i_ivr_an" request parameter is dropped

User must use 'User application' service feature instead of 'User application' IVR type with obtain_access_number, release_access_number methods.

CallControl

disable_api_notifications

"i_ivr_an" request parameter is dropped

CallControl

get_sip_calls_list

"i_ivr_an" request parameter and  "access_number" response parameter are dropped

CallControl

originate_advanced_call

Deprecated

CallControl

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.

CustomerClass

add_customer_class

update_customer_class

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

*

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.

Vendor

get_vendor_info

get_vendor_list

add_vendor

update_vendor

Added new API field 'generate_csv_reports' to allow disabling statistics report generation for vendors.

CustomerClass

add_customer_class

update_customer_class

get_customer_class_info

get_customer_class_list

Deprecated the 'statistics_disabled' field in the CustomerClass schema due to its inverted logic, where 'Y' indicates 'disabled', which is counterintuitive.

Replace it with the new 'generate_csv_reports' API field for clearer semantics.

Remove the default value for the 'statistics_disabled' field.

Representative

add_representative
update_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.

NumberPorting

add_netnumber_info

Dropped

CustomerClass

get_customer_class_list (output)
get_customer_class_info (output)
get_default_customer_class (output)
add_customer_class (input)
update_customer_class (input)

New field was added - skip_invoice_generation_if.

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.

Account

add_account

update_account

validate_account_info

add_account_with_topup

get_account_product_info

get_allowed_addons

get_account_info

get_simple_account_info

validate_account_info

The deprecated API field 'subscription_discount_list' has been removed.

Account

get_subscriptions

add_subscription

update_subscription

The deprecated API field "discount_list" has been removed.

Customer

add_subscription

get_subscriptions

get_accounts_subscriptions

The deprecated API field "discount_list" has been removed.

Product

get_product_info

get_product_list

get_allowed_addons

The deprecated API field "subscription_discount_list" has been removed.

Subscription

add_subscription

update_subscription

get_subscription_info

get_subscription_list

The deprecated API field "discount_list" has been removed.

DiscountPlan

update_discount_plan

add_discount_plan

get_discount_plan_list

get_discount_plan_info

The deprecated API field "reset_period" has been removed.

Product

get_product_discount_plan_list

The deprecated API field "reset_period" has been removed.

Node

add_node

update_node

get_node_info

get_node_list

The deprecated API field "i_time_zone" has been removed.

Customer

update_payment_method

make_transaction

get_payment_method_info

The deprecated API field "exp_date" has been removed.

Account

update_payment_method

make_transaction

vd_topup

get_payment_method_info

The deprecated API field "exp_date" has been removed.

Payment

make_transaction

The deprecated API field "exp_date" has been removed.

IVRApplications

get_ivr_application_list

get_access_number_list

The deprecated API field "number_pattern" has been removed.

DID_Provider

obtain_number

The deprecated API field "reserved_stamp" has been removed.

DID

get_number_info

get_number_list

The deprecated API field "reserved_stamp" has been removed.

GroupRate

get_price_selection_type_list

get_price_selection_list

get_price_selection_info

add_price_selection

update_price_selection

delete_price_selection

Add new internal methods

GroupRate

get_rate_list

get_rate_info

delete_rate

Add new internal methods

GroupRate

add_rate
update_rate

Add new internal methods

Rate

get_rate_match_mode_list

Add new internal method

Rate

get_rate_match_mode_list

Extend response with i_env, pattern_keys, description fields

Destination

get_dest_group_set_list

add_dest_group_set

get_dest_group_set_info

Add new i_rate_match_mode field to the requests

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

BillingSession

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.

TraceSession

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.

Tariff

add_tariff
update_tariff
get_tariff_info
get_tariff_list

Add "rating_mode" field, value is one of ('Standard', 'Grouped'). For tariffs with Grouped rating_mode, add "rate_lookup_context" field.

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.

Tariff

add_tariff

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

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.