Release MR103

Account

get_mailbox_message_list

New method, specification HLD/LLD - Access mailbox files via API. No input parameters.

Get the email list of the account.

Account

get_mailbox_message_details

New method, specification HLD/LLD - Access mailbox files via API.

Get email details.

Account

get_mailbox_message_attachment

New method, specification HLD/LLD - Access mailbox files via API.

Get the attachment of the email.

Email can have 2 types: 'voicemail' and 'fax'. Types are taken from 'X-PortaOne-VM-Type' message header (should be added to the message by SIP). In general user should get any email attachment by message id only by the POST method. HEAD and GET methods required to provide streams (chunks of audio file).

For voicemail type messages format 'mp3', 'wav' or 'au' of the provisioned file can be specified.

Method supports 3 HTTP method names: HEAD, GET and POST with different behavior.

HEAD (stream, for audio files): response contain attachment content-length and content-type header, no body.

GET (stream, for audio files): response body contain chunk of the attachment (audio file), requested by Range header.

POST (for audio files and fax types like 'pdf' and 'tiff'): response body contain attachment.

Account

set_mailbox_messages_flag

New method, specification HLD/LLD - Access mailbox files via API.

Mark messages by the flag.

Account

delete_mailbox_messages

New method, specification HLD/LLD - Access mailbox files via API.

Delete the specified messages from the mailbox.

Customer

get_vd_counter_aggregate_history

New method, Use Cases - History of combined quota consumption  Returns the VD Counters data, aggregated per day.

BillingSession

Add call type to the response.
A new key is called "call_type" and the possible values are: incoming, outgoing, forwarded.

BillingSession

actual param may confuse users so it was marked as deprecated.

Replaced with include_recently_finished.

If include_recently_finished is provided actual is ignored.

Default behavior (ongoing calls only) wasn't changed.

IPTV

get_channel_package_list

get_service_package_list

query field was dropped from i_channel_package_filter_list and i_service_package_filter_list params (the filter was a no-op)

Account

get_account_list

Method is available for Distributor realm.

i_distributor field was added to request params.

When the method is executed by the distributor, this value (i_distributor ) is pre-set by the system.

TraceSession

get_log_info

session_type field was added to SessionLogMetaInfo 

DID

get_number_info

add_number

update_number

Add activation_date, allocation_date, canceled, expiration_date, i_did_provider, preserve_i_do_batch, reseller_i_do_batch fields to DIDNumberInfo structure

DID_Provider

obtain_number

Add activation_date, allocation_date, canceled, expiration_date, i_did_provider, preserve_i_do_batch, reseller_i_do_batch fields to DIDNumberInfo structure

Account

Customer

get_subscriptions

effective_fee and next_effective_fee fields were deprecated.

The next structure was added:

effective_fees_info => {
    current => {
        amount           => 30,
        charged_to       => '2022-10-01',
        included_periods => 3,
    },
    next => {...}
}

Customer

get_subscriptions

Added missed monthly_fee response field.

Customer

update_taxation

get_taxation_info

Added possibility to set/get taxation_info.options_generic_vat_gst (TaxationOptionsGenericVATGST structure) if appropriate taxation plugin is set for customer

CustomerClass

update_taxation

get_taxation_info

Added possibility to set/get taxation_info.options_generic_vat_gst (TaxationOptionsGenericVATGST structure) if appropriate taxation plugin is set for customer class

Invoice

get_invoice_info

get_invoice_list

Extended InvoiceInfo structure with a new tax_adjustments field

Invoice

apply_invoice_adjustment

Extended ApplyInvoiceAdjustmentRequest structure with a new tax_amount input field

Customer

add_callqueue
update_callqueue
get_callqueue_info
get_callqueue_list

Added dispatch_to_busy_agents field to CallQueues create, read, update methods

Metric

get_system_metric_data

Add Reseller realm support.

Available metrics for reseller are:

system_load.cc_staff.refunded_today

system_load.cc_staff.refunds_counter

system_load.cc_staff.search_counter

DID

get_customer_numbers

get_number_info

release_number

reserve_number

Update 'number' data type back to string

AccessControl

set_mfa
generate_mfa_config
confirm_mfa_config
reset_mfa_config
get_mfa_config

New methods, HLD/LLD - Google two-factor authentication for self-care access

Control the multi-factor authentication configuration.

AccessControl

verify_otp

Method moved from internal to public.

Session

login

Customer

add_customer_extension

New extensions created by branch customer are linked to headquarters

Customer

update_customer_extension
delete_customer_extension

Added ability to update/delete extensions whose account belongs to branch customer

Customer

add_customer_huntgroup

Branch customers are prohibited from creating their own HG

Generic

get_config_data

Genericapply_invoice_adjustment

get_api_schema

get_internal_api_schema

Invoice

apply_invoice_adjustment

CodecConverter

get_file

Customer

update_taxation

get_taxation_info

IVRApplications

get_access_number_list

IVRApplications

get_ivr_application_list

Added 'number' field into GetIvrApplicationListRequest structure.
Input parameter number_pattern is marked as deprecated and will be removed in future releases.