History

Methods

Try to remove a record and transcription files.

To call this method, make sure your service account has one of the following roles:

See Available Roles

Owner

Admin

DeleteRecord example

Try remove link with record_id is 1.

Parameters

record_id:
number
Optional
The record ID to remove. You can retrieve the record ID via the CallSessionInfoType.records method
record_url:
string
Optional
The record URL to remove. You can retrieve the record URL via the CallSessionInfoType.records method

Returns

result:
number

Downloads the required history report.

Please note, that the history report can return in a compressed state (*.gzip). In order for CURL to process a compressed file correctly, add the --compressed key.

To call this method, make sure your service account has one of the following roles:

See Available Roles

Owner

Admin

Supervisor

Accountant

Payer

Parameters

history_report_id:
number
The history report ID

Returns

file_content:
file
The method returns a raw data, there is no 'file_content' parameter in fact

Downloads the required phone number report.

Please note, that the report can return in a compressed state (.gzip). In order for CURL to process a compressed file correctly, add the "--compressed" key.

To call this method, make sure your service account has one of the following roles:

See Available Roles

Owner

Admin

Support

Supervisor

Developer

Accountant

Payer

PhoneNumberManager

Parameters

report_id:
number
The phone number report ID

Returns

unknown:
unknown
See the HTTP Content-Type header instead

Gets the ACD history.

To call this method, make sure your service account has one of the following roles:

See Available Roles

Owner

Admin

Developer

Supervisor

User manager

GetACDHistory example

Get the two ACD session history records from the 2012-01-01 00:00:00 to the 2014-04-01 00:00:00.

Parameters

acd_queue_id:
intlist
Optional
The ACD queue ID list to filter separated by semicolons (;)
acd_request_id:
stringlist
Optional
The ACD request ID list separated by semicolons (;)
acd_session_history_id:
intlist
Optional
The ACD session history ID list separated by semicolons (;)
count:
number
Optional
Defaults on: 20
The max returning record count
desc_order:
boolean
Optional
Whether to get records in the descent order
from_date:
timestamp
The UTC 'from' date filter in 24-h format: YYYY-MM-DD HH:mm:ss
min_waiting_time:
number
Optional
The min waiting time filter
offset:
number
Optional
Defaults on: 0
The first N records are skipped in the output
operator_hangup:
boolean
Optional
Whether to get the calls terminated by the operator
output:
string
Optional
Defaults on: json
The output format. The following values available: json, csv, xls. The default value is json
rejected:
boolean
Optional
Whether the call is rejected calls by the 'max_queue_size', 'max_waiting_time' threshold
to_date:
timestamp
The UTC 'to' date filter in 24-h format: YYYY-MM-DD HH:mm:ss
unserviced:
boolean
Optional
Whether the call is unserviced by the operator
user_id:
intlist
Optional
The user ID list to filter separated by semicolons (;)
with_events:
boolean
Optional
Defaults on: false
Whether to get the bound events
with_header:
boolean
Optional
Defaults on: true
Whether to get a CSV file with the column names if the output=csv

Returns

count:
number
The returned ACD session count
result:
[ACDSessionInfoType]
total_count:
number
The total found ACD session count

Gets the history of account changes.

To call this method, make sure your service account has one of the following roles:

See Available Roles

Owner

GetAuditLog example

Get the three log items from the 2018-02-01 00:00:00 to the 2018-03-01 00:00:00 and filter.

Parameters

advanced_filters:
string
Optional
A relation ID to filter (for example: a phone_number value, a user_id value, an application_id value)
audit_log_id:
intlist
Optional
The audit history ID list separated by semicolons (;)
count:
number
Optional
Defaults on: 100
The max returning record count
desc_order:
boolean
Optional
Defaults on: false
Whether to get records in the descent order
filtered_admin_user_id:
string
Optional
The admin user ID to filter
filtered_cmd:
stringlist
Optional
The function list separated by semicolons (;) to filter
filtered_ip:
stringlist
Optional
The IP list separated by semicolons (;) to filter
from_date:
timestamp
The UTC 'from' date filter in 24-h format: YYYY-MM-DD HH:mm:ss
offset:
number
Optional
Defaults on: 0
The first N records are skipped in the output
timezone:
string
Optional
Defaults on: Etc/GMT
The selected timezone or the 'auto' value (the account location)
to_date:
timestamp
The UTC 'to' date filter in 24-h format: YYYY-MM-DD HH:mm:ss
with_total_count:
boolean
Optional
Defaults on: false
Whether to include the 'total_count' and increase performance

