VoximplantAPI

optional

Maximum number of resulting rows fetched. Must be not bigger than 1000. If left blank, then the default value of 1000 is used

optional

The delivery status ID: QUEUED - 1, DISPATCHED - 2, ABORTED - 3, REJECTED - 4, DELIVERED - 5, FAILED - 6, EXPIRED - 7, UNKNOWN - 8

optional

The destination phone number

optional

Date from which the search is to start. Format is ‘yyyy-MM-dd HH:mm:ss’, time zone is UTC

optional

The first N records are skipped in the output

optional

The output format. The following values available: json, csv, xls. The default value is json

optional

The source phone number

optional

Date from which the search is to end. Format is ‘yyyy-MM-dd HH:mm:ss’, time zone is UTC

optional

Total number of messages matching the query parameters

The destination phone numbers separated by semicolons (;). The maximum number of these phone numbers is 100

The SenderID for outgoing SMS. Please contact support for installing a SenderID

optional

Whether to store outgoing message texts. Default value is false

The message text, up to 1600 characters. We split long messages greater than 160 GSM-7 characters or 70 UTF-16 characters into multiple segments. Each segment is charged as one message

optional

The number of fragments the message is divided into

The message cost

Delivery status: QUEUED, DISPATCHED, ABORTED, REJECTED, DELIVERED, FAILED, EXPIRED, UNKNOWN

SMS destination number

optional

Error message (if any)

Number of fragments the initial message is divided into

Message ID

Date of message processing. The format is yyyy-MM-dd HH:mm:ss

SMS source number

The message status. The possible values are: 1 — Success, 2 — Error, 3 — Waiting

optional

Stored message text

The transaction ID for this message

optional

Whether to activate one-way SMS

optional

The allowed access entries (the API function names)

optional

The custom data

The account’s email

optional

The first name

The account’s ID

optional

The last name

The account’s name

optional

Whether Voximplant notifications are required

Whether the account is active

optional

The account API key. Use password or api_key authentication to show the api_key

optional

The account’s money

optional

The office address

optional

The billing address country code (2 symbols, ISO 3166-1 alpha-2). Examples: US, RU, GB

optional

The company or businessman name

optional

The office phone number

optional

The office state (US) or province (Canada), up to 100 characters. Examples: California, Illinois, British Columbia

optional

The office ZIP

optional

The payments limits applicable to each payment method

optional

If salt string is specified, each HTTP request made by the Voximplant cloud toward the callback_url has a salt field set to MD5 hash of account information and salt. That hash can be used be a developer to ensure that HTTP request is made by the Voximplant cloud

optional

If URL is specified, Voximplant cloud makes HTTP POST requests to it when something happens. For a full list of reasons see the type field of the AccountCallback structure. The HTTP request has a JSON-encoded body that conforms to the AccountCallbacks structure

The UTC account created time in 24-h format: YYYY-MM-DD HH:mm:ss

optional

The account’s credit limit

optional

The currency code (USD, RUR, EUR, …)

optional

Whether account is blocked by Voximplant admins

optional

The notification language code (2 symbols, ISO639-1). Examples: en, ru

optional

The account location (timezone). Examples: America/Los_Angeles, Etc/GMT-8, Etc/GMT+10

optional

The min balance value to notify by email or SMS

optional

Whether Voximplant news notifications are required

optional

Whether to send an email when a JS error occurs

optional

Whether Bank card payments are allowed

optional

Whether Bank invoices are allowed

optional

Whether Robokassa payments are allowed

optional

Whether Voximplant plan changing notifications are required

optional

Whether the admin user permissions are granted

Info on all money spent in the invoice

Date when the invoice is created in the following format: YYYY-MM-DD

Invoice id

Unique invoice number

Invoice period

Detailed info on each spending

Invoice status

Gets the account’s info such as account_id, account_name, account_email etc.

Gets the exchange rate on selected date (per USD).

optional

The operator status string

The display user name of the operator

The user ID of the operator

The user name of the operator

The UTC lock created time in 24-h format: YYYY-MM-DD HH:mm:ss

The ACD lock ID

optional

The ACD operator calls

optional

The operator locks

optional

The operator status string. ‘BANNED’ string indicates temporarily banned operators. The following values are possible: READY, BANNED

optional

The UTC time when the operator becomes unavailable in 24-h format: YYYY-MM-DD HH:mm:ss

The display user name of the operator

The user ID of the operator

The user name of the operator

The ACD queue ID

The ACD queue name

The internal ACD session history ID

The ACD session history ID of the request

The begin time of the request in 24-h format: YYYY-MM-DD HH:mm:ss

optional

The client callerid

optional

The submission time of the request in 24-h format: YYYY-MM-DD HH:mm:ss

The ACD queue ID

The ACD queue name

Whether the user is bound to the ACD queue in manual mode if false

The ACD queue ID

Number of operators with the ‘AFTER SERVICE’ state

List of operators with the ‘AFTER_SERVICE’ state. This state is set right after a call is ended to indicate a call postprocessing

List of operators with the ‘READY’ state that cannot accept a call from this queue. Operator cannot accept a call if they are temporarily banned, or they are servicing a call right now

Number of locked operators

List of operators with the ‘READY’ state that can accept a call from this queue

Number of ready operators

List of calls enqueued into this queue that are being serviced right now by operators

List of calls enqueued into this queue that are not yet serviced by operators

The idle duration in seconds. The minimum of the duration after the last hangup and the duration after the operator status changing to READY

The display user name of the operator

The user ID of the operator

The user name of the operator

The ACD session history ID of the request

The begin time of the request in 24-h format: YYYY-MM-DD HH:mm:ss

optional

The client callerid

The request priority

The display user name of the operator

The user ID of the operator

The user name of the operator

The waiting time before servicing in seconds

The queues’ states

The ACD session history ID of the request

The begin time of the request in 24-h format: YYYY-MM-DD HH:mm:ss

optional

The client callerid

The predicted minutes left to start servicing

The request priority

The display user name of the operator

optional

The user ID of the operator to try to service the request

The user name of the operator

The waiting time in seconds

The verification code, see the VerifyOutboundTestPhoneNumber function

optional

Returns 1 if the request has been completed successfully

optional

Whether the admin role is enabled. If false the allowed and denied entries have no affect

The admin role name. The length must be less than 50

optional

The list of allowed access entries separated by semicolons (;) (the API function names)

optional

The list of denied access entries separated by semicolons (;) (the API function names)

optional

The admin role ID list separated by semicolons (;). Use the ‘all’ value to select all admin roles. The list specifies the roles from which the new role automatically copies all permissions (allowed_entries and denied_entries)

