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.


BuildServiceMethodMessageSchema changedBackward compatibleTT
MR71-0Destination

get_dest_group_set_list,

get_dest_group_set_info

The mentioned methods were extended to return the 'is_set_empty' field in every DestGroupSetInfo response structure if the 'check_set_emptiness' field in the request set to 1.YesYesYT:BA-16174
MR71-0Paymentget_payment_transaction_list

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 timestamp and only then performed the search.

NoNoYT:BA-12704
MR71-0UAget_ua_profile_list

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

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


YesNoYT:BA-15687
MR71-0Invoiceget_invoice_listThe mentioned method was extended to have two additional filters in the request: issued_after and issued_before.YesYesYT:BA-15585
MR71-0User

add_user

update_user

get_user_info

get_user_list

Applied personal data filters to the mentioned methods;

Forbidden update access to the field hide_personal_info by non-superusers;

Forbidden update access to the field hide_personal_info to current user (to avoid shooting in his head)

NoYesYT:BA-16409
MR71-0UAget_ua_profile_listAdded new 'effective_at' input field to the request of the mentioned method.YesYesYT:BA-16212
MR71-0DialingRuletest_translation_ruleAdded new 'is_ivr_tr_rule' input field. If it passed then translation rule will be checked using python regular expression syntaxYesYesYT:BA-12085
MR71-0CustomerClass

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.

YesYesYT:BA-16240
MR71-0Customer

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.

YesYesYT:BA-16445
MR71-0Subscriptionget_subscription_list

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.

NoNoYT:BA-15390
MR71-0Paymentadd_merchant
  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.

YesYesYT:BA-16764
MR71-0Representative

get_xdr_list
get_tsransactions_total_info

ACL object was changed from "WebForms" to "XDR_Representatives"YesNoYT:BA-16663
MR71-0DIDadd_numberExtended response to return warning_list; Allowed to specify i_group while adding DID numberYesYesYT:BA-15769
MR71-0Paymentget_payment_transaction_listAdded 'hide_restricted' input parameterYesYesYT:BA-15633
MR71-0Currencyget_currency_listAdded 'get_total', 'skip_merchant_account_info' input parametersYesYesYT:BA-14712
MR71-0WebLogget_web_log_listChanged type of 'i_entity' field to 'string'YesNoYT:BA-16914
MR71-0DID

get_number_list,

get_number_info,

get_number_list_statistics

The metioned method were reconsidered to correctly return DID numbers if called from reseller realm.

Before these changes, a reseller could see only DID numbers that were in the i_do_batch that is managed by the reseller.

From now, for the reseller realm, the methods return the following categories of DID numbers:

  1. Assigned directly to the reseller that called the methods or to his subresellers;
  2. Assigned to a DID pricing batch that is managed by the reseller who called the methods or to the DID pricing batch that is managed by his subresellers;
  3. Located in the DID pool, in case if the reseller has a pricing batch assigned to him (i_do_batch).
NoYesYT:BA-16869
MR71-0Accountget_alias_listAdded the following filters/fields to the method request: id, realm, i_account_role, blocked, limit, offset.YesYesYT:BA-16937
MR71-0CustomerClassclone_customer_classImplemented the new clone_customer_class() methodYesYesYT:BA-11192
MR71-0IVRApplications

obtain_access_number

release_access_number

get_access_number_list

Added methods obtain_access_number and release_access_number;

Added i_account to get_access_number_list, now method available under admin, reseller, retail, account realms

YesYesYT:BA-16403
MR71-0Account

enable_api_notifications

disable_api_notifications

Extended methods to support i_ivr_an to manage with access number subscriptionsYesYesYT:BA-16403
MR71-0CallControl

play_prompt

stop_play_prompt

start_dtmf_detect

stop_dtmf_detect

get_sip_call_list

Added methods play_prompt, stop_play_prompt, start_dtmf_detect, stop_dtmf_detect;

