Release MR133

Customer

get_huntgroup_overflow_prompt_file

New API method is added

Customer

add_customer_huntgroup

update_customer_huntgroup

Added new "overflow_info" structure in the input

Customer

get_huntgroup_info

get_huntgroup_list

Added new "overflow_info" structure in the returned HGInfo structure

Account

update_account
get_service_features_metainfo

When the account takes the "emergency" service feature flag from the product, the "emergency_administrative_unit" value sent with the request is now stored. A request that omits the attribute keeps the stored value; an explicitly empty value still clears it. get_service_features_metainfo now reports "mandatory" for this attribute when the configured E911 plug-in needs it.

User
Customer

get_user_info
get_customer_info

The "rt_auth_info" block is no longer hidden from a user who has "Mask personal information in data accessed by this user" enabled. Such a user got masked values before, so the trouble ticket integration did not work. The "rt_login" and "rt_pass" fields hold the credentials of the user who makes the request, not of the requested user or customer. Their descriptions were corrected.

Notification

update_notification_template

Added validation of the template variable formats. A variable format that belongs to another format type is rejected. A custom formatting rule is rejected unless the variable format is "Other:". Format changes within the variable's own format type work as before.

Send a format of the variable's own format type. Send a custom formatting rule only together with the "Other:" format.

Customer

update_customer_extension

The "i_account" field no longer accepts an empty value. The account assigned to an extension can be replaced, but it cannot be removed. A request with an empty "i_account" now fails with the "i_account.not_set" error.

Omit the "i_account" field to keep the current account. Pass another account ID to replace it.

Session

login
login_to_realm
reset_password
change_password

The "login" field is now limited to 128 characters. A longer value is rejected with the "too_long.login" error. The longest login that can be stored is 128 characters for an account and 64 for a customer, representative, or user, so a longer value never matched an existing login.

CustomReport

execute_custom_report_query (and scheduled report runs)

Custom report generation now applies the query owner's scope to the stored customer ids. Ids that the owner cannot access are ignored. A query whose inputs refer only to inaccessible customers does not produce a report.

No

No

YT:BA-46577

Customer

add_customer
add_subreseller
update_customer
validate_customer_info

The "new_i_billing_period" field of the "customer_info" structure is now validated against the supported billing periods. Only the IDs 1 to 6 are accepted; any other value is rejected with the "invalid_customer_info.new_i_billing_period" error. Such a value was stored before and only failed later, when the scheduled billing change became due. Clearing a scheduled billing change is unaffected: an empty or null value works as before. The accepted IDs are now listed in the API reference for the field.

Customer

update_customer_extension
delete_customer_extension

An extension that represents a hunt group is no longer accepted by these methods, whatever fields the request carries. Such a request is now rejected with the "cannot_update_group_extension" or "cannot_delete_group_extension" error. Before, the update was refused only when the request carried "i_account", and the delete was not refused at all; both left the hunt group inconsistent, so calls to it failed and it could no longer be deleted. Use update_customer_huntgroup and delete_customer_huntgroup to manage a hunt group and its extension. Extensions of the "Account" and "Unassigned" types are unaffected, and a parking slot is refused as before. The "i_c_ext", "i_account", "i_c_group" and "type" descriptions in the API reference now state which types each method accepts.

AsyncRequest

delete_request_list
cancel_request

The delete_request_list and cancel_request methods are now available on a secondary site in the normal mode (previously both were rejected with a secondary_site fault), so a finished background request can be cleared and a running one cancelled from a secondary site. The main-site contract is unchanged.

Payment

list_processors
get_processor

Added the "addon_mart_module_id" field to the returned PaymentProcessor structure. It holds the ID of the Add-on mart module that provides the payment processor, and it is not returned for any other payment processor. The "name" field of such a payment processor now holds the name defined in the Add-on mart module. It held the module ID before.

To find the Add-on mart module of a payment processor, use the "addon_mart_module_id" field instead of "name".

ServicePolicy

get_attribute_list

Added the "caller_substitution_id" field to the options of the call rejection reason fields returned in "json_schema". It holds the ID of the reason reported to the caller in place of the one in "value", and is absent when the caller is told the reason in "value" itself.

EmergencyDialing

get_emergency_dialing_list
get_emergency_dialing_info
get_emergency_dialing_number_info
get_emergency_dialing_number_list
add_emergency_dialing
update_emergency_dialing
delete_emergency_dialing
add_emergency_dialing_number
update_emergency_dialing_number
delete_emergency_dialing_number