optional

The admin role name that can be used instead of like_admin_role_id. The name specifies a role from which the new role automatically copies all permissions (allowed_entries and denied_entries)

The new admin role ID

optional

Returns 1 if the request has been completed successfully

optional

The role(s) ID created via Managing Admin Roles methods. The attaching admin role ID list separated by semicolons (;). Use the ‘all’ value to select all admin roles

optional

The role(s) name(s) created via Managing Admin Roles methods. The attaching admin role name that can be used instead of admin_role_id

optional

Whether the admin user is active

The admin user display name. The length must be less than 256

The admin user name. The length must be less than 50

The admin user password. The length must be at least 6 symbols

The admin user API key

The new admin user ID

optional

Returns 1 if the request has been completed successfully

Short application name in the [a-z][a-z0-9-]{1,64} format

optional

Whether to enable secure storage for all logs and records of the application

The application ID

The full application name

optional

Returns 1 if the request has been completed successfully

Whether a secure storage for logs and records is enabled or not

optional

Whether to remove the IP from the blacklist

The authorized IP4 or network

optional

The IP address description

optional

Returns 1 if the request has been completed successfully

The personal phone number in the E.164 format

optional

Returns 1 if the request has been completed successfully

The phone number in format e164 or regex pattern

optional

The PSTN black list item ID

Returns 1 if the request has been completed successfully

The queue name. The length must be less than 100

optional

The integer queue priority. The highest priority is 0

The application ID

The application name that can be used instead of application_id

optional

Whether to enable the auto binding of operators to a queue by skills comparing

optional

The average service time in seconds. Specify the parameter to correct or initialize the waiting time prediction

optional

The max queue size

optional

The max predicted waiting time in minutes. The client is rejected if the predicted waiting time is greater than the max predicted waiting time

optional

The value in the range of [0.5 … 1.0]. The value 1.0 means the service probability 100% in challenge with a lower priority queue

The ACD queue ID

optional

Returns 1 if the request has been completed successfully

Application ID to add the secret to

Application name. Can be used instead of application_id

optional

Optional. Secret description. When processing, the length is truncated to the first 200 characters

Secret name. The name must start with a Latin letter and can contain up to 64 characters, including Latin letters, digits and underscores

Secret value. Maximum length is 8192 characters

optional

Result with the added secret ID

Added secret ID

optional

The network address description

The network address in format A.B.C.D/L or A.B.C.D/a.b.c.d (example 192.168.1.5/16)

optional

Returns 1 if the request has been completed successfully

The SIP white list item ID

The ACD operator skill name. The length must be less than 512

optional

Returns 1 if the request has been completed successfully

The skill ID

The application ID which a new user is to be bound to. Can be used instead of the application_name parameter

The application name which a new user is to be bound to. Can be used instead of the application_id parameter

optional

optional

Whether the user uses the parent account’s money, ‘false’ if the user has a separate balance

optional

Whether the user is active. Inactive users cannot log in to applications

optional

Any string

The user display name. The length must be less than 256

The user name in format [a-z0-9][a-z0-9_-]{2,49}

The user password. Must be at least 8 characters long and contain at least one uppercase and lowercase letter, one number, and one special character

optional

Returns 1 if the request has been completed successfully

The new user ID

Whether to ignore the allowed and denied entries

The admin role ID

The admin role name

optional

The allowed access entries (the API function names)

optional

The denied access entries (the API function names)

The admin role editing UTC date in 24-h format: YYYY-MM-DD HH:mm:ss

Whether it is a system role

Adds a new admin role.

Deletes the specified admin role.

Gets the admin roles.

Gets the all available admin role entries.

Edits the specified admin role.

optional

The allowed access entries (the API function names)

optional

The attached admin roles

Whether login is allowed

The admin user display name

The admin user ID

The admin user name

The admin user editing UTC date in 24-h format: YYYY-MM-DD HH:mm:ss

Adds a new admin user into the specified parent or child account.

Attaches the admin role(s) to the already existing admin(s).

Deletes the specified admin user.

Gets the admin users of the specified account. Note that both account types - parent and child - can have its own admins.

Edits the specified admin user.

The error code

The error description

optional

Separator values. The default value is ’;’

optional

Encoding file. The default value is UTF-8

optional

Escape character for parsing csv

Send as the request body or multiform

Call list ID

Batch UUID

Number of stored records

optional

List ID

Whether the request completed successfully

The application ID

The full application name

The application editing UTC date in 24-h format: YYYY-MM-DD HH:mm:ss

Whether a secure storage for logs and records is enabled

Adds a new account’s application.

Deletes the account’s application.

Gets the account’s applications.

Edits the account’s application.

The role(s) ID created via Managing Admin Roles methods. The attached admin role ID list separated by semicolons (;). Use the ‘all’ value to select alladmin roles

The role(s) name(s) created via Managing Admin Roles methods. The admin role name to attach, can be used instead of admin_role_id

optional

The merge mode. The following values are possible: add, del, set

The admin user ID list separated by semicolons (;). Use the ‘all’ value to select all admin users

The admin user name to bind, can be used instead of required_admin_user_id

optional

Returns 1 if the request has been completed successfully

optional

Phone number activation status

optional

ID of the bound application

optional

Name of the bound application

Whether to charge automatically

Whether a not verified account can use the phone

Whether the subscription is cancelled

The phone category name (MOBILE, GEOGRAPHIC, TOLLFREE, MOSCOW495)

Whether the subscription is frozen

Whether calls to emergency numbers are enabled

Whether you need to make a request to enable calls to emergency numbers

optional

Full application name, e.g. myapp.myaccount.n1.voximplant.com

optional

If set, the callback of an incoming SMS is sent to this url, otherwise, it is sent to the general account URL

Whether SMS sending and receiving is enabled for this phone number via the ControlSms Management API

Whether SMS is supported for this phone number. SMS needs to be explicitly enabled via the ControlSms Management API before sending or receiving SMS. If SMS is supported and enabled, SMS can be sent from this phone number via the SendSmsMessage Management API and received via the InboundSmsCallback property of the HTTP callback. See this article for HTTP callback details

UTC date of an event associated with the number in 24-h format: YYYY-MM-DD HH:mm:ss

The phone country code (2 symbols)

The phone ID

The next renewal date in the following format: YYYY-MM-DD

The phone number

The phone monthly charge in the account’s currency

The purchase date in 24-h format: YYYY-MM-DD HH:mm:ss

optional

Phone region name

optional