Extended get_sip_call_list to allow getting calls by i_ivr_an

Added extra fields to SipCallInfo

YesYesYT:BA-16403
MR71-0**It's possible to download attachments for users without access to personal data if method supports data masksNoYesYT:BA-16065
MR71-0Rate

get_rate_list,

search_rate_list

Reconsidered RateInfo API structure in the context of ACL engine. Changed the ACL attributes of the following fields in the RateInfo structure:
  • 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',

Removed ACL attributes from the following fields in the RateInfo structure:
  • editable,
  • effective_immediately,
  • i_rate.
NoNo

YT:BA-14752

MR71-0Ratesearch_rate_list

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

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

NeNoYT:BA-16292
MR71-0Customer

add_customer

update_customer

*

Extended 'CustomerInfo' structure with 'login_allowed_ip_list' that is used for getting/setting the list of addresses, located previously in the CustomerInfo.ip_filter fieldYesYesYT:BA-16762
MR71-0Customer*Field 'ip_filter' from 'CustomerInfo' structure can not be used for setting/updating. It's used in read-only mode (use new 'login_allowed_ip_list' field instead )NoNoYT:BA-16762
MR71-0User

add_user

update_user

*

Extended 'UserInfo' structure with 'login_allowed_ip_list' that is used for getting/setting the list of addresses, located previously in the UserInfo.ip_filter fieldYesYesYT:BA-16762
MR71-0User*Field 'ip_filter' from 'UserInfo' structure can not be used for setting/updating. It's used in read-only mode (use new 'login_allowed_ip_list' field instead )NoNoYT:BA-16762
MR71-1Account

update_cp_condition

delete_cp_condition

Field 'i_account' is no longer mandatory as corresponding call processing condition is identified by the primary key.NoYesYT:BA-17234
MR71-0Accountgenerate_accounts

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

YesYesYT:BA-6561
MR71-1RoamingProfileget_roaming_country_listExtend the mentioned method to return 'continent_code' for every object in the responseYesYesYT:BA-15581
MR71-1IVRApplicationsget_supported_language_listImplemented get_supported_language_list API methodYesYesYT:BA-10946
MR71-1**Extend 'AssignedExtensionsInfo' structure with 'i_customer_of_account' fieldYesYesYT:BA-10164
MR71-1Userget_user_listExtend the method 'status' input filter to take 'active' possible value.NoYesYT:BA-17190
MR71-1Representativeget_xdr_list

Removed ACL attribute from the 'i_dest' field in the RepresentativeXDRInfo structure.

The field is used to determine the transaction type of an XDR. There is no sense to restrict access to the field by ACL permissions.

NoNoYT:BA-16931
MR71-1BillingSessionget_active_sessions_listOptional argument 'i_parent' was marked as nillableYesYesYT:BA-17582
MR71-1

Customer

Account

get_customer_xdrs

get_xdr_list

Allow calling mentioned methods from Representative realmYesYesYT:BA-16295
MR71-1Accountestimate_call_priceThe validation of the 'oliCode' part of the 'rating_context' argument was changed to 'int'NoNoYT:BA-17663
MR71-1WebLogget_web_log_listThe validation of the 'action_type' argument was changed to accept only 'modification' or 'read' values. The former is a union of 'insert', 'update', 'delete'.NoNoYT:BA-17002
MR71-1Rateget_rate_listExtend the mentioned method to return CSV/XLS/XLSX attachement file if asked by the new 'file_format' input field.YesYesYT:BA-17670
MR71-1User

get_ui_config_list,

update_ui_config_list

Implement the mentioned API methods that operate with per-user configs for the UI.YesYesYT:BA-17410
MR71-1Destinationget_destination_listExtend the mentioned method to filter the result list by i_dest_group_set YesYesYT:BA-17732
MR71-1AuthzRulerearrange_authz_rule_listImplement the mentioned method that rearranges the order of the authentication rules.YesYesYT:BA-17799
MR71-1AuthzRuleget_authz_method_type_listImplement the method that returns dictionary list of authentication method typesYesYesYT:BA-17695
MR71-1AuthzRuleget_authz_rule_list