Returns

count:
number
The returned item count
result:
[AuditLogInfoType]
timezone:
string
The used timezone
total_count:
number
The total found item count

The GetAuditLog asynchronous implementation. Use this function to download a large amounts of data. Take a look at the GetHistoryReports and DownloadHistoryReport functions for downloading details.

To call this method, make sure your service account has one of the following roles:

See Available Roles

Owner

GetAuditLogAsync example

Get the three log items from the 2018-02-01 00:00:00 to the 2018-03-01 00:00:00 and filter.

Parameters

advanced_filters:
string
Optional
A relation ID to filter (for example: a phone_number value, a user_id value, an application_id value)
audit_log_id:
intlist
Optional
The audit history ID list separated by semicolons (;)
desc_order:
boolean
Optional
Defaults on: false
Whether to get records in the descent order
filtered_admin_user_id:
string
Optional
The admin user ID to filter
filtered_cmd:
stringlist
Optional
The function list separated by semicolons (;) to filter
filtered_ip:
stringlist
Optional
The IP list separated by semicolons (;) to filter
from_date:
timestamp
The UTC 'from' date filter in 24-h format: YYYY-MM-DD HH:mm:ss
output:
string
Optional
Defaults on: csv
The output format. The following values available: csv. The default value is csv
timezone:
string
Optional
Defaults on: Etc/GMT
The selected timezone or the 'auto' value (the account location)
to_date:
timestamp
The UTC 'to' date filter in 24-h format: YYYY-MM-DD HH:mm:ss
with_header:
boolean
Optional
Defaults on: true
Whether to get a CSV file with the column names if the output=csv

Returns

history_report_id:
number
The history report ID
result:
number
1

Gets the account's brief call history in the asynchronous mode. Take a look at the GetHistoryReports and DownloadHistoryReport functions for downloading details.

To call this method, make sure your service account has one of the following roles:

See Available Roles

Owner

Admin

Developer

Supervisor

Support

GetBriefCallHistory example

Get the brief call session history from the 2020-02-25 00:00:00 UTC to the 2020-02-26 00:00:00 UTC.

Parameters

application_id:
number
Optional
To receive the call history for a specific application, pass the application ID to this parameter
application_name:
string
Optional
The application name, can be used instead of application_id
call_session_history_custom_data:
string
Optional
To filter the call history by the custom_data passed to the call sessions, pass the custom data to this parameter
call_session_history_id:
intlist
Optional
To get the call history for the specific sessions, pass the session IDs to this parameter separated by a semicolon (;). You can find the session ID in the AppEvents.Started event's sessionID property in a scenario, or retrieve it from the call_session_history_id value returned from the StartScenarios or StartConference methods
desc_order:
boolean
Optional
Defaults on: false
Whether to get records in the descent order
from_date:
timestamp
The from date in the selected timezone in 24-h format: YYYY-MM-DD HH:mm:ss
local_number:
stringlist
Optional
To receive a call history for a specific local numbers, pass the number list separated by semicolons (;). A local number is a number on the platform side
output:
string
The output format. The following values available: csv.
remote_number:
stringlist
Optional
To receive a call history for a specific remote numbers, pass the number list separated by semicolons (;). A remote number is a number on the client side
rule_name:
string
Optional
To receive the call history for a specific routing rule, pass the rule name to this parameter. Applies only if you set application_id or application_name
timezone:
string
Optional
Defaults on: Etc/GMT
The selected timezone or the 'auto' value (the account location)
to_date:
timestamp
The to date in the selected timezone in 24-h format: YYYY-MM-DD HH:mm:ss
with_header:
boolean
Optional
Defaults on: true
Whether to get a CSV file with the column names if the output=csv