Whether the verification is required for the account

optional

ID of the bound rule

optional

Name of the bound rule

Phone number subscription ID

optional

Unverified phone hold until the date in the following format: YYYY-MM-DD (if the account verification is required). The number is detached on that day automatically!

optional

The account verification status. The following values are possible: REQUIRED, IN_PROGRESS, VERIFIED

Whether the IP is allowed (true - whitelist, false - blacklist)

The authorized IP4 or network

The item creating UTC date in 24-h format: YYYY-MM-DD HH:mm:ss

Adds a new authorized IP4 or network to the white/black list.

Tests whether the IP4 is banned or allowed.

Removes the authorized IP4 or network from the white/black list.

Gets the authorized IP4 or network.

The currency

The minimum amount

The currency

The minimum amount

optional

The bank card limits

optional

The invoice limits

optional

The Robokassa limits

optional

The application ID which the SIP registration is to be bound to. Can be used instead of the application_name parameter

optional

The application name which the SIP registration is to be bound to. Can be used instead of the application_id parameter

optional

Whether to bind or unbind (set true or false respectively)

optional

The rule ID which the SIP registration is to be bound to. Can be used instead of the rule_name parameter

optional

The rule name which the SIP registration is to be bound to. Can be used instead of the rule_id parameter

optional

The registration ID

optional

The user ID which the SIP registration is to be bound to. Can be used instead of the user_name parameter

optional

The user name which the SIP registration is to be bound to. Can be used instead of the user_id parameter

optional

Returns 1 if the request has been completed successfully

The ACD queue ID list separated by semicolons (;). Use the ‘all’ value to select all ACD queues

The ACD queue name that can be used instead of acd_queue_id. The ACD queue name list separated by semicolons (;)

optional

The application ID. It is required if the user_name is specified

optional

The application name that can be used instead of application_id

optional

Whether to bind or unbind (set true or false respectively)

The skill ID list separated by semicolons (;). Use the ‘all’ value to select all skills

The skill name list separated by semicolons (;). Can be used instead of skill_id

The user ID list separated by semicolons (;). Use the ‘all’ value to select all users

The user name list separated by semicolons (;). user_name can be used instead of user_id

optional

Returns 1 if the request has been completed successfully

The ACD queue ID list separated by semicolons (;). Use the ‘all’ value to specify all queues bound to the application

The queue name that can be used instead of acd_queue_id. The queue name list separated by semicolons (;)

The application ID

The application name that can be used instead of application_id

Whether to bind or unbind users

The user ID list separated by semicolons (;). Use the ‘all’ value to specify all users bound to the application

The user name list separated by semicolons (;). user_name can be used instead of user_id

optional

Returns 1 if the request has been completed successfully

Whether active

The callerID id

The callerID number

optional

The code entering attempts left for the unverified callerID

optional

The verification call attempts left for the unverified callerID

optional

The verification ending date in the following format: YYYY-MM-DD (for the verified callerID)

Deletes the CallerID. Note: you cannot delete a CID permanently (the antispam defence).

Gets the account callerIDs.

Call’s history ID

optional

Call’s cost

optional

Custom data passed to the JS session

optional

Call forwarding number

optional

Call duration in seconds

optional

End reason code and description

Whether the call is incoming

Local number on the platform side

Media server’s IP address

optional

Record URL

Remote number on the client side

Type of the remote number, e.g., a PSTN, mobile, user or sip address

Call start time in the selected timezone in 24-h format: YYYY-MM-DD HH:mm:ss

Whether the call is successful

Transaction ID

optional

The completion date in 24-h format: YYYY-MM-DD HH:mm:ss

The date of submitted the list in 24-h format: YYYY-MM-DD HH:mm:ss

The interval between attempts in seconds

The list ID

The list name

The maximum number of simultaneous tasks

The number of task attempts run, which failed to call

The priority of the call list

The rule id

The status name. The possible values are In progress, Completed, Canceled

Whether the first or repeated calls have priority.

Appends a new task to the existing call list. This method accepts CSV files with custom delimiters, such a commas (,), semicolons (;) and other. To specify a delimiter, pass it to the delimiter parameter.

Cancels all tasks in the call list with the specified batch UUID.

Cancels the specified tasks in the call list by their IDs or UUIDs. The maximum number of tasks to cancel is 1000.

Adds a new CSV file for call list processing and starts the specified rule immediately. To send a file, use the request body. To set the call time constraints, use the following options in a CSV file: __start_execution_time – when the call list processing starts every day, UTC+0 24-h format: HH:mm:ss__end_execution_time – when the call list processing stops every day, UTC+0 24-h format: HH:mm:ss__start_at – when the call list processing starts, UNIX timestamp. If not specified, the processing starts immediately after a method call__task_uuid – call list UUID. A string up to 40 characters, can contain latin letters, digits, hyphens (-) and colons (:). Unique within the call list This method accepts CSV files with custom delimiters, such a commas (,), semicolons (;) and other. To specify a delimiter, pass it to the delimiter parameter. IMPORTANT: the account’s balance should be equal or greater than 1 USD. If the balance is lower than 1 USD, the call list processing does not start, or it stops immediately if it is active.

Deletes an existing call list by its ID.

Edits the specified call list by its ID.

Edits priorities of existing tasks in the specified call list.

Get all call lists for the specified user.

Account ID that initiates the JS session

Application ID that initiates the JS session

Application name

Call’s audio quality. The possible values are: Standard | HD | Ultra HD.

optional

Calls within the JS session, including durations, cost, phone numbers and other information

Unique JS session identifier

optional

Custom data

optional

Entire JS session duration in seconds. The session can contain multiple calls

optional

Finish reason. Possible values are Normal termination, Insufficient funds, Internal error (billing timeout), Terminated administratively, JS session error, Timeout

Initiator’s IP address

Link to the session log. The log retention policy is 1 month, after that time this field clears. If you have issues accessing the log file, check if the application has “Secure storage of applications and logs” feature enabled. In this case, you need to authorize(/docs/guides/managementapi/secureobjects).

Media server IP address

optional

Used resources

optional

Bound records

Routing rule name

Start date in the selected timezone in 24-h format: YYYY-MM-DD HH:mm:ss

User ID that initiates the JS session

Batch UUIDs of the tasks to cancel, separated by semicolon (;)

Call list ID

optional

Whether the request completed successfully

Account’s ID

Call list’s ID

optional

Task IDs separated by a semicolon. Specify either tasks_ids or tasks_uuids. The method returns an error if none of the parameters is specified

optional

