API Changelog Summary

make_transaction,

update_payment_method

generate_accounts

Account

Customer

add_account
          

Modified behaviour of parameter: owner_batch - can be empty now

Added parameter: managed_by (can be empty also)

Account

Customer

TT#518158

Added parameter: for_idle_numbers_only for get_countries_list and get_areas_list methods

Added parameters: offset, limit, idle_only for get_numbers_list method

Modified behaviour of parameter: owner_batch - can be empty now

Added parameter: managed_by (can be empty also)

YT:BA-1414

Created TaxationPlugin service

YT:BA-1475

- hold_call

- unhold_call

- transfer_call

- join_calls

• Added group_by_roaming parameter to get_services_consumption method
• Added roaming parameter to get_customer_xdrs method
• Added aux_info information to CustomerXDRInfo structure. It stores information from XDR_*_Aux tables

Added i_tax_transaction_code to DiscountInfo struct

add_criterion

update_criterion

get_criterion

get_criteria_list

Added mode input field to GetTaxPluginsListRequest struct. Added catalog_based, requires_configuration, is_configured fields to TaxPluginInfo struct

add_constraint

update_constraint

Added methods:

• FraudTrafficProfile.update_constraint
• FraudTrafficProfile. add_constraint

get_customer_list,

get_customer_info

get_account_list,

get_account_info

get_payment_transaction_list

Added "i_merchant_account" filter.

Added possibility to return total number of payment transactions(call method with flag get_total).

get_payment_transaction_by_id

get_payment_transaction_list

Added i_payment_transaction_type to TransactionInfo.

Removed 'i_env' field from the TransactionInfo structure.

add_customer

update_customer

get_customer_info

add_product, update_product, get_product_list, get_product_info

Added possibility to assign subscription to a product using add_product, update_product methods.

Added i_subscription key to ProductInfo (to response of get_product_list, get_product_info methods)

BA-4963  

  BA-4961

Added 'object' field to request of mentioned method.

Value of new 'object' field determines which codes should be returned.
Possible values: 'env' - all env codes should be returned; 'customer' - should be only returned codes, that could be applied to customer.

get_customer_class_info

get_customer_class_list

add_customer_class

update_customer_class

Added 'detailed_info' request flag. It specifies whether detailed information will be returned in the response or not.

Added 'moh_file_name' field to 'CQInfo' structure.

get_customer_class_info

get_customer_class_list

add_customer_class

update_customer_class

get_service_info,

add_service,

update_service,

delete_service,

get_service_list

Implemented 4 new methods in Service module:
add_service, get_service_info, update_service, delete_service.

get_service_list extended with new input fields, that could filter output of the method:
name, i_service_type, i_st_charge_unit, rating_base, unit, rate_unit, ratio, usage_rating, internal, i_tax_transaction_code.

Also get_service_list was extended to have possibility go 'get_usage' of services.
 

get_vendor_info,

get_vendor_list

Added 'connections_total' field to response of mentioned methods.

From now get_vendor_info always returns 'connections_total'.

Send 'get_connections_total' in request of get_vendor_list to get ' connections_total ' for each vendor in response of the method.

YT:BA-5698

Implemented get_ua_info method, that returns regular ua_info + info about busy/available ports.

(Ported from MR61-1, BA-5149)

get_vendor_list,

get_vendor_info,

add_vendor,

update_vendor

get_vendor_list and get_vendor_info were extended to return 'notepad' field in response.

add_vendor and update_vendor were extended to have possibility to add/modify vendor's notepad.

(Ported from BA-5300)

add_vendor,

update_vendor

Forbid add/update_vendor methods to take 'balance' field in the requests.

From now user is allowed only to set opening_balance while creating vendor using add_vendor, like it was before changes in RT#498488

get_account_info,

get_account_list

add_account

update_account

Removed 'i_account_role' filter from the request of the get_product_list().

Added 'account_roles' filter to the request of the get_product_list().

The ' account_roles ' (array of 'i_account_role' ) filter could be used instead of this former 'i_account_role' filter.

REST API changes only

Changed "dry_run" flag into "aux_info" structure. If set to 'all' or 'simple', API method will be executed not in full, so it will validate only input arguments and return result of this validation. All other values for dry_run mode are ignored

add_cp_condition

update_cp_condition

Account

Customer

Vendor

add_account,

update_account,

add_customer,

update_customer,

add_vendor,

update_vendor

get_invoice_list

get_invoice_info

Added 'prompt_name'

Removed deprecated field 'radius_client' from the NodeInfo  structure 

Added i_tax_transaction_code to DiscountInfo struct

add_criterion

update_criterion

get_criterion

get_criteria_list

Added mode input field to GetTaxPluginsListRequest struct. Added catalog_based, requires_configuration, is_configured fields to TaxPluginInfo struct