Returns

history_report_id:
number
The history report ID
result:
number
1

Gets the account's call history (including call duration, cost, logs and other call information). You can filter the call history by a certain date.

To call this method, make sure your service account has one of the following roles:

See Available Roles

Owner

Admin

Developer

Supervisor

Support

GetCallHistory example

Get the first call session history record with calls and record URLs from the 2020-02-25 00:00:00 UTC to the 2020-02-26 00:00:00 UTC.

Parameters

application_id:
number
Optional
To receive the call history for a specific application, pass the application ID to this parameter
application_name:
string
Optional
The application name, can be used instead of application_id
call_session_history_custom_data:
string
Optional
To filter the call history by the custom_data passed to the call sessions, pass the custom data to this parameter
call_session_history_id:
intlist
Optional
To get the call history for the specific sessions, pass the session IDs to this parameter separated by a semicolon (;). You can find the session ID in the AppEvents.Started event's sessionID property in a scenario, or retrieve it from the call_session_history_id value returned from the StartScenarios or StartConference methods
child_account_id:
intlist
Optional
The child account ID list separated by semicolons (;)
children_calls_only:
boolean
Optional
Defaults on: false
Whether to get the children account calls only
count:
number
Optional
Defaults on: 20
The number of returning records. The maximum value is 1000
desc_order:
boolean
Optional
Defaults on: false
Whether to get records in the descent order
from_date:
timestamp
The from date in the selected timezone in 24-h format: YYYY-MM-DD HH:mm:ss
local_number:
stringlist
Optional
To receive a call history for a specific local numbers, pass the number list separated by semicolons (;). A local number is a number on the platform side
offset:
number
Optional
Defaults on: 0
The number of records to skip in the output. The maximum value of 10000
remote_number:
stringlist
Optional
To receive a call history for a specific remote numbers, pass the number list separated by semicolons (;). A remote number is a number on the client side. Ignored if the remote_number_list parameter is not empty
remote_number_list:
object
Optional
A JS array of strings of specific remote phone numbers to sort the call history. Has higher priority than the remote_number parameter. If the array is empty, the remote_number parameter is used instead
rule_name:
string
Optional
To receive the call history for a specific routing rule, pass the rule name to this parameter. Applies only if you set application_id or application_name
timezone:
string
Optional
Defaults on: Etc/GMT
The selected timezone or the 'auto' value (the account location)
to_date:
timestamp
The to date in the selected timezone in 24-h format: YYYY-MM-DD HH:mm:ss
user_id:
intlist
Optional
To receive the call history for a specific users, pass the user ID list separated by semicolons (;). If it is specified, the output contains the calls from the listed users only
with_calls:
boolean
Optional
Defaults on: false
Whether to receive a list of sessions with all calls within the sessions, including phone numbers, call cost and other information
with_other_resources:
boolean
Optional
Defaults on: true
Whether to get other resources usage (see ResourceUsageType)
with_records:
boolean
Optional
Defaults on: false
Whether to get the calls' records
with_total_count:
boolean
Optional
Defaults on: true
Whether to include the 'total_count' and increase performance

Returns

count:
number
The returned call session count
result:
[CallSessionInfoType]
The CallSessionInfoType records
timezone:
string
The used timezone
total_count:
number
The total found call session count

The GetCallHistory asynchronous implementation. Use this function to download a large amounts of data. Take a look at the GetHistoryReports and DownloadHistoryReport functions for downloading details.

To call this method, make sure your service account has one of the following roles:

See Available Roles

Owner

Admin

Developer

Supervisor

Support

GetCallHistoryAsync example

Get the first call session history record with calls and record URLs from the 2020-02-25 00:00:00 UTC to the 2020-02-26 00:00:00 UTC.

Parameters