The method was extended to return the following additional fields in the AuthzRuleInfo structure if the with_extended_info input field is equal to 1: account_id, connection_description and node_name.

These new fields are filled only in case

YesYesYT:BA-17802
MR71-1AuthzRuleget_authz_rule_list

Added a new 'autogenerated' filter to be possible in the method request.

The filter is used to search autogenerated or manually created authentication rules.

YesYesYT:BA-17694
MR71-1RoamingProfile

get_roaming_profile_list,

get_roaming_profile_info,

add_roaming_profile

Extend 'get_roaming_profile_list' method with 'with_contries' argument. The list of countries for each profile will be returned if the argument is set to 'Y'.

add_roaming_profile, get_roaming_profile_list, get_roaming_profile_info methods were extended with 'default_restriction_level' argument which allows to specify default restriction level for countries while creating new roaming profile.

YesYesYT:BA-17623
MR71-1Tariffdelete_tariffThe method will now throw an exception on error instead of returning success=0NoNoYT:BA-17608
MR71-1SIMCardadd_sim_cardRequest extended with 'i_account' field. If it's specified the SIM card will be assigned to the specified accountYesYesYT:BA-17590
MR71-1UAget_ua_type_listRequest extended with 'with_shared' field that enables the reseller to get configured UA types managed by the adminYesYesYT:BA-17287
MR71-1Tariff

get_resale_map_list

add_resale_tariff_mappings

Methods enabled for Admin realm.

'get_resale_map_list' extended with filter by 'i_tariff_buy'

YesYesYT:BA-17686
MR71-1Genericget_api_error_file

Add a method that returns previously saved file with errors.

For now, the method can be used to return extended errors of previously failed upload*() API methods.

YesYesYT:BA-17995
MR71-1DIDget_vendor_batch_infoAdd method to get information about DID vendor batchYesYesYT:BA-17896
MR71-1Customer

get_subscriptions

add_subscription

update_subscription

close_subscription

delete_subscription

activate_subscriptions

The method-level ACL check was adjusted to take the realm and ownership information into account.

In the 'reseller' realm the 'Subcustomers.Customer_Subscriptions' access object is used when working with subscriptions of subcustomers, 'Subresellers.Customer_Subscriptions' - when working with subscriptions of subresellers and 'Callshops.Customer_Subscriptions' - when working with subscriptions of callshops.

NoNoYT:BA-17926
MR71-1**

Reconsidered behaviour of upload API methods so that they fail with an error if at least one record is not processed correctly.

The following methods were affected:

  • EmergencyUnit.upload_emergency_units()
  • Destination.upload()
  • Destination.upload_dest_group_set()
  • DID.upload_did_numbers()

Removed 'result_list' field from the responses of:

  • EmergencyUnit.upload_emergency_units()
  • DID.upload_did_numbers()

From now all mentioned methods started to store spreadsheet files with errors in case if at least one record is not processed correctly. The uuid of the stored file is returned in faultdetails field of the API fault. The file with errors can be fetched from the system by Generic.get_api_error_file() API method.

YesNo

YT:BA-17993

MR71-1Accountget_cp_condition_listAdded 'name' filterYesYesYT:BA-17885
MR71-1CommissionPlanget_commission_plan_base_listAdded new method to fetch the commission plan baseYesYesYT:BA-17858
MR71-1BillingSessionget_active_sessions_listField 'ip' was added to 'SessionNodeInfo' structureYesYesYT:BA-18135
MR71-1**

Reconsidered behaviour of API methods for processing the batch of entities so that they fail with error if at least one record is not processed correctly.

The following methods were affected:

  • CDR.revert_xdr_list()
  • DID.update_number_list()
  • DID.delete_number_list()
  • Invoice.regenerate_invoice_list()

