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
MR68-0

Customer

Vendor

Account

get_transactions_total_info

get_transactions_total_info

get_transactions_total_info

Fixed data type of the field total_amountYesNoYT:BA-12588
MR68-0Invoice*Fixed data type of the field pdf_created in InvoiceInfo structYesNoYT:BA-12588
MR68-0UA

get_ua_type_usage_statistics

get_ua_inventory_usage_statistics

Added methods that enables API user to fetch the CPE inventory statisticsYesYesYT:BA-10831
MR68-0

Customer



add_customer

update_customer

validate_customer_info

add_subreseller

The maximum length of the field 'tax_id' increased to 32 charactersYesYesYT:BA-12819
MR68-0Envupdate_envThe maximum length of the field 'tax_id' increased to 32 charactersYesYesYT:BA-12819
MR68-0Representative

add_representative

update_representative
The maximum length of the field 'tax_id' increased to 32 charactersYesYesYT:BA-12819
MR68-0AuthzRule

add_authz_rule

update_authz_rule

get_authz_rule_list

Added field translation_rule to struct AuthzRuleInfoYesYesYT:BA-13233
MR68-0CallControloriginate_advanced_callAdded new method originate_advanced_callYesYesYT:BA-12724
MR68-0

Customer

get_customer_info,

get_customer_list

Add 'generate_invoice_earlier' field to ScheduledCustomerStatusChangeInfo structureNoYesYT:BA-13774
MR68-0CallControloriginate_advanced_callMake tag non-mandatory, it's never returned in response of orignate_advanced_callYesYesYT:BA-13752
MR68-0Payment

list_processors

get_processor

Added field name to response in struct PaymentProcessorYesYesYT:BA-13297
MR68-0Invoiceregenerate_invoice_list

Added new regenerate_invoice_list() method.

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

YesYesYT:BA-11874
MR68-0Customerget_generated_xdrs_filemethod was removedYesNoYT:BA-9248
MR68-0Customerget_customer_xdrsremoved 'asynchronous_mode' input parameterYesNoYT:BA-9248
MR68-0Accountget_generated_xdrs_filemethod was removedYesNoYT:BA-9248
MR68-0Accountget_xdr_listremoved 'asynchronous_mode' input parameterYesNoYT:BA-9248
MR68-0Accountget_subscriptionsExtended Account->get_subscriptions() API method to return 'i_account' field in every 'AccountSubscriptionInfo' structureNoYesYT:BA-13952
MR68-1User

get_user_info

get_user_list

add_user

update_user

Added option auto_redirect_to_foreign to UserInfoYesYesYT:BA-13291
MR68-1DIDassign_did_to_owner_batchRaise fault instead of returning success property in case action failedNoNoYT:BA-13418
MR68-1RoutingPlan

add_routing_plan,

update_routing_plan,

get_routing_plan_info,

get_routing_plan_list

Adjusted mentioned methods to work with 'rp_connection_list' (the field is related ro routing override feature)YesYesYT:BA-13814
MR68-1Invoicereview_invoice_listAdded "postponed" input parameterYesYesYT:BA-13247
MR68-1**Used more strict validation for URLs (hostnames)NoNoYT:BA-12857
MR68-1

Account

Customer

Payment

make_transaction

make_tax_transaction

Max length of internal comment reduced from 230 to 200YesYesYT:BA-13433
MR68-1Product

add_group

update_group

Added group_info to response in case used detailed_response as input parameterYesYesYT:BA-14006
MR68-1Account

enable_api_notifications

disable_api_notifications

Allow specifying account alias in CC API requestsNoYesYT:BA-1994
MR68-1CallControl

originate_call

get_sip_call_list


Allow specifying account alias in CC API requestsNoYesYT:BA-1994
MR68-1Paymentget_payment_transaction_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

YesYesYT:BA-14059
MR68-1

Customer

Account

Payment

register_transaction

register_transaction

register_transaction, get_payment_transaction_list

Covered methods with ACL object Payment_TransactionsNoYesYT:BA-14273
MR68-1CallBarringget_call_barring_class_list

Added the following input filters:

'matching_type', 'number'

YesYesYT:BA-14501
MR68-1Bitcoin*All methods are covered with ACLNoYesYT:BA-14124
MR68-1CustomFields

get_custom_field_info

get_custom_field_list

Added field is_used to CustomFieldsInfoYesYesYT:BA-14089
MR68-1CustomFields

get_custom_field_list

Added input params name, object, check_usage, type, mandatory, visible_to_end_user to get_custom_field_list methodYesYesYT:BA-14089
MR68-1CustomFields

add_custom_field

update_custom_field

delete_custom_field

get_custom_field_info

Added methods add_custom_field, update_custom_field, delete_custom_field, get_custom_field_infoYesYesYT:BA-14089
MR68-1CustomFields*Covered all the methods with ACLsNoYesYT:BA-14089
MR68-1Productget_product_list

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.

