History

Methods

Gets the call history.

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

from_date:
timestamp
The from date in the selected timezone in 24-h format: YYYY-MM-DD HH:mm:ss
to_date:
timestamp
The to date in the selected timezone in 24-h format: YYYY-MM-DD HH:mm:ss
timezone:
string
Optional
Defaults on: Etc/GMT
The selected timezone or the 'auto' value (the account location)
call_session_history_id:
intlist
Optional
The call session history ID list separated by the ';' symbol. The sessions IDs can be accessed in JS scenario via the sessionID property of the AppEvents.Started event
application_id:
number
Optional
The application ID
application_name:
string
Optional
The application name, can be used instead of application_id
user_id:
intlist
Optional
The user ID list separated by the ';' symbol. If it's specified, the output will contain the calls from the listed users only
rule_name:
string
Optional
The rule name to filter. Will be applied only if you set application_id or application_name
remote_number:
stringlist
Optional
The remote number list separated by the ';' symbol
local_number:
stringlist
Optional
The local number list separated by the ';' symbol
call_session_history_custom_data:
string
Optional
The custom_data to filter sessions
with_calls:
boolean
Optional
Defaults on: false
Set true to get the bound calls
with_records:
boolean
Optional
Defaults on: false
Set true to get the bound records
with_other_resources:
boolean
Optional
Defaults on: true
Set true to get other resources usage (see ResourceUsageType)
child_account_id:
intlist
Optional
The child account ID list separated by the ';' symbol. Use the 'all' value to select all child accounts
children_calls_only:
boolean
Optional
Defaults on: false
Set true to get the children account calls only
with_header:
boolean
Optional
Defaults on: true
Set false to get a CSV file without the column names if the output=csv
desc_order:
boolean
Optional
Defaults on: false
Set true to get records in the descent order
with_total_count:
boolean
Optional
Defaults on: true
Set false to omit the 'total_count' and increase performance
count:
number
Optional
Defaults on: 20
Number of returning records with a maximum value of 1000
offset:
number
Optional
Defaults on: 0
The first N records will be skipped in the output
output:
string
Optional
Defaults on: json
The output format. The following values available: json, csv
is_async:
boolean
Optional
Defaults on: false
Set true to get records in the asynchronous mode (for csv output only). If it's true, the request is available via GetHistoryReports and DownloadHistoryReport methods

Returns

result:
[CallSessionInfoType]
The CallSessionInfoType records in sync mode or 1 in async mode
total_count:
number
The total found call session count (sync mode)
count:
number
The returned call session count (sync mode)
timezone:
string
The used timezone
history_report_id:
number
The history report ID (async mode)

Gets the list of history reports and their statuses. The method returns info about reports made via GetCallHistory with the specified output=csv and is_async=true parameters. Note that the file_size field in response is valid only for video calls.

GetHistoryReports example

Get all the reports.

Parameters

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 the ';' symbol. Use the 'all' value to select all history report types. The following values are possible: calls, transactions, audit, call_list
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
is_completed:
boolean
Optional
Report is completed
desc_order:
boolean
Optional
Defaults on: false
Set true to get records in the descent order
count:
number
Optional
Defaults on: 20
The max returning record count
offset:
number
Optional
Defaults on: 0
The first N records will be skipped in the output
application_id:
intlist
Optional
The application ID to filter. Can be a list separated by the ';' symbol. Use the 'all' value to select all applications

Returns

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

Downloads the required history report.

Parameters

history_report_id:
number
The history report ID

Returns

unknown:
unknown
See the HTTP Content-Type header instead

Gets the transaction history.

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