Added 'with_discount_info' input field to GetAccountFullVDCounterListInfoRequest structure. Added ' full_discount_info' field to FullCounterInfo structure.  

get_payment_transaction_by_id

get_payment_transaction_list

add_customer

update_customer

get_customer_info

get_customer_class_info

get_customer_class_list

add_customer_class

update_customer_class

get_customer_class_info

get_customer_class_list

add_customer_class

update_customer_class

get_payment_transaction_by_id

get_payment_transaction_list

add_customer

update_customer

get_customer_info

get_customer_class_info

get_customer_class_list

add_customer_class

update_customer_class

add_customer_huntgroup
update_customer_huntgroup

add_followme_number_list

update_followme_number_list

get_number_list

get_number_info

Added field 'moved' to DIDNumberInfo struct

Add the following filters to get_connection_list method:
i_service_type, CLD, i_node, i_vendor_acc, remote_ip, i_tariff, active, description, i_connection_type, conn_type_leg_origin and conn_type_technology.

Add conn_type_leg_origin and conn_type_technology to response of get_connection_list and get_connection_info methods.

add _service_pool,

update_service_pool

get_vendor_list,

get_vendor_info,

add_vendor,

update_vendor

get_vendor_list and get_vendor_info were extended to return 'notepad' field in response.

add_vendor and update_vendor were extended to have possibility to add/modify vendor's notepad.

get_tariff_list,

get_tariff_info

TariffInfo type was extended with the following two new fields: 'rate_format' and 'is_used'.

'rate_format' is always returned by mentioned methods.

'is_used' is always returned by get_tariff_info and could be returned by get_tariff_list, if it is called with 'check_usage' key in request

get_tariff_list,

get_tariff_info

Extended TariffInfo structure with 'authorized_email_list' field. This field will be always returned by get_tariff_info, and returned by get_tariff_list if there is 'with_authorized_emails' in request of the method.

Added possibility to filter tariff list using 'routing_ext' field filter.

Also it is now possible to get total number of tariffs.

get_rate_info,

get_rate_list

get_inventory_options,

update_inventory_options

add_allowed_location,

update_allowed_location,

delete_allowed_location,

get_allowed_location_list,

get_used_location_list

get_account_info,

get_account_list

add_account

update_account

get_number_list

get_number_info

Added field 'moved' to DIDNumberInfo struct

Added field 'h323_conf_id' to XDRInfo structure.

Removed 'call_recording_server_url', 'call_recording_url' from XDRInfo structure.

Renamed cr_download_links to cr_download_ids in the XDRInfo structure.

Removed 'call_recording_server_url', 'call_recording_url' from CustomerXDRInfo structure.

Renamed cr_download_links to cr_download_ids in theCustomerXDRInfostructure.

Renamed with_cr_download_links to with_cr_download_ids in the GetAccountXDRListRequest structure.

Renamed with_cr_download_links to with_cr_download_ids in the GetRetailCustomerXDRListRequest structure.

REST API changes only

Added support of background execution for REST API, added param bg_info (third) to URL part and to POST request part;

response changed without schema in case method is run with bg_info: { async: 1}, so response contains { bg_request_id: Int } value only

get_inventory_options,

update_inventory_options

Add the following fields to request of the mentioned method: email, iso_4217, get_total, check_usage, hidden.

Extend output to return 'total' if get_total is equal to 1 and to return 'is_used' (in RepresentativeInfo) if check_usage is equal to 1

update_subscription

delete_subscription

get_group_list, get_group_info,

add_group,
update_group 

get_product_list

Added 'included_products' to requests of add_group and update_group methods.

Added 'products_total' to responses of get_group_info and get_group_list(by get_products_total) methods.

Added filter by 'name' field for get_group_list method.

Added filter by 'i_product_group' for get_product_list method.

Representative,

Customer

get_customer_list,

get_representative_info,

get_representative_list

Added 'customers_total', 'resellers_total', 'distributors_total' to responses of get_representative_info/list methods.

Added filter by 'i_rate' field for get_customer_list method.

Vendor

add_vendor_did_provider_account,

get_vendor_did_provider_account_list,

update_vendor_did_provider_account,

delete_vendor_did_provider_account,

add_vendor_batch,

update_vendor_batch,

delete_vendor_batch

get_owner_batch_list,

get_owner_batch_info

DIDOwnerBatchListInfo type was deleted (DIDOwnerBatchInfo is used instead of it).

ArrayOfDIDOwnerBatchListInfo type was renamed to ArrayOfDIDOwnerBatchInfo.

'get_did_total_usage' and 'get_did_total' were added to requests of get_owner_batch_list/info.

Added the following fileds to request of get_owner_batch_list:
'get_total', 'with_markup', 'order_by'.