These methods stopped to return errors in response hashes.

From now if at least one record is not processed correctly, the methods fail with 500 code, return faultstring, faultcode and detailed info with error messages per-failed record in the 'faultdetails' field.

YesNoYT:BA-18026
MR71-1WebLogadd_noteThe method was extended with the 'detailed_response' argument. It specifies whether the added record will be returned in the responseYesYesYT:BA-18165
MR71-1SIMCardget_card_listExtend the mentioned method to return csv/xls/xlsx attachment with sim cards if file_format input key is specified in the method requestYesYesYT:BA-9669
MR71-1SIMCardupload_sim_cards

The mentioned method was extended to take xls and xlsx attachment.

Reconsidered behaviour of the method so that it fails with an error if at least one record is not processed correctly.

YesNoYT:BA-9669
MR71-1TraceSessionget_trace_session_listField 'i_disconnect_cause_class' was added to 'TraceSessionInfo' structureYesYesYT:BA-17957
MR71-1DID

add_owner_batch

get_owner_batch_list

get_owner_batch_info

Added i_customer to DIDOwnerBatchInfo. Now it's possible to add DID Owner batches managed by resellers using admin accountYesYesYT:BA-17412
MR71-1AsyncRequest delete_request_listAdded method that enabled users to delete async request statusesYesYesYT:BA-15589
MR71-1OLIget_oli_listThe method was extended with the 'oli' input argument which enables retrieving the OLI list by oliYesYesYT:BA-17918
MR71-1Customerget_services_consumption

Filter 'i_customer' was marked as 'mandatory'. Filter 'from_date' is now mandatory only if 'to_date' is not provided (and visa versa).

The implicit default (current time) is not used for 'to_date' anymore.

YesYesYT:BA-18029
MR71-1CustomReportadd_custom_report_query
update_custom_report_query

A null value for the 'i_time_zone' field was allowed ( null stands for "Auto" ).

The default value of 'i_time_zone' field was removed on Custom Report creation.

A null value of 'i_time_zone' field was allowed in the method response.


YesYesYT:BA-18186
MR71-1CustomerClassget_customer_class_list

Added the 'get_total' input argument to be possible in the request of the mentioned method.

The default value of the field is 1 (needed to keep backward compatibility).

YesYesYT:BA-17335
MR71-1Representative

 get_representative_list

 get_representative_info

Extended RepresentativeInfo with field commission_plan_effective_from

YesYesYT:BA-17857
MR71-1Customer

 get_customer_list

 get_customer_info

Extended CustomerInfo with field commission_plan_effective_from

YesYesYT:BA-17897
MR71-1FraudTrafficProfile

get_fraud_traffic_profile_list

get_constraint_list

Added filter by name to get_fraud_traffic_profile_list

Added filter by accumulation_period and i_dest_group to get_constraint_list

YesYesYT:BA-17842
MR71-1CustomFields

add_custom_field

update_custom_field

Allow admins to add/update custom fields managed by resellersNoYesYT:BA-17945
MR71-1FraudTrafficProfile*

Added the following methods in the mentioned service:

  • get_fraud_traffic_profile_info();
  • add_fraud_traffic_profile();
  • update_fraud_traffic_profile();
  • delete_fraud_traffic_profile();

Added the following fileds to be possible in the get_fraud_traffic_profile_list() request:

i_dest_group_set, limit, offset, get_total, check_usage

YesYesYT:BA-18232
MR71-1DID

get_owner_batch_info

get_owner_batch_list

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

'used' field will be returned in the response if 'check_usage' is true.

YesYesYT:BA-17245
MR71-1DiscountPlanget_topup_option_list

Request is extended with 'topup_amount', 'topup_fee', 'topup_expiry_time' filters

YesYesYT:BA-17904
MR71-1AccessRoleget_access_role_type_infoAdded method which enables an API user to get the access role type infoYesYesYT:BA-17883
MR71-1MeasuredServices