application_id:
number
Optional
To receive the call history for a specific application, pass the application ID to this parameter
application_name:
string
Optional
The application name, can be used instead of application_id
call_session_history_custom_data:
string
Optional
To filter the call history by the custom_data passed to the call sessions, pass the custom data to this parameter
call_session_history_id:
intlist
Optional
To get the call history for the specific sessions, pass the session IDs to this parameter separated by a semicolon (;). You can find the session ID in the AppEvents.Started event's sessionID property in a scenario, or retrieve it from the call_session_history_id value returned from the StartScenarios or StartConference methods
child_account_id:
intlist
Optional
The child account ID list separated by semicolons (;)
children_calls_only:
boolean
Optional
Defaults on: false
Whether to get the children account calls only
desc_order:
boolean
Optional
Defaults on: false
Whether to get records in the descent order
from_date:
timestamp
The from date in the selected timezone in 24-h format: YYYY-MM-DD HH:mm:ss
local_number:
stringlist
Optional
To receive a call history for a specific local numbers, pass the number list separated by semicolons (;). A local number is a number on the platform side
output:
string
Optional
Defaults on: csv
The output format. The following values available: csv. The default value is csv
remote_number:
stringlist
Optional
To receive a call history for a specific remote numbers, pass the number list separated by semicolons (;). A remote number is a number on the client side
rule_name:
string
Optional
To receive the call history for a specific routing rule, pass the rule name to this parameter. Applies only if you set application_id or application_name
timezone:
string
Optional
Defaults on: Etc/GMT
The selected timezone or the 'auto' value (the account location)
to_date:
timestamp
The to date in the selected timezone in 24-h format: YYYY-MM-DD HH:mm:ss
user_id:
intlist
Optional
To receive the call history for a specific users, pass the user ID list separated by semicolons (;). If it is specified, the output contains the calls from the listed users only
with_calls:
boolean
Optional
Defaults on: false
Whether to receive a list of sessions with all calls within the sessions, including phone numbers, call cost and other information
with_header:
boolean
Optional
Defaults on: true
Whether to get a CSV file with the column names if the output=csv
with_other_resources:
boolean
Optional
Defaults on: true
Whether to get other resources usage (see ResourceUsageType)
with_records:
boolean
Optional
Defaults on: false
Whether to get the calls' records

Returns

history_report_id:
number
The history report ID
result:
number
1

Gets the list of history reports and their statuses. The method returns info about the reports made via GetCallHistoryAsync, GetTransactionHistoryAsync, GetAuditLogAsync and GetBriefCallHistory asynchronous methods. Note that the file_size field in response is valid only for the video calls.

To call this method, make sure your service account has one of the following roles:

See Available Roles

Owner

Admin

Developer

Supervisor

Accountant

Support

Payer

GetHistoryReports example

Get all the reports.

Parameters

application_id:
intlist
Optional
The application ID to filter. Can be a list separated by semicolons (;). Use the 'all' value to select all applications
count:
number
Optional
Defaults on: 20
The max returning record count
created_from:
timestamp
Optional
The UTC creation from date filter in 24-h format: YYYY-MM-DD HH:mm:ss
created_to:
timestamp
Optional
The UTC creation to date filter in 24-h format: YYYY-MM-DD HH:mm:ss
desc_order:
boolean
Optional
Defaults on: false
Whether to get records in the descent order
history_report_id:
number
Optional
The history report ID to filter
history_type:
stringlist
Optional
Defaults on: calls
The history report type list separated by semicolons (;). Use the 'all' value to select all history report types. The following values are possible: calls, calls_brief, transactions, audit, call_list, transactions_on_hold
is_completed:
boolean
Optional
Whether the report is completed
offset:
number
Optional
Defaults on: 0
The first N records are skipped in the output

Returns

count:
number
The returned reports count
result:
[HistoryReportType]
total_count:
number
The total found reports count

Receives information about the created phone numbers report or list of reports.

To call this method, make sure your service account has one of the following roles:

See Available Roles

Owner

Admin

Developer

Supervisor

Accountant

Support

Payer

PhoneNumberManager

GetPhoneNumberReports example