Added the following fields to DIDOwnerBatchInfo structure: total_dids_used, total_dids_free, total_dids.

Add filter 'empty_markup_options' for get_owner_batch_list().

add_representative,

update_representative

get_number_list,

get_number_info

Add 'recurring_cost' and 'recurring_revenue' field to response of the mentioned methods (get_number_list returns them only by 'with_extended_info').

Implement total/get_total logic for get_number_list method.

Changes that are related with get_number_list method:
The new possible fields(filters) in request: i_dv_batch, description, i_customer, with_extended_info

The new fields in response: activation_fee, periodic_fee, i_vendor, country_iso

These are returned only if 'with_extended_info' is present in request: country_name, vendor_name, customer_name, reseller_name

Extend get_vendor_batch_list with the following fields:

• total/get_total logic
• add total_dids_used, total_dids_free to the responce for every VendorBatchInfo while get_did_total_usage is true in the request
• add vendor name to the responce for every VendorBatchInfo

get_account_info,

get_account_list

add_account

update_account

get_number_list,

get_number_info

REST API changes only

Renamed parameter "bg_info" into "aux_info".

update_number_list,

delete_number_list

get_taxation_info,

update_taxation

REST API changes only

Changed "dry_run" flag into "aux_info" structure. If set to 'all' or 'simple', API method will be executed not in full, so it will validate only input arguments and return result of this validation. All other values for dry_run mode are ignored

add_cp_condition

update_cp_condition

Added "with_usage" parameter to include usage XDRs

Added "used_quantity" column to method response

Added " with_usage" parameter to include usage XDRs

Added "used_quantity" column to method response

get_route_category_info

add_route_category

update_route_category

delete_route_category

get_ua_profile_info

add_ua_profile_info

update_ua_profile

delete_ua_profile

enable_api_notifications

disable_api_notifications

get_countries_list

get_areas_list

get_numbers_list

provision_number

Added param req_params_list to methods get_areas_list, get_numbers_list;

Added i_did_provider to all mentioned methods in req_params

get_access_role_type_list

get_access_role_list

get_access_role_info

add_access_role

update_access_role

delete_access_role

get_negotiated_feature_list,

update_negotiated_feature_list

Implement rerate_xdrs method.

Please note, the method is available only in 'async' mode.

REST API changes only

Changed "dry_run" flag into "aux_info" structure. If set to 'all' or 'simple', API method will be executed not in full, so it will validate only input arguments and return result of this validation. All other values for dry_run mode are ignored

add_cp_condition

update_cp_condition

add_customer,

update_customer,

get_customer_info,

get_customer_list

get_spending_plan_list,

get_spending_plan_info

1) сhange type of the 'managed_by' field in the GetSpendingPlanListRequest structure from 'char' to 'unsignedLong'.

2) change type of the 'managed_by' field in the SpendingPlanInfo structure from 'int' to 'unsignedLong'.

3) from now 'managed_by' field in the request of the get_spending_plan_list() method can be 'null'.

Adjust add_account(), add_customer(), add_representative(), add_user() and add_vendor() methods to read default 'i_lang' value from config file.

add 'nil => 1' flag to the following fields of the 'GetDIDNumberListRequest' structure:
'owner_batch', 'i_group', 'i_dv_batch'

add_service_pool

update_service_pool

get_ivr_application_list

get_ivr_application_info

add_ivr_application

update_ivr_application

delete_ivr_application

get_access_number_list

get_access_number_info

add_access_number

update_access_number

delete_access_number

YT:BA-6386

REST API changes only

Changed "dry_run" flag into "aux_info" structure. If set to 'all' or 'simple', API method will be executed not in full, so it will validate only input arguments and return result of this validation. All other values for dry_run mode are ignored

get_routing_criteria_info

add_routing_criteria

update_routing_criteria

delete_routing_criteria

get_routing_criteria_dest_group_info

add_routing_criteria_dest_group

update_routing_criteria_dest_group

delete_routing_criteria_dest_group

add_cp_condition

update_cp_condition

Add the following methods in the TimePeriod module:

• get_time_period_info;
• get_time_period_list;
• add_time_period;
• update_time_period;
• delete_time_period.

Added new methods for RoamingProfile service:

• get_roaming_profile_list;
• add_roaming_profile;

• update_roaming_profile;

• delete_roaming_profile;

• get_roaming_country_list.

Customer,

Account

get_customer_info, get_customer_list,

get_selfcare_config_data

get_account_info,

get_account_list,

get_selfcare_config_data

Added password_lifetime to structs CustomerInfo and AccountInfo

Added internal methods get_selfcare_config_data

BA-7586

update_quick_form,

get_quick_form_fields_list,

set_quick_form_fields

get_asr_file_list