Task UUIDs separated by a semicolon. Specify either tasks_ids or tasks_uuids. The method returns an error if none of the parameters is specified

optional

Reason for the error

Result of the operation

Task’s ID

Task’s UUID

The IP4 to test

optional

The matched authorized IP or network (if found)

optional

Whether the IP is allowed

The SMS control command. The following values are possible: enable, disable

The phone number

optional

optional

Separator values. The default value is ’;’

optional

Encoding file. The default value is UTF-8

optional

Escape character for parsing csv

Send as the “body” part of the HTTP request or as multiform. The sending “file_content” via URL is at its own risk because the network devices tend to drop HTTP requests with large headers

optional

Interval between call attempts in seconds. The default value is 0

Number of simultaneously processed tasks

File name, up to 255 characters and cannot contain the ’/’ and ” symbols

Number of attempts. Minimum is 1, maximum is 5

Call list priority. The value is in the range of [0 … 2^31] where zero is the highest priority

optional

IP from the geolocation of the call list subscribers. It allows selecting the nearest server for serving subscribers

Rule ID. It is specified in the Applications(//manage.voximplant.com/applications) section of the Control Panel

optional

Location of the server where the scenario needs to be executed. Has higher priority than reference_ip. Request getServerLocations(https://api.voximplant.com/getServerLocations) for possible values

optional

Optional. Whether to prioritize first calling attempts or repeated ones. The possible values are: first_attempts, repeated_attempts. The default values is first_attempts.

Batch UUID

Number of stored records

optional

List ID

Whether the request completed successfully

The admin role ID list separated by semicolons (;). Use the ‘all’ value to select all admin roles

The admin role name to delete, can be used instead of admin_role_id

optional

Returns 1 if the request has been completed successfully

The admin user ID list separated by semicolons (;). Use the ‘all’ value to select all admin users

The admin user name to delete, can be used instead of required_admin_user_id

optional

Returns 1 if the request has been completed successfully

The application ID list separated by semicolons (;). Use the ‘all’ value to select all applications

The application name list separated by semicolons (;). Can be used instead of application_id

optional

Returns 1 if the request has been completed successfully

optional

Whether to remove the network from the white list. Set false to remove the network from the black list. Omit the parameter to remove the network from all lists

The authorized IP4 or network to remove. Set to ‘all’ to remove all items

Specify the parameter to remove the networks that contains the particular IP4. Can be used instead of authorized_ip

optional

The removed network count

ID of the callerID object

The callerID number that can be used instead of callerid_id

optional

Returns 1 if the request has been completed successfully

Account’s ID

optional

Text description

Result

The application ID

optional

The application name

Key, up to 200 characters

optional

optional

Returns 1 if the request has been completed successfully

The PSTN black list item ID

optional

Returns 1 if the request has been completed successfully

The ACD queue ID list separated by semicolons (;)

The ACD queue name that can be used instead of acd_queue_id. The ACD queue name list separated by semicolons (;)

optional

Returns 1 if the request has been completed successfully

Application ID

Application name. Can be used instead of application_id

IDs to delete. A list separated by semicolons (;). Use the ‘all’ value to delete all secrets

Secret names to delete. List separated by semicolons (;)

optional

Returns 1 if the secret has been deleted successfully

The SIP white list item ID to delete

optional

Returns 1 if the request has been completed successfully

The skill ID

The skill name that can be used instead of skill_id

optional

Returns 1 if the request has been completed successfully

optional

Delete the specified users bound to the application ID. It is required if the user_name is specified

optional

Delete the specified users bound to the application name. Can be used instead of the application_id parameter

The user ID list separated by semicolons (;). Use the ‘all’ value to select all users

The user name list separated by semicolons (;) that can be used instead of user_id

optional

Returns 1 if the request has been completed successfully

Edits a Dialogflow key.

Invoice ID

optional

The method returns a raw data, there is no ‘file_content’ parameter in fact

optional

Minimum interval between call attempts. Cannot be a negative value

optional

IP address in the Inet4Address format

Call list ID. If the ID is non existing, the 251 error returns

optional

Maximum simultaneous call attempts for this call list. Cannot be less than 1

optional

Call list name. Cannot be bigger than 255 characters, cannot contain slash symbol

optional

Maximum call attempt number. Cannot be less than 1

optional

Call list’s priority among other call list. The lower the value, the higher is the call list’s priority

optional

Location of the server processing the call list. If the ID is non existing, the 496 error returns: The ‘server_location’ parameter is invalid.

optional

Time when the call list should start in the yyyy-MM-dd HH:mm:ss format

optional

Optional. Whether to prioritize first calling attempts or repeated ones. The possible values are: first_attempts, repeated_attempts. The default values is first_attempts

optional

Whether the request completed successfully

Call list ID. If the ID does not exist, the 251 error returns.

JSON-encoded array of task objects. Each object should contain either ‘task_id’ (number) or ‘task_uuid’ (string), and ‘task_priority’ (number).

optional

JSON-encoded array of each task update.

optional

The EUR exchange rate

optional

The KZT exchange rate

optional

The RUR exchange rate

optional

The USD exchange rate. It is always equal to 1

The SMS destination number

The error code

The error description

optional

Whether to get the account’s live balance

The preferred address for the Management API requests

optional

Account’s info as the AccountInfoType object instance

optional

Number of invoices to show per page. Default value is 20

optional

Number of invoices to skip (e.g. if you set count = 20 and offset = 0 the first time, the next time, offset has to be equal to 20 to skip the items shown earlier). Default value is 0

optional

Number of returned invoices matching the query parameters

optional

Array of the account invoices

Total number of invoices matching the query parameters

optional

The ACD queue ID list separated by semicolons (;). Use the ‘all’ value to select all ACD queues

optional

optional

Whether the admin role is enabled to filter

optional

The admin role ID to filter

optional

The admin role name part to filter

optional

The max returning record count

optional

Not attached admin user ID list separated by semicolons (;). Use the ‘all’ value to select all admin users

optional

Set false to get roles with partial admin user list matching

optional

The attached admin user ID list separated by semicolons (;). Use the ‘all’ value to select all admin users

optional

The first N records are skipped in the output

optional

The admin user to show in the ‘admin_users’ field output

optional

Whether to include the account roles

optional

Whether to get the permissions

optional

Whether to include the parent roles

optional

The returned admin role count

optional

The total found admin role count

optional

Whether the admin user is active to filter

optional

The admin user display name part to filter

optional

The max returning record count

optional

The first N records are skipped in the output

optional

The admin user ID to filter

optional

The admin user name part to filter

optional

Whether to get the admin user permissions

optional

Whether to get the attached admin roles

The returned admin user count

optional

The total found admin user count

optional

The application ID to filter

optional

The application name part to filter

optional

The max returning record count

optional

The first N records are skipped in the output

optional

Whether to get bound rules info

optional

Whether to get bound rules and scenarios info

The returned application count

optional

The total found application count

optional

Whether the IP is allowed

optional

The authorized IP4 or network to filter

optional

Specify the parameter to filter the networks that contains the particular IP4

optional

The max returning record count

optional

The IP address description

optional

The first N records are skipped in the output

The returned network count

optional

The total found network count

optional

Array of the admin role entries

optional

To receive the call history for a specific application, pass the application ID to this parameter

optional

The application name, can be used instead of application_id

optional

To filter the call history by the custom_data passed to the call sessions, pass the custom data to this parameter

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(/docs/references/voxengine/appevents#started) event’s sessionID property in a scenario, or retrieve it from the call_session_history_id value returned from the StartScenarios(https://voximplant.com/docs/references/httpapi/scenarios#reorderscenarios) or StartConference(https://voximplant.com/docs/references/httpapi/scenarios#startconference) methods

optional

Whether to get records in the descent order

The from date in the selected timezone in 24-h format: YYYY-MM-DD HH:mm:ss

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

The output format. The following values available: csv.

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

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

optional

The to date in the selected timezone in 24-h format: YYYY-MM-DD HH:mm:ss

optional

Whether to get a CSV file with the column names if the output=csv

optional

The history report ID

Returns 1 if the request has been completed successfully

optional

Whether the account is active to filter

optional

ID of the callerID object to filter

optional

The phone number to filter

optional

The max returning record count

optional

The first N records are skipped in the output

optional

The following values are available: ‘caller_number’ (ascent order), ‘verified_until’ (ascent order)

The returned record count

optional

The total found record count

optional

To receive the call history for a specific application, pass the application ID to this parameter

optional

The application name, can be used instead of application_id

optional

To filter the call history by the custom_data passed to the call sessions, pass the custom data to this parameter

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(/docs/references/voxengine/appevents#started) event’s sessionID property in a scenario, or retrieve it from the call_session_history_id value returned from the StartScenarios(https://voximplant.com/docs/references/httpapi/scenarios#reorderscenarios) or StartConference(https://voximplant.com/docs/references/httpapi/scenarios#startconference) methods

optional

The child account ID list separated by semicolons (;)

optional

Whether to get the children account calls only

optional

Whether to get records in the descent order

The from date in the selected timezone in 24-h format: YYYY-MM-DD HH:mm:ss

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

optional

The output format. The following values available: csv. The default value is csv

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

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

optional

The to date in the selected timezone in 24-h format: YYYY-MM-DD HH:mm:ss

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

optional

Whether to receive a list of sessions with all calls within the sessions, including phone numbers, call cost and other information

optional

Whether to get a CSV file with the column names if the output=csv

optional

Whether to get other resources usage (see ResourceUsageType)

optional

Whether to get the calls’ records

optional

The history report ID

Returns 1 if the request has been completed successfully

optional

To receive the call history for a specific application, pass the application ID to this parameter

optional

The application name, can be used instead of application_id

optional

To filter the call history by the custom_data passed to the call sessions, pass the custom data to this parameter

optional

To get the call history for the specific sessions, pass the session IDs to this parameter separated by a semicolon (;). The maximum number of records is 1000. You can find the session ID in the AppEvents.Started(/docs/references/voxengine/appevents#started) event’s sessionID property in a scenario, or retrieve it from the call_session_history_id value returned from the StartScenarios(https://voximplant.com/docs/references/httpapi/scenarios#reorderscenarios) or StartConference(https://voximplant.com/docs/references/httpapi/scenarios#startconference) methods

optional

The child account ID list separated by semicolons (;)

optional

Whether to get the children account calls only

optional

The number of returning records. The maximum value is 1000

optional

Whether to get records in the descent order

The from date in the selected timezone in 24-h format: YYYY-MM-DD HH:mm:ss

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

optional

The number of records to skip in the output. The maximum value of 10000

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

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

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

optional

The to date in the selected timezone in 24-h format: YYYY-MM-DD HH:mm:ss

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

optional

Whether to receive a list of sessions with all calls within the sessions, including phone numbers, call cost and other information

optional

Whether to get other resources usage (see ResourceUsageType)

optional

Whether to get the calls’ records

optional

Whether to include the ‘total_count’ and increase performance

The returned call session count

optional

The CallSessionInfoType records

The used timezone

The total found call session count

optional

The application ID to filter. Can be a list separated by semicolons (;). Use the ‘all’ value to select all applications

optional

The max returning record count

optional

The UTC ‘from’ date filter in 24-h format: YYYY-MM-DD HH:mm:ss

optional

Whether to find only active call lists

optional

The list ID to filter. Can be a list separated by semicolons (;). Use the ‘all’ value to select all lists

optional

Find call lists by name

optional

The first N records are skipped in the output

optional

The UTC ‘to’ date filter in 24-h format: YYYY-MM-DD HH:mm:ss

optional

The type of the call list. The possible values are AUTOMATIC and MANUAL

Returned call list count

optional

Array of lists

Total found call list count

The currency code list separated by semicolons (;). Examples: RUR, KZT, EUR, USD

optional

The date, format: YYYY-MM-DD

optional

The exchange rates

The application ID

optional

The application name

Key, up to 200 characters

optional

The key-value item

The application ID

optional

The application name

optional

Number of items to show per page with a maximum value of 50. Default value is 10

Namespace that keys should contain, up to 200 characters

optional

Number of items to skip (e.g. if you set count = 20 and offset = 0 the first time, the next time, offset has to be equal to 20 to skip the items shown earlier). Default value is 0

optional

The key-value pairs

The application ID

optional

The application name

optional

Number of items to show per page with a maximum value of 50. Default value is 10

optional

Namespace that keys should contain, up to 200 characters

optional

Number of items to skip (e.g. if you set count = 20 and offset = 0 the first time, the next time, offset has to be equal to 20 to skip the items shown earlier). Default value is 0

optional

The key-value keys

optional

optional

Whether to get a CSV file with the column names

optional

The report ID (async mode)

optional

Phone number activation statuses to filter, separated by semicolons (;).

The possible values are: ACTIVE, ACTIVATING, DEACTIVATED, PROVISIONING, AWAITING_BUSINESS_PHONE_NUMBER_CONFIGURATION, LEGAL_OWNERSHIP_LIMIT_REACHED, GOSUSLUGI_DECLINED, SELF_BAN_ENABLED

optional

Application ID

optional

Application name that can be used instead of application_id

optional

Whether the auto_charge flag is enabled

optional

Whether a not verified account can use the phone

optional

Whether the subscription is cancelled to filter

optional

Child account ID list separated by semicolons (;). Use the ‘all’ value to select all child accounts

optional

Whether to get the children phones only

optional

Maximum returning record count

optional

Country code list separated by semicolons (;)

optional

Whether the subscription is frozen to filter

optional

UTC ‘from’ date filter in the following format: YYYY-MM-DD

optional

UTC ‘from’ date filter in 24-h format: YYYY-MM-DD HH:mm:ss

optional

Unverified phone hold until the date (from …) in the following format: YYYY-MM-DD

optional

Whether the phone number bound to an application

optional

Whether the phone number is bound to some rule

optional

First N records are skipped in the output

optional

Following values are available: ‘phone_number’ (ascent order), ‘phone_price’ (ascent order), ‘phone_country_code’ (ascent order), ‘deactivated’ (deactivated first, active last), ‘purchase_date’ (descent order), ‘phone_next_renewal’ (ascent order), ‘verification_status’, ‘unverified_hold_until’ (ascent order), ‘verification_name’

optional

Phone category name. See the GetPhoneNumberCategories method

optional

Particular phone ID to filter

optional

Phone number list separated by semicolons (;) that can be used instead of phone_id

optional

Region names list separated by semicolons (;)

optional

Phone number start to filter

optional

Rule ID list separated by semicolons (;)

optional

Rule names list separated by semicolons (;). Can be used only if application_id or application_name is specified

optional

Flag allows you to display only the numbers of the sandbox, real numbers, or all numbers. The following values are possible: ‘all’, ‘true’, ‘false’

optional

optional

UTC ‘to’ date filter in the following format: YYYY-MM-DD

optional

UTC ‘to’ date filter in 24-h format: YYYY-MM-DD HH:mm:ss

optional

Unverified phone hold until the date (… to) in the following format: YYYY-MM-DD

optional

Required account verification name to filter

optional

Account verification status list separated by semicolons (;). The following values are possible: REQUIRED, IN_PROGRESS, VERIFIED

Returned phone count

optional

Phone numbers info

Total found phone count

optional

The max returning record count

optional

The first N records are skipped in the output

optional

The PSTN black list item ID for filter

optional

The phone number in format e164 for filter

The returned phone numbers count

optional

The total found phone numbers count

optional

The ACD queue ID to filter

optional

The ACD queue name part to filter

optional

The application ID to filter

optional

The max returning record count

optional

The excluded skill ID to filter

optional

The first N records are skipped in the output

optional

The skill to show in the ‘skills’ field output

optional

The skill ID to filter

optional

Whether to include the number of agents bound to the queue

optional

Whether to get the bound skills

The returned queue count

optional

The total found queue count

optional

The record storage ID list separated by semicolons (;)

optional

The record storage name list separated by semicolons (;)

optional

optional

optional

Application ID

Application name. Can be used instead of application_id

optional

Maximum returning record number

optional

First N records to be skipped in the output

optional

Filter by the secret name part

Returned secrets number

optional

Secrets list

Total found secrets number

Application ID

Application name. Can be used instead of application_id

Secret ID

Secret name. Can be used instead of secret_id

optional

The full secret info (with value)

Secret creation timestamp

optional

Secret description

Secret modification timestamp

Secret ID

Secret name

Secret value

optional

The application ID list separated by semicolons (;) to filter. Can be used instead of application_name

optional

The application name list separated by semicolons (;) to filter. Can be used instead of application_id

optional

The max returning record count

optional

Whether to show the frozen SIP registrations only

optional

Whether SIP registration is still in progress

optional

Whether SIP registration bound to an application

optional

Whether the SIP registration is persistent to filter

optional

The first N records are skipped in the output

optional

The list of proxy servers to use, divided by semicolon (;)

The rule ID list separated by semicolons (;) to filter. Can be used instead of rule_name

The rule name list separated by semicolons (;) to filter. Can be used instead of rule_id

optional

The SIP registration ID

optional

The SIP user name to filter

optional

The list of SIP response codes. The code1:code2 means a range from code1 to code2 including; the code1;code2 meanse either code1 or code2. You can combine ranges, e.g., code1;code2:code3

optional

Whether to show the successful SIP registrations only

The user ID list separated by semicolons (;) to filter. Can be used instead of user_name

Count rows

optional

Active SIP registrations

optional

The max returning record count

optional

The first N records are skipped in the output

optional

The SIP white list item ID to filter

The returned networks count

optional

The total found networks count

optional

The max returning record count

optional

The first N records are skipped in the output

optional

The skill ID to filter

optional

The skill name part to filter

The returned skill count

optional

The total found skill count

The application ID to search by

The application name to search by. Can be used instead of the application_id parameter

optional

The from date in the selected timezone in 24-h format: YYYY-MM-DD HH:mm:ss. Default is the current time minus 1 day

optional

Group the result by agent or queue. The agent grouping is allowed only for 1 queue and for the occupancy_rate, sum_agents_online_time, sum_agents_ready_time, sum_agents_dialing_time, sum_agents_in_service_time, sum_agents_afterservice_time, sum_agents_dnd_time, sum_agents_banned_time, min_handle_time, max_handle_time, average_handle_time, count_handled_calls, min_after_call_worktime, max_after_call_worktime, average_after_call_worktime report types. The queue grouping allowed for the calls_blocked_percentage, count_blocked_calls, average_abandonment_rate, count_abandonment_calls, service_level, occupancy_rate, min_time_in_queue, max_time_in_queue, average_time_in_queue, min_answer_speed, max_answer_speed, average_answer_speed, min_handle_time, max_handle_time, average_handle_time, count_handled_calls, min_after_call_worktime, max_after_call_worktime, average_after_call_worktime report types

optional

Interval format: YYYY-MM-DD HH:mm:ss. Default is 1 day

optional

Maximum waiting time. Required for the service_level report type

The report type. Possible values are: calls_blocked_percentage, count_blocked_calls, im_blocked_chats_percentage, im_count_blocked_chats, im_answered_chats_rate, average_abandonment_rate, count_abandonment_calls, service_level, im_service_level, occupancy_rate, im_agent_occupancy_rate, agent_utilization_rate, im_agent_utilization_rate, sum_agents_online_time, sum_agents_ready_time, sum_agents_dialing_time, sum_agents_in_service_time, sum_agents_in_service_incoming_time, sum_agents_in_service_outcoming_time, sum_agents_afterservice_time, sum_agents_dnd_time, sum_agents_custom_1_time, sum_agents_custom_2_time, sum_agents_custom_3_time, sum_agents_custom_4_time, sum_agents_custom_5_time, sum_agents_custom_6_time, sum_agents_custom_7_time, sum_agents_custom_8_time, sum_agents_custom_9_time, sum_agents_custom_10_time, sum_agents_banned_time, im_sum_agents_online_time, im_sum_agents_ready_time, im_sum_agents_in_service_time, im_sum_agents_dnd_time, im_sum_agents_custom_1_time, im_sum_agents_custom_2_time, im_sum_agents_custom_3_time, im_sum_agents_custom_4_time, im_sum_agents_custom_5_time, im_sum_agents_custom_6_time, im_sum_agents_custom_7_time, im_sum_agents_custom_8_time, im_sum_agents_custom_9_time, im_sum_agents_custom_10_time, im_sum_agents_banned_time, average_agents_idle_time, max_agents_idle_time, min_agents_idle_time, percentile_0_25_agents_idle_time, percentile_0_50_agents_idle_time, percentile_0_75_agents_idle_time, min_time_in_queue, max_time_in_queue, average_time_in_queue, min_answer_speed, max_answer_speed, average_answer_speed, im_min_answer_speed, im_max_answer_speed, im_average_answer_speed, min_handle_time, max_handle_time, average_handle_time, count_handled_calls, min_after_call_worktime, max_after_call_worktime, average_after_call_worktime, count_agent_unanswered_calls, im_count_agent_unanswered_chats, min_reaction_time, max_reaction_time, average_reaction_time, im_min_reaction_time, im_max_reaction_time, im_average_reaction_time, im_count_abandonment_chats, im_count_lost_chats, im_lost_chats_rate, call_count_assigned_to_queue, im_count_assigned_to_queue

The SmartQueue ID list with a maximum of 5 values separated by semicolons (;). Can operate as filter for the calls_blocked_percentage, count_blocked_calls, average_abandonment_rate, count_abandonment_calls, service_level, occupancy_rate, min_time_in_queue, max_time_in_queue, average_time_in_queue, min_answer_speed, max_answer_speed, average_answer_speed, min_handle_time, max_handle_time, average_handle_time, count_handled_calls, min_after_call_worktime, max_after_call_worktime, average_after_call_worktime report types

optional

The SmartQueue name list separated by semicolons (;). Can be used instead of sq_queue_id

optional

The selected timezone or the ‘auto’ value (the account location)

optional

The to date in the selected timezone in 24-h format: YYYY-MM-DD HH:mm:ss. Default is the current time

optional

The user ID list with a maximum of 5 values separated by semicolons (;). Use the ‘all’ value to select all users. Can operate as a filter for the occupancy_rate, sum_agents_online_time, sum_agents_ready_time, sum_agents_dialing_time, sum_agents_in_service_time, sum_agents_afterservice_time, sum_agents_dnd_time, sum_agents_banned_time, min_handle_time, max_handle_time, average_handle_time, count_handled_calls, min_after_call_worktime, max_after_call_worktime, average_after_call_worktime report types

optional

The user name list separated by semicolons (;). user_name can be used instead of user_id

optional

The used timezone, e.g., ‘Etc/GMT’

The application ID to search by

The application name to search by. Can be used instead of the application_id parameter

optional

The from date in the selected timezone in 24-h format: YYYY-MM-DD HH:mm:ss. Default is the current time minus 30 minutes

optional

Group the result by agent or queue. The agent grouping is allowed for 1 queue and for the occupancy_rate, sum_agents_online_time, sum_agents_ready_time, sum_agents_dialing_time, sum_agents_in_service_time, sum_agents_afterservice_time, sum_agents_dnd_time, sum_agents_banned_time, min_handle_time, max_handle_time, average_handle_time, count_handled_calls, min_after_call_worktime, max_after_call_worktime, average_after_call_worktime report types. The queue grouping allowed for the calls_blocked_percentage, count_blocked_calls, average_abandonment_rate, count_abandonment_calls, service_level, occupancy_rate, min_time_in_queue, max_time_in_queue, average_time_in_queue, min_answer_speed, max_answer_speed, average_answer_speed, min_handle_time, max_handle_time, average_handle_time, count_handled_calls, min_after_call_worktime, max_after_call_worktime, average_after_call_worktime report types

optional

Interval format: YYYY-MM-DD HH:mm:ss. Default is 30 minutes

optional

Maximum waiting time. Required for the service_level report type

The report type. Possible values are: calls_blocked_percentage, count_blocked_calls, im_blocked_chats_percentage, im_count_blocked_chats, im_answered_chats_rate, average_abandonment_rate, count_abandonment_calls, service_level, im_service_level, occupancy_rate, im_agent_occupancy_rate, agent_utilization_rate, im_agent_utilization_rate, sum_agents_online_time, sum_agents_ready_time, sum_agents_dialing_time, sum_agents_in_service_time, sum_agents_in_service_incoming_time, sum_agents_in_service_outcoming_time, sum_agents_afterservice_time, sum_agents_dnd_time, sum_agents_custom_1_time, sum_agents_custom_2_time, sum_agents_custom_3_time, sum_agents_custom_4_time, sum_agents_custom_5_time, sum_agents_custom_6_time, sum_agents_custom_7_time, sum_agents_custom_8_time, sum_agents_custom_9_time, sum_agents_custom_10_time, sum_agents_banned_time, im_sum_agents_online_time, im_sum_agents_ready_time, im_sum_agents_in_service_time, im_sum_agents_dnd_time, im_sum_agents_custom_1_time, im_sum_agents_custom_2_time, im_sum_agents_custom_3_time, im_sum_agents_custom_4_time, im_sum_agents_custom_5_time, im_sum_agents_custom_6_time, im_sum_agents_custom_7_time, im_sum_agents_custom_8_time, im_sum_agents_custom_9_time, im_sum_agents_custom_10_time, im_sum_agents_banned_time, average_agents_idle_time, max_agents_idle_time, min_agents_idle_time, percentile_0_25_agents_idle_time, percentile_0_50_agents_idle_time, percentile_0_75_agents_idle_time, min_time_in_queue, max_time_in_queue, average_time_in_queue, min_answer_speed, max_answer_speed, average_answer_speed, im_min_answer_speed, im_max_answer_speed, im_average_answer_speed, min_handle_time, max_handle_time, average_handle_time, count_handled_calls, min_after_call_worktime, max_after_call_worktime, average_after_call_worktime, count_agent_unanswered_calls, im_count_agent_unanswered_chats, min_reaction_time, max_reaction_time, average_reaction_time, im_min_reaction_time, im_max_reaction_time, im_average_reaction_time, im_count_abandonment_chats, im_count_lost_chats, im_lost_chats_rate, call_count_assigned_to_queue, im_count_assigned_to_queue

optional

The SmartQueue name list separated by semicolons (;). Can be used instead of sq_queue_id

optional

The selected timezone or the ‘auto’ value (the account location)

optional

The to date in the selected timezone in 24-h format: YYYY-MM-DD HH:mm:ss. Default is the current time

optional

The user ID list with a maximum of 5 values separated by semicolons (;). Use the ‘all’ value to select all users. Can operate as a filter for the occupancy_rate, sum_agents_online_time, sum_agents_ready_time, sum_agents_dialing_time, sum_agents_in_service_time, sum_agents_afterservice_time, sum_agents_dnd_time, sum_agents_banned_time, min_handle_time, max_handle_time, average_handle_time, count_handled_calls, min_after_call_worktime, max_after_call_worktime, average_after_call_worktime report types

optional

The user name list separated by semicolons (;). user_name can be used instead of user_id

optional

The used timezone, e.g., ‘Etc/GMT’

optional

Maximum number of resulting rows fetched. Must be not bigger than 1000. If left blank, then the default value of 1000 is used

optional

The destination phone number

optional

Sent or received SMS. Possible values: ‘IN’, ‘OUT’, ‘in, ‘out’. Leave blank to get both incoming and outgoing messages

optional

Date from which to perform search. Format is ‘yyyy-MM-dd HH:mm:ss’, time zone is UTC

optional

The first N records are skipped in the output

optional

The output format. The following values available: json, csv, xls. The default value is json

optional

The source phone number

optional

optional

Date until which to perform search. Format is ‘yyyy-MM-dd HH:mm:ss’, time zone is UTC

optional

Total number of messages matching the query parameters

optional

Maximum number of chats that the user processes simultaneously

optional

JSON array of the agent’s queues

optional

JSON array of the agent’s skills

optional

Agent statuses info

optional

Display name of the user

optional

ID of the user

optional

Name of the user

optional

Number of agents bound to the queue

Agent selection strategy

optional

Maximum size of the queue with CALL-type requests

optional

Maximum time in minutes that a CALL-type request can remain in the queue without being assigned to an agent in minutes. If the value has been passed in seconds, this field is also present in the answer, rounded to the bigger number

optional

Maximum time in minutes that a CALL-type request can remain in the queue without being assigned to an agent in seconds. If the value has been passed in minutes, this field is also present in the answer

optional

UTC date of the queue creation in 24-h format: YYYY-MM-DD HH:mm:ss

optional

Comment

optional

Whether the call task is kept in the queue if all agents are unavailable

optional

Whether the tasks are queued when there are no active agents

optional

Maximum size of the queue with IM-type requests

optional

Maximum time in minutes that an IM-type request can remain in the queue without being assigned to an agent in minutes. If the value has been passed in seconds, this field is also present in the answer, rounded to the bigger number

optional

Maximum time in minutes that an IM-type request can remain in the queue without being assigned to an agent in seconds. If the value has been passed in minutes, this field is also present in the answer

optional

UTC date of the queue modification in 24-h format: YYYY-MM-DD HH:mm:ss

ID of the SmartQueue

Name of the SmartQueue

Strategy of prioritizing requests for service

optional

UTC date of the queue creation in 24-h format: YYYY-MM-DD HH:mm:ss

optional

Comment

optional

UTC date of the queue modification in 24-h format: YYYY-MM-DD HH:mm:ss

ID of the skill

Name of the skill

The application ID to search by

optional

The application name to search by. Can be used instead of the application_id parameter

The SmartQueue ID list separated by semicolons (;). Use the ‘all’ value to select all SmartQueues

optional

The SmartQueue name list separated by semicolons (;). Can be used instead of sq_queue_id

optional

The selected timezone or the ‘auto’ value (the account location)

optional

optional

The child account ID list separated by semicolons (;). Use the ‘all’ value to select all child accounts

optional

Whether to get the children account transactions only

optional

Whether to get records in the descent order

The from date in the selected timezone in 24-h format: YYYY-MM-DD HH:mm:ss

optional

Whether to get transactions on hold (transactions for which money is reserved but not yet withdrawn from the account)

optional

The output format. The following values available: csv. The default value is csv

optional

optional

The to date in the selected timezone in 24-h format: YYYY-MM-DD HH:mm:ss

optional

The transaction ID list separated by semicolons (;)

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

optional

The user ID list separated by semicolons (;)

optional

Whether to get the users’ transactions only

optional

Whether to get a CSV file with the column names if the output=csv

optional

The history report ID

Returns 1 if the request has been completed successfully

optional

The child account ID list separated by semicolons (;). Use the ‘all’ value to select all child accounts

optional

Whether to get the children account transactions only

optional

The number of returning records. The maximum value is 1000

optional

Whether to get records in the descent order

The from date in the selected timezone in 24-h format: YYYY-MM-DD HH:mm:ss

optional

Whether to get transactions on hold (transactions for which money is reserved but not yet withdrawn from the account)

optional

The number of records to skip in the output with a maximum value of 10000

optional

optional

The to date in the selected timezone in 24-h format: YYYY-MM-DD HH:mm:ss

optional

The transaction ID list separated by semicolons (;)

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

optional

The user ID list separated by semicolons (;)

optional

Whether to get the users’ transactions only

optional

Whether to include the ‘total_count’ and increase performance

The returned transaction count

optional

The used timezone. ‘Etc/GMT’ for example

The total found transaction count

optional

The ACD queue ID to filter

optional

The ACD status list separated by semicolons (;) to filter. The following values are possible: OFFLINE, ONLINE, READY, BANNED, IN_SERVICE, AFTER_SERVICE, TIMEOUT, DND

The application ID to filter

The application name part to filter

optional

The max returning record count

optional

The excluded ACD queue ID to filter

optional

The excluded skill ID to filter

optional

The first N records are skipped in the output

optional

The following values are available: ‘user_id’, ‘user_name’ and ‘user_display_name’

optional

Whether to get the user live balance

optional

The skill to show in the ‘skills’ field output

optional

The skill ID to filter

optional

Whether the user is active to filter. Inactive users cannot log in to applications

optional

The user display name part to filter