get_metric_charge_methods_list

get_measured_metrics_list

Added filter by name to the requests of the mentioned methods.YesYesYT:BA-17921
MR71-1Product

get_subscriptions

get_service_and_rating_list

Added filter by 'i_subscription' to the request of 'get_subscriptions' method.

Added filter by 'i_service', 'i_node' and 'cld' to the request of 'get_service_and_rating_list' method.

YesYesYT:BA-17924
MR71-1Serviceget_service_type_listAdded filter by name to the request of the mentioned method.YesYesYT:BA-17914
MR71-1Accountadd_account

Made 'activation_date' field to be not mandatory in the mentioned method request.

The current date is taken in case if the 'activation_date' field is not present in the method request.

NoYesYT:BA-18166
MR71-1SIMCard

add_sim_card,

update_sim_card

Extend the mentioned methods to manipulate with the sim card 'notepad' fieldNoYesYT:BA-17982
MR71-1Accountget_account_listAdded filter by 'bill_status' to the request of the mentioned method.YesYesYT:BA-18386
MR71-1Currencyget_exchange_rate_listRemoved obsolete field 'base_iso_4217' from the XRateInfo strutureYesNoYT:BA-18055
MR71-1Customerget_spending_plan_counter_info

Removed obsolete field 'i_spend_plan' from the GetSpendingPlanCounterRequest request.

'i_customer' now mandatory for the GetSpendingPlanCounterRequest

YesNoYT:BA-17113
MR71-1Genericget_api_schemaAdded filter by 'method_name' and 'service_name' to the request of the mentioned method.YesYesYT:BA-18528
MR71-1RoamingProfile

add_roaming_profile

update_roaming_profile

Empty values (including values, that contain only white-spaces) were restricted for the 'name' input parameter.NoNoYT:BA-18601
MR71-1Accountget_account_stateType of 'value' in the response was changed from 'string' to 'int'NoNoYT:BA-17314
MR71-1DID

get_inventory_options

update_inventory_options

get_inventory_option_info

Added i_customer to input parameters of get_inventory_options and update_inventory_options

Added method get_inventory_option_info

YesYesYT:BA-18128
MR71-1Vendor

get_connection_type_list

get_connection_type_info

Added filter name to get_connection_type_list

Added method get_connection_type_info

YesYesYT:BA-18105
MR71-1TraceSessionget_trace_session_listAdded 'get_total' input parameter and 'total' output fieldYesYesYT:BA-12083
MR71-1Account

get_allowed_location_list

Added extra filters to get_allowed_location_list

YesYesYT:BA-17886
MR71-1QuickForms

get_quick_forms_list

get_quick_form_fields_list

Added name filter to quick form API methodsYes
YT:BA-18023
MR71-1Serviceget_service_listExecution of the method was allowed for representativesNoYesYT:BA-18598
MR71-1CDRget_aux_xdr_type_listAdded new method that allows getting description of CDR AUX typesYesYesYT:BA-17700
MR71-1SIMCard

update_sim_card,

update_sim_card_list

Extended update_sim_card() method to update managed_by of the cards that are not assigned to account.

Implemented update_sim_card_list() that can process several sim cards using one request.

YesYesYT:BA-18475
MR71-1Accountget_account_listAdded the control_number_list input filter to the mentioned method.YesYesYT:BA-18657
MR71-1AccessRoleget_access_role_listAdded the 'complex_ordering' input field to the mentioned method reqeust.YesYesYT:BA-18660
MR71-1UA

get_ua_profile_info

get_ua_profile_list

The 'UAProfileInfo' structure was extended with the 'is_active' flag that shows whether the version of the profile is activeYesYesYT:BA-18609
MR71-1BillingSessionget_active_sessions_listAdded the 'on_net' input filter to the method. The filter enables the end user to include/exclude sessions based on the on-net status.YesYesYT:BA-17979


YT:BA-17926

  • No labels