get_asr_file

get_cost_revenue_file_list

get_cost_revenue_file

get_session_context,

set_session_context

Added field euuid to CustomerInfo (works only for get_customer_list method)

Return customers from both systems - production and alterego when method is called on production system and there is available alter-ego context

1) XDRInfo type was renamed to AccountXDRInfo

2) ArrayOfXDRInfo type was renamed to ArrayOfAccountXDRInfo

1. Add the following fields to AccountXDRInfo structure in the response of the mentioned method: account_id, i_account, call_id, is_split.
2. Add 'h323_conf_id' filter to the request of the mentioned method.
3. When 'h323_conf_id' is present in the request, 'i_account', 'date_from' and 'date_to' are no longer mandatory.
   

1. Add 'h323_conf_id' and 'i_customer_type' filters to be possible in the request of the mentioned method.
2. Add 'i_account' and 'i_customer' fields to the CustomerXDRInfo in the response of the method.
3. When 'h323_conf_id' field is present in the request, i_customer, from_date, to_date becomes not mandatory, but 'i_customer_type' becomes mandatory.

get_access_policy_info,

get_access_policy_list

1. Implement new get_access_policy_list() method.
2. Add the following fileds to be possible in the request of the get_access_policy_info() API method: 'with_attributes', 'with_access_phases', 'check_usage'

1. Add 'cli', 'cld', 'show_unsuccessful' fields to be possible in the request of the method.
2. Add 'credits' and 'charges' field to every object inside per_service_info in the response.
3. Remove default 'billing_model' filter from the request of the method (previosly it was 1 by default)

1. Add 'cli', 'cld', 'billing_model' and 'show_unsuccessful' fields to be possible in the request of the method.
2. Add 'credits' and 'charges' field to every object inside per_service_info in the response.

Add mentioned method for vendor entity.

Account,

Customer

make_transaction,

make_transaction

get_node_list,

get_node_info

The following XDR fields will be added to the output of the Account.get_xdr_list():
'i_customer', 'h323_incoming_conf_id', 'setup_time'

The following XDR fields will be added to the output of the Vendor.get_xdr_list():
'setup_time'

The following XDR fields will be added to the output of the Customer.get_customer_xdrs():
'call_id', 'setup_time'

get_dialing_rule_list,

get_dialing_rule_info

Add 'check_usage' field to the requests of the mentioned methods.

While 'check_usage' is true in the request of any of the methods, the method returns 'is_used' in the response.

get_ua_profile

update_ua_profile

Added field get_parameters to GetUAProfileInfoRequest

Added field ua_profile_parameters to UAProfileInfo struct

Added 'i_dest_group' filter to the request of the mentioned method.

Known limitation: the method correctly returns the list of destinations that belong to a destination group from regular (not complete) destination group set.

Implemented the following API methods:

get_connection_destination_group_list,

unblock_connection_destination_group

Add 'get_split_xdrs' field to be possible in the request of the method.

Add 'split_order' field to every CustomerXDRInfo structure if the XDR is split

Add 'get_split_xdrs' field to be possible in the request of the method.

Add 'split_order' field to every AccountXDRInfo structure if the XDR is split

get_invoice_list

get_invoice_info

get_request_info

get_request_list

update_account

delete_account

update_alias

Adjusted validation of the 'format' input field of the mentioned method.

From now the following values are possible to be sent in the field: 'e164', 'e212', 'custom'

Added the following fields to the response of the mentioned method (to every VendorXDRInfo structure):

country, description

Adjust logic of the search_rate_list() method's 'number' filter.

The mentioned method returns only the longest matched rate for every tariff (if 'number' filter is specified in the request)

add_cp_condition,

update_cp_condition

Adjusted 'number' field validation in the requests of the mentioned methods.

'+' symbol was allowed to be taken in the field

Yes

get_time_period_info,

get_time_period_list

get_number_list,

get_number_info

get_number_list,

get_number_info

Add 'description' filter to be used in 'use_did_location' mode.

The 'city_name' filter from now can be used not only in the 'use_did_location' mode.

get_ua_profile_info

update_ua_profile

get_ua_profile_list

Added input parameter get_effective_values to GetUAInfoRequest

Added i_ua_profile to UAInfo

Account

UA

*

*

Changed the type of field AccountInfo.ua_profile_id to unsigned_long

Changed the type of field UAInfo.ua_profile_id, UAProfileInfo.ua_profile_id to unsigned_long

Redesigned method to allow generating UA profiles by ua_profile_id

Added ua_profile_id as input parameter in GenerateUaProfileRequest

All parameters in GenerateUaProfileRequest are not mandatory on schema level, but it's required to set ether ua_profile_id OR i_ua, phone_type, i_account. In case ua_profile_id is set then no response will be returned in case successful execution