New root-only service for managing per-environment emergency dialing configurations (groups of emergency numbers and the countries they apply to).

Legacy [Emergency_Numbers] numbers are migrated to the new configuration during the update: YT:PC-11021

[Emergency_Numbers] Pattern has no automatic migration and must be re-entered manually in the new configuration: YT:IUN-1037

DialingRule

Add a new field `applicable_country` to the `DialingRuleInfo` structure in the request.

DialingRule

Add a new field `applicable_country` to the returned `DialingRuleInfo` structure (a single record for get_dialing_rule_info, each list item for get_dialing_rules_list).

DID

get_number_list
update_number_list
delete_number_list

The "owner_batch" filter now treats the null value as "no pricing batch on either level". For an administrator the result no longer includes DID numbers that fall under the pricing batch of the reseller that manages them. For a reseller the result is unchanged. The same filter selects the numbers that update_number_list and delete_number_list act on.

To list or change the numbers managed by a reseller, filter by that reseller's pricing batch ID instead of the null value.

Account

add_account
update_account
validate_account_info

A product or add-on change that enables Static IP is now rejected if the account's IP address or netmask is empty.

Send the IP address and netmask when you assign a product or add-on that enables Static IP

Account

move_account

A move that changes the product to one enabling Static IP is now rejected if the account's IP address or netmask is empty.

Set the IP address and netmask before you move an account to a product that enables Static IP

Account

add_account (input)
update_account (input)
get_account_info (output)
get_account_list (output)
get_simple_account_info (output)

Added the "terminate_on" and "terminate_did_handling" fields to the AccountInfo structure. "terminate_on" holds the date and time in UTC when the account is scheduled to be terminated; an empty value cancels the scheduled termination. "terminate_did_handling" defines what happens to the DID numbers of the account on that termination: 'release' (the default) returns them to the pool, 'keep' leaves them allocated to the customer. The fields are not returned or accepted in the customer, account and hunt group supervisor self-care realms.

EmergencyDialing

get_emergency_dialing_number_list

Added an optional "phone_number" filter to the input

Customer

add_customer
update_customer

Deprecated "i_tariff" and "i_tariff_incoming" in the CustomerInfo structure. Assign the reseller tariffs on the product instead. Both fields are now checked the same way on add_customer and on update_customer: the tariff must be of the voice service type, be a reseller tariff and match the customer's currency. Before, only "i_tariff" was checked, only on add_customer, and only against the built-in "Voice Calls" service.

A tariff built on a custom service of the voice type is now accepted. A tariff of another service type, another currency, or a non-reseller tariff is now rejected on update_customer.

Product

add_product
update_product
add_subscription

A product shared with resellers can now be combined only with subscriptions accessible to resellers, in "i_subscription" and in "i_reseller_subscription". Otherwise the request fails with "Server.Product.i_subscription.shared_product_with_nonshared_subscription" or "Server.Product.i_reseller_subscription.shared_product_with_nonshared_subscription". update_product also fails when "shared" is set to "Y" for a product that has a non-shared subscription.

Use subscriptions shared with resellers on shared products. Products that already have a non-shared subscription are not changed.

Subscription

update_subscription

"shared" cannot be changed to "N" when a product shared with resellers uses the subscription. The request fails with "Server.Subscription.subscription_used_by_shared_product".

First remove the subscription from the shared products, or unshare those products.

Customer

add_callqueue
update_callqueue
add_customer_huntgroup
update_customer_huntgroup

A callback overflow action with a custom prompt is now rejected with "callqueues.custom_prompt_requires_wait_confirmation" also when the request omits "wait_confirmation" or "i_callqueue_action". On update, an omitted value is taken from the stored call queue. On create, an omitted "wait_confirmation" counts as 'N'. A request with "prompt_action" set to 'unset' counts as having no custom prompt. The "wait_confirmation" description in the OnIncomingCallLimitInfo, OnMaximumWaitingTimeInfo and OnMaximumRingingTimeInfo structures now states this rule.

Send "wait_confirmation" 'Y' with a custom callback prompt, or remove the prompt with "prompt_action" 'unset'. A call queue already stored with a custom callback prompt and confirmation disabled rejects any update to that overflow action until one of these is sent.