Get all the reports.

Parameters

count:
number
Optional
Defaults on: 20
The max returning record count
created_from:
timestamp
Optional
The UTC creation from date filter in 24-h format: YYYY-MM-DD HH:mm:ss
created_to:
timestamp
Optional
The UTC creation to date filter in 24-h format: YYYY-MM-DD HH:mm:ss
desc_order:
boolean
Optional
Defaults on: false
Whether to get records in the descent order
is_completed:
boolean
Optional
Whether the report is completed
offset:
number
Optional
Defaults on: 0
The first N records are skipped in the output
report_id:
number
Optional
The phone number report ID to filter
report_type:
stringlist
Optional
Defaults on: calls
The phone number report type list separated by semicolons (;). Use the 'all' value to select all history report types. The following values are possible: calls, calls_brief, transactions, audit, call_list, transactions_on_hold

Returns

count:
number
The returned reports count
result:
[CommonReportType]
total_count:
number
The total found reports count

Gets the transaction history.

To call this method, make sure your service account has one of the following roles:

See Available Roles

Owner

Admin

Accountant

Payer

GetTransactionHistory example

Get the three transactions record from the 2012-01-01 00:00:00 UTC to the 2014-01-01 00:00:00 UTC with the 'gift' or 'money_distribution' types.

Parameters

child_account_id:
intlist
Optional
The child account ID list separated by semicolons (;). Use the 'all' value to select all child accounts
children_transactions_only:
boolean
Optional
Defaults on: false
Whether to get the children account transactions only
count:
number
Optional
Defaults on: 20
The number of returning records. The maximum value is 1000
desc_order:
boolean
Optional
Whether to get records in the descent order
from_date:
timestamp
The from date in the selected timezone in 24-h format: YYYY-MM-DD HH:mm:ss
is_uncommitted:
boolean
Optional
Defaults on: false
Whether to get transactions on hold (transactions for which money is reserved but not yet withdrawn from the account)
offset:
number
Optional
Defaults on: 0
The number of records to skip in the output with a maximum value of 10000
timezone:
string
Optional
Defaults on: Etc/GMT
The selected timezone or the 'auto' value (the account location)
to_date:
timestamp
The to date in the selected timezone in 24-h format: YYYY-MM-DD HH:mm:ss
transaction_id:
intlist
Optional
The transaction ID list separated by semicolons (;)
transaction_type:
stringlist
Optional
The transaction type list separated by semicolons (;). The following values are possible: gift_revoke, resource_charge, money_distribution, subscription_charge, subscription_installation_charge, card_periodic_payment, card_overrun_payment, card_payment, rub_card_periodic_payment, rub_card_overrun_payment, rub_card_payment, robokassa_payment, gift, promo, adjustment, wire_transfer, us_wire_transfer, refund, discount, mgp_charge, mgp_startup, mgp_business, mgp_big_business, mgp_enterprise, mgp_large_enterprise, techsupport_charge, tax_charge, monthly_fee_charge, grace_credit_payment, grace_credit_provision, mau_charge, mau_overrun, im_charge, im_overrun, fmc_charge, sip_registration_charge, development_fee, money_transfer_to_child, money_transfer_to_parent, money_acceptance_from_child, money_acceptance_from_parent, phone_number_installation, phone_number_charge, toll_free_phone_number_installation, toll_free_phone_number_charge, services, user_money_transfer, paypal_payment, paypal_overrun_payment, paypal_periodic_payment
user_id:
intlist
Optional
The user ID list separated by semicolons (;)
users_transactions_only:
boolean
Optional
Defaults on: false
Whether to get the users' transactions only
with_total_count:
boolean
Optional
Defaults on: false
Whether to include the 'total_count' and increase performance

Returns

count:
number
The returned transaction count
result:
[TransactionInfoType]
timezone:
string
The used timezone. 'Etc/GMT' for example
total_count:
number
The total found transaction count

The GetTransactionHistory asynchronous implementation. Use this function to download a large amounts of data. Take a look at the GetHistoryReports and DownloadHistoryReport functions for downloading details.