Method generate_ua_profile now supports asynchronous mode. Also supports no more then 1000 ua profiles generation in sync mode (if required more use old mode by i_account, i_ua, phone_type OR use asynchronous mode)

Add 'covers_date' filter to be possible in the request of the get_invoice_list() API method

Allow setting individual pricing batch via DID.assign_did_to_owner_batch

• added allow activation_fee, periodic_fee to input parameters of the method
• in case activation_fee and periodic_fee passed to DID.assign_did_to_owner_batch it means an attempt to set individual pricing for DID (these values have higher priority in case they are passed among i_do_batch)
• admin cannot set individual pricing to DID number managed by reseller (admin can only release reseller's DID numbers, but not to manage with their pricing parameters)

get_customer_info,

get_customer_list

1. Added 'Connect time' and 'Disconnect time' columns to the CSV file for the Conferencing, Voice calls, Dial up, Session, Wifi, IPTV and Data xDRs; 'Date/Time' column was renamed to 'Connect time';
2. Added 'Made by' column to the CSV file for the 'Credit/Adjustment' and 'Payment' xDRs;
3. Added 'Comment' column to the CSV file for the Quantity based and Service Pool xDRs;
4. Added 'Description' column to the CSV file for the Subscription xDRs;
5. Added 'Made by' column to the CSV file for the Payments and Credit/Adjustment xDRs in case when Admin or reseller fetches the csv file;
6. Added 'Status' column to the CSV file for all xDRs in case when Admin fetches the csv file;

1. Added 'Connect time' and 'Disconnect time' columns to the CSV file for the Conferencing, Voice calls, Dial up, Session, Wifi, IPTV and Data xDRs; 'Date/Time' column was renamed to 'Connect time';
2. Added 'Made by' column to the CSV file for the 'Credit/Adjustment' and 'Payment' xDRs;
3. Added 'Comment' column to the CSV file for the Quantity based and Service Pool xDRs;
4. Added 'Description' column to the CSV file for the Subscription xDRs;
5. Added 'Made by' column to the CSV file for the Payments and Credit/Adjustment xDRs in case when Admin or reseller fetches the csv file;
6. Added 'Status' column to the CSV file for all xDRs in case when Admin fetches the csv file;

Added 'format' input field with one 'csv' possible value to the request of the method.

The method behaves the same way (return similar CSV file) as Account.get_xdr_list() does in case when the field is present in the request

Added 'format' input field with one 'csv' possible value to the request of the method.

The method returns CSV file in the response attachment in the case when "format:csv" is present in the request.

Added 'prompt_name'

add_owner_batch

update_owner_batch

update_ua_profile

get_ua_profile_info

login

generate_captcha

Added captcha protection support to login, added ca_token, ca_code to LoginRequest

Added method to generate captcha image with token

get_route_category_list,

get_route_category_info

get_route_category_list,

get_route_category_info

Added 'check_usage' field to be possible in the requests of the mentioned methods

Added 'is_used' field to the responses of the methods in case when check_usage is equal to 1 in the requests.

get_routing_plan_list

get_routing_plan_info

Added:

• input parameter 'with_route_categories'. If it passed then route categories assigned to a routing plan will be added to the response;
• output parameter 'route_category_list'. The list of route categories assigned to a routing plan;
• new SOAP type 'RoutingPlanCategoryInfo'. Contains information about a route category assigned to a plan.

Customer

Account

get_rp_category_list
add_rp_category
update_rp_category
delete_rp_category

Several input fields were renamed:

'time_begin' => 'from_date',

'time_end' => 'to_date'

Several output fields were renamed in the response TraceSessionInfo structure:

'time_begin' => 'from_date',

'time_end' => 'to_date'

The Env->get_system_load_metrics_data() method was removed.

Metric->get_system_metric_data() can be used instead.

Adjusted get_invoice_list() to return 'period_from' and 'period_to' fields in server UTC TZ
(as they are in the DB)

Customer

Vendor

Account

get_transactions_total_info

get_transactions_total_info

get_transactions_total_info

Removed default value of 'inclusive_taxation' field in Customer.add_customer() API method request

Customer,

User

add_customer,

update_customer,

add_user,

update_user

Added validation for the 'api_token' field. From now it should conform regular expression: ^[0-9a-f-]{36}$

Added validation for the 'ip_filter' field. From now the field should contain only ip addresses separated by a semicolon

get_ua_type_usage_statistics

get_ua_inventory_usage_statistics

add_routing_plan,

update_routing_plan

get_routing_plan_info,

get_routing_plan_list

Adjusted behaviour of the 'destination' input filter in case when input 'format' =='e212'.

After changes made in this TT, '%' pattern value won't be added at the ending of the 'destination' filter.

Search will be executed as is (without modification of the 'destination' filter).

To keep previous behaviour of the method, add needed '%' on the API client application side.

add_access_policy,

update_access_policy,

delete_access_policy

Implemented the following methods:

add_access_policy, update_access_policy, delete_access_policy

get_customer_info,

get_customer_list

Customer

get_customer_info,

get_customer_list

list_processors

get_processor

Added new regenerate_invoice_list() method.

This method enables an API user to regenerate a list of invoice PDF files

get_user_info

get_user_list

add_user

update_user

add_routing_plan,

update_routing_plan,

get_routing_plan_info,

get_routing_plan_list

Make 'object' and 'i_object' input filters of get_payment_transaction_list() are not mandatory for admin realm.

Add 'i_customer_type' input filter to the mentioned method

Account

Customer

Payment

make_transaction

make_tax_transaction

add_group

update_group

enable_api_notifications

disable_api_notifications

originate_call

get_sip_call_list

Account

Customer

Payment

Payment.get_payment_transaction_by_id

Payment.get_payment_transaction_list

Extended TransactionInfo structure with account_id and customer_name new fields

Customer

Account

Payment

register_transaction

register_transaction

register_transaction, get_payment_transaction_list

Added the following input filters:

'matching_type', 'number'

get_custom_field_info

get_custom_field_list

get_custom_field_list

add_custom_field

update_custom_field

delete_custom_field

get_custom_field_info

Adjust the following filters of the mentioned method:

iso_4217, name, search.

From now '%' and '_' symbols in these filters won't be escaped on the method level.

If you need the previous behaviour - please escape these symbols manually before sending them in a request.

Added one more possible value (IO) for the 'usage_type' input filter.

In case when 'IO' 'usage_type' filter is sent, the method should return entities with both incoming and outgoing usage types in the response.

get_tax_plugins_list,

get_tax_plugin

Added check_usage to get_tax_plugins_list and get_tax_plugin methods

Added is_used to TaxPluginInfo

set_tax_plugin_parameters,

get_tax_plugin_parameters_metainfo

get_tax_transaction_code_list

Extended method get_tax_transaction_code_list input args with:

• plugin_code
• with_plugin_codes
• code
• description
• get_total
• limit
• offset

Added plugin_code_list to TaxTransactionCode

get_tax_transaction_code_info,

add_tax_transaction_code,

update_tax_transaction_code,

delete_tax_transaction_code

Added methods to manage with tax transaction code information

add_callqueue,

update_callqueue

make_transaction

change_password

make_transaction

make_tax_transaction

get_connection_list,

get_connection_info

Extended get_connection_list and get_connection_info API methods to return vendor_name in the ConnectionInfo structure.

Extended 'get_number_list' method to take 'number_list' input field in the request.

This field can contain an array of objects with 'i_did_number' field.

Such changes enable an API user to fetch a list of DID numbers by their i_did_number.

Extended 'get_number_list' method to take 'format' input field with possible values: csv, xls and xlsx.

In a case when format is present, the method will return a file with did numbers in the appropriate file format.

add_customer_class,

update_customer_class,

get_customer_class_info,

get_customer_class_list

add_service_policy,

update_service_policy,

get_attribute_list

Adjusted the behaviour of the mentioned methods.
From now 'possible_values' of the boolean attributes are [0,1] instead of ['Yes', 'No'].

If affects the values that are returned by get_attribute_list() for boolean value_type.
Also, a boolean attribute value can be equal to 0 or 1 in the requests of add_service_policy() and update_service_policy() methods.

The following fields are no longer mandatory:

• 'name' in TaxPluginInfo;
• 'description', 'code' in TaxTransactionCode.

The following fields are no longer mandatory:

• 'payment_method' in AccountPaymentMethodInfo;
• 'i_account', 'type' in CPConditionInfo;
• 'destination', 'i_dest' in DestinationPrefixInfo;
• 'i_env' in EnvInfo;
• 'description', 'i_oli', 'oli' in OliInfo;
• 'payment_method' in PaymentMethodInfo;
• 'i_tariff', 'name' in TariffInfo;
• 'xdr_type' in CustomerXDRInfo.

The validation of the 'ip_filter' field was adjusted.

From now it's possible to specify a netmask in the field.

Both following formats are supported from now:
192.168.192.0/24 or 192.168.192.0/255.255.255.0

Affected methods: add_customer, update_customer, add_user, update_user

Affected API types: CustomerInfo, UserInfo

get_dialing_rule_info,

get_dialing_rules_list

Extended 'get_destination_list' method to take 'destination_list' input field in the request.

This field can contain an array of objects with 'i_dest' field.

Such changes enable an API user to fetch a list of destinations by their i_dest.

Account

Customer

Added new types for responses from this methods: AccountCustomFieldsInfo and CustomerCustomFieldsInfo. Responses will use Account_Custom_Fields and Customer_Custom_Fields ACL objects respectively

'is_used' and 'object' fields were removed from responces of this methods

*

• Extended get_destination_list() method to return spreadsheet attachment with destinations by 'file_format' input field (Possible values: 'csv', 'xls', 'xlsx').
  
  
• Implemented get_default_destination_list() method that returns spreadsheet attachment with default destination set.
  
  
• Removed unpublished download_destinations() method. The functionality of this method is covered by get_destination_list() and get_default_destination_list() methods from now.

Added the 'i_block_attr' and 'i_parent' fields  to the response, which establish dependencies between IVR options(unique id of a record - parent record)

add_group

update_group

Added 'with_usage' field to the method request.

Added 'activation_cost' and 'activation_revenue' fields to the DIDNumberInfo structure in the method response.

The fealds are returned only in case if 'with_extended_info' attribute is true in the method request.

get_discount_plan_info,

get_discount_plan_list

The mentioned methods are extended to return 'is_complete' field in the DiscountPlanInfo structure.

These methods return the field only if the 'check_complete_status' input method attribute is true.

Added the following input filters:

'name', 'i_voice_application', 'description', 'number_pattern', 'with_callbacks'

Account

Customer

add_account

update_account

validate_account_info

add_customer

update_customer

validate_customer_info

add_subreseller

Several changes were made to ActiveSessionInfo type:

• field 'on_net' was added;
• types of fields 'hotlined', 'is_disconnectable' were changed to 'int'.

activate_subscriptions
add_account
add_account_advanced (internal)
add_account_with_topup (internal)
add_alias
add_allowed_location
add_auto_payment
add_cp_condition
add_cp_rule
add_followme_number
add_phonebook_record
add_preferable_account
add_subscription
arrange_cp_rules
arrange_followme_numbers
assign_sim_card
assign_ua
assign_ua_advanced (internal)
charge_subscription_fees
delete_account (internal)
delete_alias
delete_auto_payment
delete_cp_condition
delete_payment_method
estimate_call_price
estimate_taxes
generate_accounts
get_account_state
get_alias_list
get_allowed_addons (internal)
get_allowed_location_list
get_auto_payment_info
get_booths (internal)
get_call_barring_options
get_cp_condition_list
get_cp_rule_list
get_custom_fields_schema
get_custom_fields_values
get_full_vd_counter_info
get_member_of_huntgroups_list
get_moh_list_info
get_payment_method_info
get_permitted_sip_proxies_info
get_phonebook_list
get_preferable_account_list
get_service_features
get_service_wallet_xdr_list
get_services_consumption
get_sip_status
get_subscriptions
get_transactions_total_info
get_used_location_list
get_vd_counter_list
make_transaction
move_account
release_sim_card
release_ua
set_account_state
terminate_account
topup_account
update_account
update_account_followme
update_alias
update_auto_payment
update_booth (internal)
update_call_barring_options
update_cp_condition
update_payment_method
update_subscription
vd_topup

activate_subscriptions
add_abbreviated_dialing_number
add_auto_payment
add_batch
add_customer_extension
add_customer_huntgroup
add_customer_site
add_subscription
charge_subscription_fees
close_billing_period
delete_customer
delete_customer_extension
delete_payment_method
estimate_taxes
get_abbreviated_dialing_number_list
get_account_aliases_list
get_accounts_subscriptions (internal)
get_auto_payment_info
get_call_barring_options
get_callqueue_list
get_credit_limit_history
get_custom_fields_schema
get_custom_fields_values
get_custom_xdr_report
get_custom_xdr_report_list
get_customer_billing_periods_history
get_extensions_list
get_full_vd_counter_info
get_huntgroup_list
get_metrics_data
get_moh_list_info
get_number_sequence_info (internal)
get_payment_method_info
get_rt_tickets_list
get_service_features
get_service_wallet_xdr_list
get_services_consumption
get_sites
get_status_history
get_subscriptions
get_taxation_info
get_transactions_total_info
get_vd_counter_list
make_tax_transaction (internal)
make_transaction
modify_spending_limit
suspend_customer
terminate_customer
unsuspend_customer
update_call_barring_options
update_customer
update_customer_advanced (internal)
update_number_sequence (internal)
update_payment_method
update_service_features
update_subscription
update_taxation
vd_topup

MR65

-5

get_dest_group_set_list,

get_dest_group_set_info

Adjust the method 'to_date' input filter to search transactions exactly by the datetime provided in the field.

Before these changes, back-end side added 24 hours to the provided datetime timestamp and only that performed search.

Add 'get_total' flag to the 'GetUAProfileListRequest' structure.

'total' field will be returned only if 'get_total' flag is passed.

update_taxation,

get_taxation_info

Extended update_taxation() method to take 'i_tax_transaction_code' and 'estimate_taxes' fields in the method request.

Extended get_taxation_info() method to return 'i_tax_transaction_code' and 'estimate_taxes' fields in the method response.

update_taxation,

get_taxation_info

Extended update_taxation() method to take 'i_tax_transaction_code' and 'estimate_taxes' fields in the method request.

Extended get_taxation_info() method to return 'i_tax_transaction_code' and 'estimate_taxes' fields in the method response.

The 'search' filter of the mentioned method was adjusted.

From now '%' and '_' symbols in this filter won't be escaped on the method level.

If you need the previous behaviour - please escape these symbols manually before sending them in a request.

1. From now the 'i_online_payment_processor' field is always taking into account in the 'merchant_account' input object (before these changes the field was ignored if '"remittance":1' was present in the request)
2. Removed 'remittance' field from the method request,

From now the method automatically determines whether the adding processor is remittance by 'i_online_payment_processor' field in the 'merchant_account' input object.

Added 'get_total' field to the request of the mentioned method.

From now this method returns 'total' in the response only by 'get_total' in the request.

GetProductGroupListRequest, so from now, total number of the product groups will be returned only if 'get_total' is set.

get_rate_list,

search_rate_list

• country field, from 'country' to 'i_dest',
• description field from 'description' to 'i_dest',
• destination field from 'destination' to 'i_dest',
• destination_group field from 'destination_group' to 'i_dest',
• effective_now field from 'effective_now' to 'effective_from',
• network field from 'network' to 'i_dest',
• unit field from 'unit' to 'i_tariff',
• rate_unit field from 'rate_unit' to 'i_tariff',

• editable,
• effective_immediately,
• i_rate.

YT:BA-14752

Adjusted mentioned method to return rates with hidden == 'Y' by default.

The related get_rate_list() method already returns hidden rated by default.

update_cp_condition

delete_cp_condition

Added the 'check_available_dids' optional argument to the reqeust of the mentioned method.

The field has the following description:

If 'gen_method' is set to 'D' and the field is set to '1', the method will check available numbers and fall with an error if the number of available numbers is less than the value in the 'gen_amount' field

Customer

Account

get_customer_xdrs

get_xdr_list

get_ui_config_list,

update_ui_config_list

add_criterion

update_criterion

Account,

Customer

make_transaction,

make_transaction

get_ua_profile

update_ua_profile

Added field get_parameters to GetUAProfileInfoRequest

Added field ua_profile_parameters to UAProfileInfo struct

get_invoice_list

get_invoice_info

get_request_info

get_request_list

update_account

delete_account

update_alias

get_ua_profile_info

update_ua_profile

get_ua_profile_list

Added input parameter get_effective_values to GetUAInfoRequest

Added i_ua_profile to UAInfo

Account

UA

*

*

Changed the type of field AccountInfo.ua_profile_id to unsigned_long

Changed the type of field UAInfo.ua_profile_id, UAProfileInfo.ua_profile_id to unsigned_long

Redesigned method to allow generating UA profiles by ua_profile_id

Added ua_profile_id as input parameter in GenerateUaProfileRequest

All parameters in GenerateUaProfileRequest are not mandatory on schema level, but it's required to set ether ua_profile_id OR i_ua, phone_type, i_account. In case ua_profile_id is set then no response will be returned in case successful execution

Method generate_ua_profile now supports asynchronous mode. Also supports no more then 1000 ua profiles generation in sync mode (if required more use old mode by i_account, i_ua, phone_type OR use asynchronous mode)

Allow setting individual pricing batch via DID.assign_did_to_owner_batch

• added allow activation_fee, periodic_fee to input parameters of the method
• in case activation_fee and periodic_fee passed to DID.assign_did_to_owner_batch it means an attempt to set individual pricing for DID (these values have higher priority in case they are passed among i_do_batch)
• admin cannot set individual pricing to DID number managed by reseller (admin can only release reseller's DID numbers, but not to manage with their pricing parameters)

add_owner_batch

update_owner_batch

update_ua_profile

get_ua_profile_info

Added 'prompt_name'

login

generate_captcha

Added captcha protection support to login, added ca_token, ca_code to LoginRequest

Added method to generate captcha image with token

get_routing_plan_list

get_routing_plan_info

Added:

• input parameter 'with_route_categories'. If it passed then route categories assigned to a routing plan will be added to the response;
• output parameter 'route_category_list'. The list of route categories assigned to a routing plan;
• new SOAP type 'RoutingPlanCategoryInfo'. Contains information about a route category assigned to a plan.

Customer

Account

get_rp_category_list
add_rp_category
update_rp_category
delete_rp_category