Release MR126

Extras

make_request

get_ui_plugins_config

The UI plug-ins API is non-internal now

The get_ui_plugins_config method now has a strict schema and returns a list of 'ui_plugins' containing 'name' and 'config' fields

The get_ui_plugins_config method now returns an encoded JSON string in the 'config' field, instead of the previously returned decoded JSON configuration. This means that the encoding should now be handled on the client side.

Product

add_product
get_product_info
get_product_list
update_product

The "topup_addon" field has been removed as deprecated. We won't take it into consideration for adding/updating products and will not return it in get methods. 

We do not have users of this functionality, still:

Users may check the following options:
- Already handled by universal rules (single addon
      per priority with VD);
- Could be replaced by more explicit options
      (check_vd_compatibility and discontinue).

AccessPolicy

add_usage_constraint

update_usage_constraint

get_usage_constraint_list

get_usage_constraint_info 

Extend usage_units field with binary style unit qualifiers support ('KiB','MiB','GiB','TiB')

Generic

get_session_data

The method has been made public (remove internal flag).

Response field tz was renamed to time_zone_name

The tz field was renamed to time_zone_name to provide clearer and more accurate description of the field.

Impact: external application could not find original field in the response or treat it as null.
Actions: Switch the application to look for the time_zone_name field, that is now returned in the response.

Service

get_external_services_list

The method is now available not only for Admins and Resellers, but also for Customers and Accounts.
Customers and Accounts use the credentials of their parent entities — for example, a direct customer uses the admin’s credentials, a subcustomer uses the credentials of its reseller, and an account uses the credentials of its parent customer entity (admin/reseller).

Customer

get_call_activity_metrics

The method was adjusted to support the call direction 'forwarded' (in addition to 'incoming' and 'outgoing').

DID

update_number

update_number_list

It is now allowed to change vendor batch of the DID. The constraint has been dropped.

SIMCard

add_sim_card
update_sim_card

Now we will forbid "disposal_date" to be set in the future and
"activation_date" to be later than "disposal_date".

Customers should set valid dates as per the new constraint.

Rate

get_rate_list

Added "with_reseller_rate" field to the request.
Allows supplementing rates from a tariff managed by the reseller with the corresponding rates from the reseller’s tariff.

GroupRate

get_rate_list

Added "with_reseller_rate" field to request.
Allows supplementing rates from a tariff managed by the reseller with the corresponding rates from the reseller’s tariff.

CallControl

start_dtmf_detect

stop_dtmf_detect

play_prompt

stop_play_prompt

Removed methods from API

Use the /CallControl/get_input and /CallControl/play methods instead of the removed ones

CallControl

get_sip_calls_list

Removed the following params from the response:

• digit
• order
• dtmf_duration
• event

The removed parameters were never returned in the CallControl/get_sip_calls_list response, they were only returned in Webhook/WebSocket messages.

Since these fields have also been removed from the Webhook and WebSocket message structures, 'ivr_info' should be used instead when working with these notifications.

Payment

get_payment_transaction_list

Add the ability to specify a 'CustomerOnly' value in the 'object' API field of the request.

CalllControl

originate_advanced_call

Remove deprecated method from API

CallControl/connect_two_parties should be used instead.

 If Webhooks are needed, then use CallControl/originate_call followed by CallControl/transfer_call.

CalllControl

transfer_call

Remove the deprecated API field 'cld'

'destination' field should be used instead

Customer

get_customer_info

validate_customer_info

get_my_info

get_customer_list

The response API field 'credit_exceed' is now deprecated and has been replaced by the 'credit_exceeded' field.

'credit_exceeded' API field should be used instead of 'credit_exceed'

Customer

add_customer

update_customer

add_subreseller

get_customer_info

validate_customer_info

get_my_info

get_customer_list

The API field 'ip_filter' is now deprecated and has been replaced by the 'login_allowed_ip_list' field.

'login_allowed_ip_list' API field should be used instead of 'ip_filter'

Account

get_account_info

get_simple_account_info

The response API fields 'credit_exceed' and 'ip_filter' are deprecated in the 'customer_info' and 'reseller_info'.

'credit_exceeded' and 'login_allowed_ip_list' should be used instead of 'ip_filter' and 'credit_exceed' when using info from 'customer_info' and 'reseller_info'.

SIMCard

get_card_list

A new API field 'quick_search' was added.

DID

get_number_info

get_number_list

Methods adjusted with new fields:

• account_id - required to represent account "name"

• i_voice_app_access_number - required for navigation to Voice App page

• voice_app_name - required to represent the name of the voice app

• i_voice_application - required to represent in Assigned to column

Note: for get_number_list method these fields exist only with "with_extended_info" flag set.

Customer

add_callqueue

update_callqueue

get_callqueue_list

get_callqueue_info

add_customer_huntgroup

update_customer_huntgroup

get_huntgroup_info

get_huntgroup_list

Remove deprecated API field 'announce_number_of_callers'

'announce_position' should be used instead of the removed 'announce_number_of_callers'

Account

get_account_huntgroups_list

Remove deprecated API field 'announce_number_of_callers'

'announce_position' should be used instead of the removed 'announce_number_of_callers'

Template

update_template_data_field_list

Add validation of the datetime format string in the 'formatting rule' of the text field

The incorrect datetime format will not be saved

Rate

get_rate_list

When with_reseller_rate=Y, reseller has no default tariff, and tariff was cloned. Return corresponding rates from the original tariff.

GroupRate

get_rate_list

When with_reseller_rate=Y, reseller has no default tariff, and tariff was cloned. Return corresponding rates from the original tariff.

DID

get_customer_numbers

Account

Customer

add_call_processing_condition

update_call_processing_condition

Customers should not add spaces into filters; they do not work, as there are no spaces in dial numbers anyway.

Account

get_service_features_metainfo

PortalView

get_portal_view_configuration_list

get_portal_view_configuration_info

Allow API methods for Account realm.

Restrict Accounts to retrieving portal_view_configuration_info only for their own role.

AsyncRequest

get_request_list

Method was extended with limit/offset fields.

AsyncRequest

delete_request_list

"request_list" field now is not mandatory.

Method was extended with "delete_all" flag. Default value: 'N'. 

If provided (eq 'Y') :

• greps all async requests for the caller entity and deletes it.
• makes "request_list" mandatory

Customer

Account

make_transaction

We will now validate the provided "i_service", so that when it is not in the same i_env for the calling entity, we will return an error. We will still allow i_env=0 as system wide.

UA

We will not forbid to add phone_directories to templates if adapter for such directory is not available (e.g. we are not subscribed)

Account

get_xdr_list

Add 'destination' and 'iso_3166_1_a3' fields to the AccountXDRInfo structure.

Customer

get_customer_xdrs

Add the 'failed' field to the CustomerXDRInfo structure.