To call this method, make sure your service account has one of the following roles:

See Available Roles

Owner

Admin

Accountant

Payer

GetTransactionHistoryAsync example

Get the three transactions record from the 2012-01-01 00:00:00 UTC to the 2014-01-01 00:00:00 UTC with the 'gift' or 'money_distribution' types.

Parameters

child_account_id:
intlist
Optional
The child account ID list separated by semicolons (;). Use the 'all' value to select all child accounts
children_transactions_only:
boolean
Optional
Defaults on: false
Whether to get the children account transactions only
desc_order:
boolean
Optional
Whether to get records in the descent order
from_date:
timestamp
The from date in the selected timezone in 24-h format: YYYY-MM-DD HH:mm:ss
is_uncommitted:
boolean
Optional
Defaults on: false
Whether to get transactions on hold (transactions for which money is reserved but not yet withdrawn from the account)
output:
string
Optional
Defaults on: csv
The output format. The following values available: csv. The default value is csv
timezone:
string
Optional
Defaults on: Etc/GMT
The selected timezone or the 'auto' value (the account location)
to_date:
timestamp
The to date in the selected timezone in 24-h format: YYYY-MM-DD HH:mm:ss
transaction_id:
intlist
Optional
The transaction ID list separated by semicolons (;)
transaction_type:
stringlist
Optional
The transaction type list separated by semicolons (;). The following values are possible: gift_revoke, resource_charge, money_distribution, subscription_charge, subscription_installation_charge, card_periodic_payment, card_overrun_payment, card_payment, rub_card_periodic_payment, rub_card_overrun_payment, rub_card_payment, robokassa_payment, gift, promo, adjustment, wire_transfer, us_wire_transfer, refund, discount, mgp_charge, mgp_startup, mgp_business, mgp_big_business, mgp_enterprise, mgp_large_enterprise, techsupport_charge, tax_charge, monthly_fee_charge, grace_credit_payment, grace_credit_provision, mau_charge, mau_overrun, im_charge, im_overrun, fmc_charge, sip_registration_charge, development_fee, money_transfer_to_child, money_transfer_to_parent, money_acceptance_from_child, money_acceptance_from_parent, phone_number_installation, phone_number_charge, toll_free_phone_number_installation, toll_free_phone_number_charge, services, user_money_transfer, paypal_payment, paypal_overrun_payment, paypal_periodic_payment
user_id:
intlist
Optional
The user ID list separated by semicolons (;)
users_transactions_only:
boolean
Optional
Defaults on: false
Whether to get the users' transactions only
with_header:
boolean
Optional
Defaults on: true
Whether to get a CSV file with the column names if the output=csv

Returns

history_report_id:
number
The history report ID
result:
number
1

Methods

DeleteRecord

DeleteRecord example

Parameters

record_id:

record_url:

Returns

result:

DownloadHistoryReport

Parameters

history_report_id:

Returns

file_content:

DownloadPhoneNumberReport

Parameters

report_id:

Returns

unknown:

GetACDHistory

GetACDHistory example

Parameters

acd_queue_id:

acd_request_id:

acd_session_history_id:

count:

desc_order:

from_date:

min_waiting_time:

offset:

operator_hangup:

output:

rejected:

to_date:

unserviced:

user_id:

with_events:

with_header:

Returns

count:

result:

total_count:

GetAuditLog

GetAuditLog example

Parameters

advanced_filters:

audit_log_id:

count:

desc_order:

filtered_admin_user_id:

filtered_cmd:

filtered_ip:

from_date:

offset:

timezone:

to_date:

with_total_count:

Returns

count:

result:

timezone:

total_count:

GetAuditLogAsync

GetAuditLogAsync example

Parameters

advanced_filters:

audit_log_id:

desc_order:

filtered_admin_user_id:

filtered_cmd:

filtered_ip:

from_date:

output:

timezone:

to_date:

with_header:

Returns

history_report_id:

result:

GetBriefCallHistory

GetBriefCallHistory example