NoNoYT:BA-14420
MR68-1DialingRuleget_dialing_rules_list

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.

NoYesYT:BA-14609
MR68-1TaxationPlugin

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

YesYesYT:BA-14007
MR68-1TaxationPlugin

set_tax_plugin_parameters,

get_tax_plugin_parameters_metainfo

Added method set_tax_plugin_parameters (external) and get_tax_plugin_parameters_metainfo (internal). To reset plugin parameter value send empty value in 'value' field of parameter structYesYesYT:BA-14007
MR68-1TaxationPlugin

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

YesYesYT:BA-14007
MR68-1TaxationPlugin

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

YesYesYT:BA-14007
MR68-1CallBarring*Covered CallBarring service methods with ACLsNoYesYT:BA-14600
MR68-1TaxationPlugin*Covered TaxationPlugin service methods with ACLsNoYesYT:BA-14170
MR68-1Account

make_transaction

change_password

Removed 'chk' API ACL field, added required permission for default account ACLYesYesYT:BA-12771
MR68-1Customer

make_transaction

make_tax_transaction

Removed 'chk' API ACL field, added required permission for default retail ACLYesYesYT:BA-12771
MR68-1Productget_product_list

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

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

YesNoYT:BA-14826
MR68-1Vendor

get_connection_list,

get_connection_info

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

NoYesYT:BA-15063
MR68-1DIDget_number_list

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.

YesYesYT:BA-10719
MR68-1DIDupload_did_numbersImplemented upload_did_numbers methodYesYesYT:BA-10719
MR68-1Accountget_xdr_listThe mentioned method was extended to return 'i_rate' field of every XDR in the responseNoYesYT:BA-14235
MR68-1CustomerClass

add_customer_class,

update_customer_class,

get_customer_class_info,

get_customer_class_list

The mentioned methods were extended to work with 'use_external_billing', 'reset_customer_balance' and 'hide_reset_balance_xdr' customer class DB fieldsYesYesYT:BA-14407
MR68-1ServicePolicy

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.

NoNoYT:BA-15148
MR68-1**

The following fields are no longer mandatory:

  • 'name' in TaxPluginInfo;
  • 'description', 'code' in TaxTransactionCode.
NoYesYT:BA-15275
MR68-1**

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.
NoYesYT:BA-15280
MR68-1**

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

NoYesYT:BA-15129
MR68-1**Returned back the ACL object and attributes for fields addon_effective_from && addon_effective_to of structure ProductInfoNoNoYT:BA-15197
MR68-1BillingSessiondisconnect_sessionImplemented 'disconnect_session' methodYesYesYT:BA-14530
MR68-1Invoicereview_invoiceAdded 'postponed' input parameterYesYesYT:BA-14852
MR68-1ServicePolicyget_service_policy_listApplied LIKE search pattern to match_pattern filterNoNoYT:BA-15137
MR68-1DialingRule

get_dialing_rule_info,

get_dialing_rules_list

Extended mentioned methods to return 'is_default' field in the DialingRuleInfo structureNoYesYT:BA-10496
MR68-1**Extend AuxXDRInfo XSD type to contain 'xdr_time' fieldNoYesYT:BA-13866
MR68-1Destinationget_destination_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.

YesYesYT:BA-14904
MR68-1Rateget_rate_listThe behaviour of the get_rate_list API method was adjusted a little.

Removed default filter '"discontinued":"N"' in case of '"effective_from":"now"'.
From now rates with both ( discontinued == 'Y' ) && ( discontinued == 'N' ) are returned in '"effective_from":"now"' mode.

To have the previous behaviour please send additional '"discontinued":"N"' filter manually in the request on the method.
NoNoYT:BA-10840
MR68-1Services*Attribute 'i_st_charge_unit' permissions is checked for 'rating_base' attributeNoNoYT:BA-15434
MR68-1BillingSessionget_active_sessions_listImplemented 'get_active_sessions_list' methodYesYesYT:BA-14616
MR68-1DIDcancel_did_assignmentAdded input parameter dont_release_to_pool to allow keeping DID assigned to customerYesYesYT:BA-15054
MR68-1

Account

Customer

get_custom_fields_schema

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

YesNoYT:BA-14963
MR68-1Templateget_template_listAdded the input parameter 'name' for searching templates by nameYesYesYT:BA-14684
MR68-1Template

*

Covered methods and type TemplateInfo with ACL object 'Templates'YesYesYT:BA-14701
MR68-1DIDget_vendor_batch_listExtend the mentioned method to return entities usage status ('is_used' field) if the 'check_usage' field is equal to '1' in the method request.YesYesYT:BA-13600
MR68-1Destination*
  • 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.
YesYesYT:BA-15501
  • No labels