Release MR132

Account

add_followme_number
add_followme_number_list
update_followme_number_list

"redirect_number", "name" and "domain" are no longer mandatory when a follow-me number is created, matching the update path which already allowed them to be empty. A follow-me number can now exist with call forwarding enabled and no destination configured. The format of a supplied "domain" is still validated, and a non-UDP transport without a domain falls back to UDP.

Account

get_account_followme

"redirect_number", "name" and "domain" are now nillable in the FollowMeNumberInfo structure - when empty they are returned as null instead of being omitted from the response, matching "period", "period_description" and "max_sim_calls".

Account

update_followme_number_list

Pushing more than one brand new entry (without "i_follow_me_number") in a single request is now rejected for the Simple forwarding and Forward to SIP URI modes, which allow only one follow-me number per account. Previously this limit was not enforced for new entries added through this method.

Add follow-me numbers one per request for these forward modes.

Template

clone_template

A reseller can now clone a rate upload template under a name that is already used by an administrator - the new name is checked only within the owner's own namespace instead of across the whole environment, and the clone is stored under the reseller's own ownership. Templates of other types keep the administrator namespace and are unchanged.

Template

update_template

Renaming a template to a name already taken within the same owner namespace is now refused with the "update_template.not_unique_name" fault instead of failing on a database constraint. Changing only the letter case of the current name is allowed.

AccessControl

generate_mfa_config
confirm_mfa_config

A user who must enroll in two-factor authentication before signing in can now complete the mandatory enrollment while holding only the Read permission on their own two-factor authentication (Auth_Parameters.mfa). Previously these methods required the Modify permission, which also let the user disable two-factor authentication for themselves. The permission check is waived only while the mandatory enrollment is still pending (two-factor authentication enabled but not yet configured); disabling it via set_mfa still requires Modify.

Notification

add_notification_preset

A notification preset of the "user" type can no longer be created with an owner ("i_customer") - such a preset could never be assigned to anyone, because only a preset without an owner can belong to an administrator. A reseller session is offered the "customer_class" type only; an administrator can still create a "user" preset without an owner.

Create user-type notification presets without an owner; use the customer class type for presets managed by a reseller.

User

get_user_info
get_user_list
add_user
update_user
delete_user
get_notification_list
get_notification_category_list
update_notification_list
get_rt_ticket_list

Administrators whose login is listed in the "Superusers" configuration option are now protected from API users that are not superusers. "get_user_info" and "get_user_list" return such a record reduced to "i_user", "login", "description", "email", "status", "class", "i_acl", "i_role", "role_name", "hide_personal_info" and "is_super_user" - the remaining fields, including "api_token", are withheld. "update_user", "delete_user", "get_notification_list", "get_notification_category_list", "update_notification_list" and "get_rt_ticket_list" return the "Access to the superuser is enabled only for superusers" fault. "add_user" and "update_user" additionally refuse a login listed in that option with the "Only a superuser can assign a login from the Superusers list" fault.

An integration that has to read or manage superuser records must authenticate as a superuser.

WebLog

get_web_log_list

The web log records about an administrator whose login is listed in the "Superusers" configuration option are no longer returned to API users that are not superusers, for any filter and for a request with no filter. What a superuser did to other entities stays visible to every administrator of the environment.

Customer

make_transaction
get_customer_invoices

Billing periods of a customer with invoicing turned off are now closed with a hidden internal invoice that records the period's charges and the total debt; such invoices are not returned by get_customer_invoices. The part of the payments that covered such a period's charges used to become non-refundable at the period closure (it was erased from the refundable amount). Now it stays refundable, and a manual refund of it is accepted.

Invoice

get_invoice_info
get_invoice_list

Billing periods of a customer with invoicing turned off are now closed with a hidden internal invoice that records the period's charges and the total debt; such invoices are not returned by these methods. The first regular invoice issued after invoicing is turned on again collects the not-invoiced debt through the "prior_balance" field.

Tariff

add_tariff
update_tariff
get_tariff_info
get_tariff_list

The "email_from" field of "authorized_email_list" is now compared with the real sender address of the message, exactly and ignoring letter case. Before, the stored value worked as a regular expression, and the search ran over the whole raw "From:" header. So a value that is not a plain email address no longer matches any message, and the email tariff upload is refused.

Store a plain email address in "email_from". A value that holds a pattern must be replaced.

DiscountPlan

add_discount

Adding a bundle item is now refused when it would make two products of one account use one usage counter - the same add-on priority, service, destination group and peak level. The error names both products.

Change the service, the destination group or the peak level of the new item, or use a new bundle.

Payment

get_payment_methods_for_owner

Response: added optional library_url, public_key, merchant_country_code (cloud processor's browser-library URL + public key, and merchant country for wallets)

Account

make_transaction

Response: added optional client_secret (payment-intent secret for browser-confirmed cloud payments)

Customer

make_transaction

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.

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.

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

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.