from_date:
timestamp
The from date in the selected timezone in 24-h format: YYYY-MM-DD HH:mm:ss
to_date:
timestamp
The to date in the selected timezone in 24-h format: YYYY-MM-DD HH:mm:ss
timezone:
string
Optional
Defaults on: Etc/GMT
The selected timezone or the 'auto' value (the account location)
transaction_id:
intlist
Optional
The transaction ID list separated by the ';' symbol
transaction_type:
stringlist
Optional
The transaction type list separated by the ';' symbol. The following values are possible: 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
user_id:
intlist
Optional
The user ID list separated by the ';' symbol
child_account_id:
intlist
Optional
The child account ID list separated by the ';' symbol. Use the 'all' value to select all child accounts
children_transactions_only:
boolean
Optional
Defaults on: false
Set true to get the children account transactions only
users_transactions_only:
boolean
Optional
Defaults on: false
Set true to get the users' transactions only
desc_order:
boolean
Optional
Set true to get records in the descent order
count:
number
Optional
Defaults on: 20
The max returning record count
offset:
number
Optional
Defaults on: 0
The first N records will be skipped in the output
output:
string
Optional
Defaults on: json
The output format. The following values available: json, csv
is_async:
boolean
Optional
Defaults on: false
Set true to get records in the asynchronous mode (for csv output only). See the GetHistoryReports, DownloadHistoryReport functions

Returns

result:
[TransactionInfoType]
total_count:
number
The total found transaction count
timezone:
string
The used timezone. 'Etc/GMT' for example
count:
number
The returned transaction count
history_report_id:
number
The history report ID (async mode)

Try to remove record and transcription files.

DeleteRecord example

Try remove link with record_id is 1.

Parameters

record_url:
string
Optional
Url to remove
record_id:
number
Optional
The record id for remove

Returns

result:
number

Gets the ACD history.

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

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

Returns

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

Gets the history of account changes.

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

from_date:
timestamp
The UTC 'from' date filter in 24-h format: YYYY-MM-DD HH:mm:ss
to_date:
timestamp
The UTC 'to' date filter in 24-h format: YYYY-MM-DD HH:mm:ss
timezone:
string
Optional
Defaults on: Etc/GMT
The selected timezone or the 'auto' value (the account location)
audit_log_id:
intlist
Optional
The audit history ID list separated by the ';' symbol
filtered_admin_user_id:
string
Optional
The admin user ID to filter
filtered_ip:
stringlist
Optional
The IP list separated by the ';' symbol to filter
filtered_cmd:
stringlist
Optional
The function list separated by the ';' symbol to filter
advanced_filters:
string
Optional
A relation ID to filter (for example: a phone_number value, a user_id value, an application_id value)
with_header:
boolean
Optional
Defaults on: true
Set false to get a CSV file without the column names if the output=csv
desc_order:
boolean
Optional
Defaults on: false
Set true to get records in the descent order
with_total_count:
boolean
Optional
Defaults on: false
Set false to omit the 'total_count' and increase performance
count:
number
Optional
Defaults on: 100
The max returning record count
offset:
number
Optional
Defaults on: 0
The first N records will be skipped in the output
output:
string
Optional
Defaults on: json
The output format. The following values available: json, csv
is_async:
boolean
Optional
Defaults on: false
Set true to get records in the asynchronous mode (for csv output only). If it's true, the request is available via GetHistoryReports and DownloadHistoryReport methods

Returns

result:
[AuditLogInfoType]
total_count:
number
The total found item count
count:
number
The returned item count
timezone:
string
The used timezone
history_report_id:
number
The history report ID (async mode)

Methods

GetCallHistory

GetCallHistory example

Parameters

from_date:

to_date:

timezone:

call_session_history_id:

application_id:

application_name:

user_id:

rule_name:

remote_number:

local_number:

call_session_history_custom_data:

with_calls:

with_records:

with_other_resources:

child_account_id:

children_calls_only:

with_header:

desc_order:

with_total_count:

count:

offset:

output:

is_async:

Returns

result:

total_count:

count:

timezone:

history_report_id:

GetHistoryReports

GetHistoryReports example

Parameters

history_report_id:

history_type:

created_from:

created_to:

is_completed:

desc_order:

count:

offset:

application_id:

Returns

result:

total_count:

count:

DownloadHistoryReport

Parameters

history_report_id:

Returns

unknown:

GetTransactionHistory

GetTransactionHistory example

Parameters

from_date:

to_date:

timezone:

transaction_id:

transaction_type:

user_id:

child_account_id:

children_transactions_only:

users_transactions_only:

desc_order:

count:

offset:

output:

is_async:

Returns

result:

total_count:

timezone:

count:

history_report_id:

DeleteRecord

DeleteRecord example

Parameters