This document provides information for developers who want to interface their applications with PortaBilling via XML and JSON API.
The PortaSIP Media Applications XML and JSON API is described in the PortaSIP Media Applications XML/JSON API Reference Guide.

Performing operations via the API has several advantages:
- It is based on either XML/SOAP (Simple Object Access Protocol) or JSON (JavaScript Object Notation) Web Application Services and HTTPS transport, so is accessible from any platform or operating system, and all server and client communications are secure.
- The business logic embedded in the API provides integrity checks for all data modifications, and can also compile records from several database tables to create a single customer information retrieval structure.
- The PortaBilling® API is accessible to every owner of a virtual environment or to every reseller. Each user's access is automatically limited to his "visible" portion of the available data, e.g. a reseller can only retrieve information about his own sub-customers or their accounts.
By default, all API requests that contain attributes with the date and time must be sent within the UTC timezone. The date and time attributes must be in the following format:
date: 'YYYY-MM-DD' time: 'HH24:MM:SS' datetime: 'YYYY-MM-DD HH24:MM:SS'
The API returns date and time information in the UTC timezone, respectively. Please note that some methods can receive and return date and time information in timezones different from the UTC (e.g. UTC+08). In these cases, the attributes of such methods contain the appropriate descriptions.
Connection to the XML/JSON API is provided via HTTPS. Authentication is done using a pair: a user login and either the API access token or the user password for the admin web interface. Each request to the API should contain the AuthInfoStructure structure as the header attribute.
HeaderRequest structure | ||
Property | Type | Description |
auth_info | AuthInfoStructure | The user login for the PortaBilling web interface. |
Note that we strongly recommend using the session_id property (which must be received during the authorization via the login request) in the AuthInfoStructure structure for all session requests. Otherwise, if you use the login-password or the API access token authentication pairs for every request, new sessions will be created and cause additional load to the database.
The example below illustrates the login request in JSON format using the cURL command line tool:
curl https://demo.portaone.com:443/rest/Session/login -d params='{"login":"demo","password":"pAssw0rd"}'
The response returns the session ID value:
{"session_id":"527865ee75368ff2d2c4f4881cd2758a"}
- There is a wide range of reusable software available to programmers to handle XML so they do not have to re-invent code.
- XML (SOAP) is more verbose compared with JSON, but because of this, the data encoding result is typically larger than the equivalent encoding in JSON API.
Access to XML API
All SOAP requests to PortaBilling API must be sent to the following URL:
https://portabilling-web.yourdomain.com:port/soap/
Please replace the portabilling-web.yourdomain.com with the actual hostname of your PortaBilling web server.
Replace 'port' with the required port. The SOAP interface is available for administrators on port 443, the interface for customers is available on port 8444, the interface for resellers
is available on port 8442 and the interface for accounts is available on port 8445.
Error Handling
SOAP faults are used to carry error information within a SOAP message. If the actual response has a SOAP fault element as the body entry, then an error has occurred. In this case, any other fields in the response cannot be guaranteed as accurate; only the fault sub-elements should be used to identify an error. Currently, these sub-elements are:
- faultcode is intended for use by the client software and provides an algorithmic mechanism for identifying the fault;
- faultstring provides a human readable explanation of the fault, and is not intended for algorithmic processing.
As an alternative to XML API, PortaBillling supports JSON API, thus providing your development department with a choice of Web Application Services that can be used. Among the advantages of JSON API are the following:
- Simple data structures that can be easily read and written.
- JSON format is faster in parsing and generating data due to simple syntax, thus there is little influence on web server performance.
- Supports the same methods as those in the SOAP.
- Simplifies the creation of front-end web sites that receive and modify data in PortaBilling with minimum impact on performance.
Access to JSON API
All JSON requests to PortaBilling® API must be sent to the following URL:
https://portabilling-web.yourdomain.com:port/rest/service/method/
Please replace the portabilling-web.yourdomain.com with the actual hostname of your PortaBilling web server.
Replace 'port' with the required port. The JSON interface is available for administrators on port 443, the interface for customers is available on port 8444,
the interface for resellers is available on port 8442 and the interface for accounts is available on port 8445.
Replace 'service' with the API service that contains the required method (e.g. specify the Account service to manage account information.)
Replace 'method' with the required API method (e.g. specify get_account_info method in order to get an account record from the database.)
Here is an example of the URL to send a POST request to:
https://demo.portaone.com:443/rest/Account/get_account_list/
Sending an HTTP request
For HTTP requests you must include the following parameters (in JSON format) in the POST request body:
- auth_info - The mandatory authentication information (see the Security section).
- params - A set of method parameters (in JSON format) that depend on a method structure. Note that method parameters and their structures are the same as those in the SOAP.
The Content-Type header field used with a HTTPS POST request must have one of the following values:
- application/x-www-form-urlencoded
- multipart/form-data
You can run JSON requests in the asynchronous mode so that they are executed in the background. For this, add the aux_info structure as the additional argument into the request. The structure has the following fields:
- async - indicates that the method must be run in the asynchronous mode.
- bg_request_id – the ID of the background task started.
- dry_run – indicates that the method must be run in the dry run mode (possible values: all, simple).
NOTE: The asynchronous API requests are not processed during the software upgrade.
Examples
The examples below illustrate sending API requests using the cURL command line tool.
-
Receive the information about a subscriber:
curl https://demo.portaone.com:443/rest/Account/get_account_info -d auth_info='{"session_id":"527865ee75368ff2d2c4f4881cd2758a"}' -d params='{"i_account":"2194329"}'
-
Run an API request in the asynchronous mode:
curl https://demo.portaone.com:443/rest/Account/get_account_info -d auth_info='{"session_id":"527865ee75368ff2d2c4f4881cd2758a"}' -d params='{"i_account":"2194329"}' –d aux_info='{"async":"1"}'
-
Perform advanced customer data search:
You can perform an advanced customer/account data search by using the get_extended_data_list API method. To make this happen, create a custom JSON request where you specify an object (e.g. Customers or Accounts) and the filters to be used for data search. A filter can be a property of a different object (e.g. Invoice.invoice_total); several filters can be linked with each other.
The example below illustrates how to filter customers by country and invoice amount:
https://demo.portaone.com:443/rest/Generic/get_extended_data_list/ -d auth_info='{"session_id":"527865ee75368ff2d2c4f4881cd2758a"}' -d params='{"data":[{"object":"Customers","fields":["*"]}],"filters":[{"entries":[{"object":"Customers","field":"country","values":["US"]},{"object":"Invoices","field":"amount_paid","values":[50]}]}],"get_total":1,"offset":0,"limit":50}'
Error Handling
If the server returns the '500 Internal Server Error' status code in the HTTP response, then the response body contains a JSON object which includes two elements (keys) that carry
error information:
- faultcode, that is intended for use by the client software and provides an algorithmic mechanism for identifying the fault.
- faultstring, that provides a human readable explanation of the fault, and is not intended for algorithmic processing.
The PortaBilling® XML/JSON API is backward compatible. This allows your applications to communicate with new versions of
PortaBilling® with very little reconfiguration.
Some API methods can become obsolete. They are kept for a few MRs and can be deleted once the first LTS release after the one where the method
became obsolete is crossed. For instance, if an API method is found to no longer be useful in MR67, it can be deleted in MR71 onwards.
You can still enable obsolete API methods by adding the [API]AllowObsoleteMethods=1 option for the WebCustom group on the Configuration server. However, we don’t recommend it since using them alongside the new API logic may result in the incorrect operations of your applications. Instead, we recommend that you keep your API applications up to date.
https://portabilling-web.yourdomain.com/doc/api/
Please replace the portabilling-web.yourdomain.com with the actual hostname of your PortaBilling web server.
All requests to PortaBilling API are handled via an SSL connection. By default, PortaBilling installations contain a self-signed certificate that provides the means to encrypt data. However, since the authenticity of this certificate cannot be validated, you may experience some problems when connecting to an SSL site. In this case, it may be necessary to obtain a certificate from a genuine certificate authority. Another option is to generate your own certificate authority and have certificates deployed to all API clients. However, this goes beyond the scope of the present document.
https://portabilling-web.yourdomain.com/wsdl/
Please replace the portabilling-web.yourdomain.com with the actual hostname of your PortaBilling web server.
All requests to PortaBilling API are handled via an SSL connection. By default, PortaBilling installations contain a self-signed certificate that provides the means to encrypt data. However, since the authenticity of this certificate cannot be validated, you may experience some problems when connecting to an SSL site. In this case, it may be necessary to obtain a certificate from a genuine certificate authority. Another option is to generate your own certificate authority and have certificates deployed to all API clients. However, this goes beyond the scope of the present document.
change_password | |
The API method enables an API user to change their password (also changes expired passwords) | |
Parameters | SessionChangePasswordRequest |
Return Value | SessionChangePasswordResponse |
Realm | administrator, reseller, account, retail customer, cc staff, representative, distributor |
Standalone mode support | No |
SessionChangePasswordRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
login | Yes | string | No | The username for the PortaBilling web interface. | |
new_password | Yes | string | No | The new user password for the PortaBilling web interface. |
Max value: 32 |
password | Yes | string | No | The user password for the PortaBilling web interface. |
Max value: 32 |
SessionChangePasswordResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
success | Yes | string | No | 1 is case of success, exception error message in case of failure. |
generate_captcha | |
Enables an API user to generate a captcha image | |
Parameters | GenerateCaptchaRequest |
Return Value | GenerateCaptchaResponse |
Realm | administrator, reseller, account, retail customer, cc staff, representative, distributor |
Standalone mode support | No |
GenerateCaptchaRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
Does not include any properties |
GenerateCaptchaResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
ca_content | Yes | string | No | The encoded captcha image. | |
ca_token | Yes | string | No | The captcha token. |
get_espf_api_token | |
This method is obsolete. Use the new login method of the Session service instead. This method enables an API user to get the ESPF API token |
|
Parameters | GetEspfApiTokenRequest |
Return Value | GetEspfApiTokenResponse |
Realm | administrator |
Standalone mode support | No |
GetEspfApiTokenRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
Does not include any properties |
GetEspfApiTokenResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
espf_api_token | Yes | string | No | The ESPF API access token of a user. Can be used to access ESPF API, such as for getting logs, generating events, etc. |
get_json_access_token_lifetime | |
This method enables an API user to get the current json access token lifetime | |
Parameters | GetJsonAccessTokenLifetimeRequest |
Return Value | GetJsonAccessTokenLifetimeResponse |
Realm | administrator, reseller, account, retail customer, cc staff, representative, distributor |
Standalone mode support | No |
Request example |
|
Response example |
|
GetJsonAccessTokenLifetimeRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
Does not include any properties |
GetJsonAccessTokenLifetimeResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
json_access_token_lifetime | Yes | int | No | The current json access token lifetime in seconds. |
get_session_context | |
This method enables an API user to get the context for the current session | |
Parameters | GetSessionContextRequest |
Return Value | GetSessionContextResponse |
Realm | administrator, reseller, distributor, cc staff, retail customer, account, representative |
Standalone mode support | No |
GetSessionContextRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
Does not include any properties |
GetSessionContextResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
dual_version_system | No | string | No | The system the context was set for (target or source or normal). |
jwt_login | |
This method checks the validity of the login and password or token. We recommend using a token for authentication. This method returns the json access token and the refresh token upon successful authentication. Otherwise, it throws an API fault. | |
Parameters | JWTLoginRequest |
Return Value | JWTAuthResponse |
Realm | administrator, reseller, account, retail customer, cc staff, representative, distributor |
Standalone mode support | No |
Request example |
|
Response example |
|
JWTLoginRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
ca_code | No | string | No | The captcha code. | |
ca_token | No | string | No | The captcha token. | |
enable_csrf_protection | No | int | No | The flag shows whether to permanently enable CSRF protection for the session. | |
i_env | No | unsignedLong | No | The unique ID of the environment. | |
login | Yes | string | No | User Name, as specified on web interface. | |
password | No | string | No | Password, as specified on web interface. | |
token | No | string | No | The API access token of a user. |
JWTAuthResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
expires_at | Yes | string | No | The date and time in UTC when the json access token becomes expired (YYYY-MM-DD HH24:MI:SS). | |
json_access_token | Yes | string | No | The access token of the user. Can be used to access PortaSIP and PortaBilling API. | |
refresh_token | Yes | string | No | The refresh token of the user. Can be used to update the json access token. |
jwt_login_to_realm | |
This method creates a JWT session for the specific login and realm | |
Parameters | JWTLoginToRealmRequest |
Return Value | JWTAuthResponse |
Realm | administrator, reseller, representative |
Standalone mode support | No |
JWTLoginToRealmRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
enable_csrf_protection | No | int | No | Shows whether to permanently enable CSRF protection for the session. Possible values: 0 - don't enable CSRF protection; 1 - enable CSRF protection. | |
login | Yes | string | No | The user's web self-care login. The UI equivalent of this field is the "Login" input field on the Edit Account -> Personal info -> General info -> Web self-care panel. | |
realm | Yes | string | No | The realm name the user wants to log into for the specified login. Possible values: reseller, customer, accounts, representative, vendor. |
Possible values: reseller, customer, accounts, representative, vendor |
with_default_access_level | No | int | No | The flag shows whether to apply the default access level and role to the session. Possible values: 0 - use the current role and ACL; 1 - use the default role and ACL. |
Possible values: 0, 1 |
login | |
This method checks the validity of the login and password or token. We recommend using a token for authentication. The method returns the session_id and access_token upon successful authentication. Otherwise, it throws an API fault. | |
Parameters | LoginRequest |
Return Value | LoginResponse |
Realm | administrator, reseller, account, retail customer, cc staff, representative, distributor |
Standalone mode support | No |
Request example |
|
Response example |
|
LoginRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
ca_code | No | string | No | The captcha code. | |
ca_token | No | string | No | The captcha token. | |
enable_csrf_protection | No | int | No | The flag shows whether to permanently enable CSRF protection for the session. | |
i_env | No | unsignedLong | No | The unique ID of the environment. | |
login | Yes | string | No | User Name, as specified on web interface. | |
password | No | string | No | Password, as specified on web interface. | |
token | No | string | No | The API access token of a user. |
LoginResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
access_token | No | string | No | The access token of the user. Can be used to access PortaSIP API. | |
expires_at | No | string | No | The date and time in UTC when the access token becomes expired (YYYY-MM-DD HH24:MI:SS). | |
session_id | Yes | string | No | The unique ID of the newly opened session. |
login_to_realm | |
This method creates a session for the specific login and realm | |
Parameters | LoginToRealmRequest |
Return Value | LoginToRealmResponse |
Realm | administrator, reseller, representative |
Standalone mode support | No |
LoginToRealmRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
enable_csrf_protection | No | int | No | Shows whether to permanently enable CSRF protection for the session. Possible values: 0 - don't enable CSRF protection; 1 - enable CSRF protection. | |
login | Yes | string | No | The user's web self-care login. The UI equivalent of this field is the "Login" input field on the Edit Account -> Personal info -> General info -> Web self-care panel. | |
realm | Yes | string | No | The realm name the user wants to log into for the specified login. Possible values: reseller, customer, accounts, representative, vendor. |
Possible values: reseller, customer, accounts, representative, vendor |
with_default_access_level | No | int | No | The flag shows whether to apply the default access level and role to the session. Possible values: 0 - use the current role and ACL; 1 - use the default role and ACL. |
Possible values: 0, 1 |
LoginToRealmResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
session_id | Yes | string | No | The unique ID of the newly opened session. |
logout | |
This method enables an API user to terminate a session. Call logout to terminate the session properly | |
Parameters | LogoutRequest |
Return Value | LogoutResponse |
Realm | administrator, reseller, account, retail customer, cc staff, representative, distributor |
Standalone mode support | No |
Request example |
|
Response example |
|
LogoutRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
json_access_token | No | string | No | The access token of the user. Note: At least one of the following must be specified: the 'json_access_token' or the 'session_id'. | |
session_id | No | string | No | The ID of a previously opened session. Note: At least one of the following must be specified: the 'json_access_token' or the 'session_id'. |
LogoutResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
success | No | int | No | 1 for success, 0 for failure. |
ping | |
This method checks the validity of a previously opened session and returns the user_id on success. API Fault is thrown on failure | |
Parameters | PingRequest |
Return Value | PingResponse |
Realm | administrator, reseller, account, retail customer, cc staff, representative, distributor |
Standalone mode support | No |
PingRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
json_access_token | No | string | No | The access token of the user. Note: At least one of the following must be specified: the 'json_access_token' or the 'session_id'. | |
nonce | No | string | No | A 32-symbol (128-bit) hexadecimal nonce previously sent to an email address as a part of the allowance link (it can be found at the end of the link). | |
session_id | No | string | No | The ID of a previously opened session. Note: At least one of the following must be specified: the 'json_access_token' or the 'session_id'. |
PingResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
user_id | Yes | unsignedLong | No | The ID of the user currently logged into the specified session. Possible values: 0 - the session is not valid; other number value - the ID of the user/reseller/customer/account/etc bound to the session.. |
refresh_json_access_token | |
This method checks the validity of the JWT refresh token. This method returns the json access token and the refresh token upon successful refresh token validation. Otherwise, it throws an API fault. | |
Parameters | RefreshJsonAccessTokenRequest |
Return Value | JWTAuthResponse |
Realm | administrator, reseller, account, retail customer, cc staff, representative, distributor |
Standalone mode support | No |
Request example |
|
Response example |
|
RefreshJsonAccessTokenRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
refresh_token | No | string | No | The refresh token of the user. Can be used to update the json access token. |
reset_password | |
This method enables an API user to reset the password (when the user forgets it, for example) and create a new one | |
Parameters | ResetPasswordRequest |
Return Value | ResetPasswordResponse |
Realm | administrator, reseller, account, retail customer, cc staff, representative, distributor |
Standalone mode support | No |
ResetPasswordRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
custom_url | No | string | No | Optional link to the reset password page (e.g. http://yourdomain.com/reset_password). If not supplied then the default PortaBilling "forgot password" page url will be sent. | |
No | string | No | The user email address. | ||
id | No | string | No | The reset password ID - A 32- symbol (128-bit) hexadecimal nonce previously sent to an email address as a part of the password reset link (it can be found at the end of the link). | |
login | No | string | No | The user login for the PortaBilling web interface. | |
password | No | string | No | A new password. |
Max value: 32 |
ResetPasswordResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
success | Yes | int | No | 1 for success, 0 for failure. |
set_session_context | |
This method enables an API user to change the context for the current session | |
Parameters | SetSessionContextRequest |
Return Value | SetSessionContextResponse |
Realm | administrator, reseller, distributor, cc staff, representative |
Standalone mode support | No |
SetSessionContextRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
dual_version_system | No | string | No | The system the context will be set for (target or source or normal). | |
i_customer | No | unsignedLong | No | The unique ID of the customer record. |
SetSessionContextResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
success | Yes | int | No | 1 for success, 0 for failure. |
get_operation_access_id | |
This method enables getting access ID for a particular operation. The ID will be sent to the email/mobile of the requestor | |
Parameters | GetOperationAccessIdRequest |
Return Value | GetOperationAccessIdResponse |
Realm | administrator, reseller, retail customer, account |
Standalone mode support | No |
GetOperationAccessIdRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
operation | Yes | string | No | A unique operation name that requires an additional ID for access. |
Min value: 1 |
GetOperationAccessIdResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
success | No | int | No | 1 on success. |
add_access_policy | |
This method enables an API user to create an access policy using the supplied data | |
Parameters | AddAccessPolicyRequest |
Return Value | AddAccessPolicyResponse |
Realm | administrator, reseller |
Standalone mode support | No |
AddAccessPolicyRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
access_policy_info | Yes | AccessPolicyInfo structure | No | The data related to the access policy. |
AddAccessPolicyResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
i_access_policy | Yes | unsignedLong | No | The unique ID of the access policy. |
delete_access_policy | |
This method enables an API user to delete an existing access policy | |
Parameters | DeleteAccessPolicyRequest |
Return Value | DeleteAccessPolicyResponse |
Realm | administrator, reseller |
Standalone mode support | No |
DeleteAccessPolicyRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
i_access_policy | Yes | unsignedLong | No | The unique ID of the access policy. |
DeleteAccessPolicyResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
success | Yes | int | No | 1 in case of success, exception error message in case of failure. |
get_access_policy_info | |
This method enables an API user to get information about access policy | |
Parameters | GetAccessPolicyInfoRequest |
Return Value | GetAccessPolicyInfoResponse |
Realm | administrator, reseller |
Standalone mode support | Yes |
GetAccessPolicyInfoRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
check_usage | No | int | No | If set to '1', the 'is_used' field will be provided in the response. | |
i_access_policy | Yes | unsignedLong | No | The unique ID of the Access Policy. | |
with_access_phases | No | int | No | If set to '1', the list of access_phases will be provided in the response. | |
with_attributes | No | int | No | If set to '1', the list of related service policy attribute values will be provided in the response. |
GetAccessPolicyInfoResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
access_policy_info | No | AccessPolicyInfo structure | No | Access Policy information. |
get_access_policy_list | |
This method enables an API user to get the list of access policy records | |
Parameters | GetAccessPolicyListRequest |
Return Value | GetAccessPolicyListResponse |
Realm | administrator, reseller |
Standalone mode support | Yes |
GetAccessPolicyListRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
check_usage | No | int | No | If set to '1', the 'is_used' field will be provided for every record in the response. | |
get_total | No | int | No | Get the total number of retrieved records. | |
limit | No | int | No | The number of rows to retrieve. | |
managed_by | No | unsignedLong | No | The unique ID of the reseller who owns the access policy. | |
name | No | string | No | The name of the access policy. | |
offset | No | int | No | The number of rows to skip at the beginning of the list. Requires the limit property to be specified in the API request. |
Default value: 0 |
with_access_phases | No | int | No | If set to '1', the list of 'access_phases' will be provided for every record in the response. | |
with_attributes | No | int | No | If set to '1', the list of related service policy attribute values will be provided for every record in the response. |
GetAccessPolicyListResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
access_policy_list | No | Array of AccessPolicyInfo structure | No | The list of access policy records. | |
total | No | int | No | The total number of retrieved records. |
update_access_policy | |
This method enables an API user to modify an existing access policy using the supplied data | |
Parameters | UpdateAccessPolicyRequest |
Return Value | UpdateAccessPolicyResponse |
Realm | administrator, reseller |
Standalone mode support | No |
UpdateAccessPolicyRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
access_policy_info | Yes | AccessPolicyInfo structure | No | The data related to the access policy. |
UpdateAccessPolicyResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
i_access_policy | Yes | unsignedLong | No | The unique ID of the access policy. |
add_access_role | |
This method enables an API user to create a new access role record using the supplied data | |
Parameters | AddAccessRoleRequest |
Return Value | AddUpdateAccessRoleResponse |
Realm | administrator |
Standalone mode support | No |
AddAccessRoleRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
access_role_info | Yes | AccessRoleInfo structure | No | The information about the access role. |
AddUpdateAccessRoleResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
i_role | Yes | unsignedLong | No | The identifier of the access role. |
delete_access_role | |
This method enables an API user to delete the access role record from the database | |
Parameters | DeleteAccessRoleRequest |
Return Value | DeleteAccessRoleResponse |
Realm | administrator |
Standalone mode support | No |
DeleteAccessRoleRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
i_role | Yes | unsignedLong | No | The identifier of the access role. |
DeleteAccessRoleResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
success | Yes | int | No | 1 for success, exception in case of failure. |
get_access_role_info | |
This method enables an API user to get an access role record | |
Parameters | GetAccessRoleInfoRequest |
Return Value | GetAccessRoleInfoResponse |
Realm | administrator |
Standalone mode support | Yes |
GetAccessRoleInfoRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
i_role | Yes | unsignedLong | No | The identifier of the access role. | |
with_permissions | No | int | No | Flag that indicates if the access role permissions should be returned. | |
with_usage | No | int | No | Flag that indicates if the access role usage should be returned. |
GetAccessRoleInfoResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
access_role_info | No | AccessRoleInfo structure | No | Data on the access role. |
get_access_role_list | |
This method enables an API user to get the list of access role records | |
Parameters | GetAccessRoleListRequest |
Return Value | GetAccessRoleListResponse |
Realm | administrator, reseller |
Standalone mode support | Yes |
GetAccessRoleListRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
complex_ordering | No | Array of ComplexOrderingInfo structure | No | Orders the retrieved access role records by multiple fields. | |
get_total | No | int | No | Get the total number of the retrieved access roles. | |
i_role_type | No | int | No | The type of the access role. | |
limit | No | int | No | The number of rows to retrieve. | |
name | No | string | No | The name of the access role. | |
offset | No | int | No | The number of rows to skip at the beginning of the list. |
Default value: 0 |
with_usage | No | int | No | Flag that indicates if the access role usage should be returned. |
GetAccessRoleListResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
access_roles | Yes | Array of AccessRoleInfo structure | Yes | The list of access roles. | |
total | No | int | No | The total number of the access roles. |
get_access_role_type_info | |
This method enables an API user to get the access role type info | |
Parameters | GetAccessRoleTypeInfoRequest |
Return Value | GetAccessRoleTypeInfoResponse |
Realm | administrator |
Standalone mode support | Yes |
GetAccessRoleTypeInfoRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
i_role_type | Yes | unsignedLong | No | The unique ID of the access role type record to be fetched. | |
with_metadata | No | int | No | Specifies whether to retrieve components tree metadata for the access role type. |
GetAccessRoleTypeInfoResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
access_role_type_info | No | AccessRoleTypeInfo structure | No | Access role type info. |
get_access_role_type_list | |
This method enables an API user to get the list of access role type records | |
Parameters | GetAccessRoleTypeListRequest |
Return Value | GetAccessRoleTypeListResponse |
Realm | administrator |
Standalone mode support | Yes |
GetAccessRoleTypeListRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
with_metadata | No | int | No | Specifies whether the retrieve components tree metadata for the access role type. |
GetAccessRoleTypeListResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
access_role_types | Yes | Array of AccessRoleTypeInfo structure | Yes | The list of access role types. |
update_access_role | |
This method enables an API user to update an access role record using the supplied data | |
Parameters | UpdateAccessRoleRequest |
Return Value | AddUpdateAccessRoleResponse |
Realm | administrator |
Standalone mode support | No |
UpdateAccessRoleRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
access_role_info | Yes | AccessRoleInfo structure | No | The information about the access role. |
add_account | |
This method allows an API user to create a new account record using the supplied data | |
Parameters | AddAccountRequest |
Return Value | AddUpdateAccountResponse |
Realm | administrator, reseller, representative, retail customer |
Standalone mode support | No |
Request example |
|
Response example |
|
AddAccountRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
account_info | No | AccountInfo structure | No | The account information. | |
generate_web_password | No | int | No | Indicates whether a password to the self-care interface should be generated. Possible values: 1 - generate a password; 0 - do not generate a password.. |
AddUpdateAccountResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
i_account | No | unsignedLong | No | The unique ID of the created/modified account record. An account represents an actual user of the service.. |
change_password | |
This method enables an API user to change their password. The old_password is mandatory only when the method is executed under the account realm | |
Parameters | ChangeAccountPasswordRequest |
Return Value | ChangePasswordResponse |
Realm | retail customer, account |
Standalone mode support | No |
ChangeAccountPasswordRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
i_account | No | unsignedLong | No | The unique ID of the account record. | |
new_password | Yes | string | No | The new password. |
Max value: 32 Min value: 1 |
old_password | No | string | No | The old password. |
ChangePasswordResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
errors | No | ChangePasswordResponseErrMessages structure | No | Error explanation. | |
success | Yes | int | No | 1 for success, 0 for failure. |
get_account_info | |
This method allows an API user to get an account record from the database. The account must be viewable (owned) by the user making the request | |
Parameters | GetAccountInfoRequest |
Return Value | GetAccountInfoResponse |
Realm | administrator, reseller, distributor, account, retail customer, cc staff, representative |
Standalone mode support | Yes |
Request example |
|
Response example |
|
GetAccountInfoRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
aux_field_names | No | Array of string structure | No | The names of additional fields to fetch. | |
batch_name | No | string | No | The name of the batch to which the account belongs. Note: please use either i_account or id or login to look for an account (only one of the fields is applicable); when using the batch_name field, control_number must be specified as well.. |
Max value: 32 Min value: 0 |
control_number | No | int | No | The sequential number of the account in the batch. This attribute serves to determine what account from the batch you wish to retrieve the information about. Note: when using search by control_number, it is mandatory to specify batch_name or i_batch fields.. |
Max value: 4294967295 Min value: 0 |
detailed_info | No | int | Yes | Indicates whether to fetch additional information about the account, like: account_expired, account_inactive, extension information, etc. Possible values: 0 - don't fetch the additional information; 1 - fetch the additional information and include it in account_info.. | |
expand_alias | No | int | No | Indicates whether the information should be retrieved from the alias or from the related master account. Note: applicable to aliases only. Possible values: 0 - don't fetch the master account information; 1 - fetch the master account information.. | |
get_included_services | No | int | No | Indicates whether to retrieve the list of services configured for the account. Possible values: 1 - retrieve the list of services (include services of account_info); 0 - do not retrieve the list of services.. | |
get_service_features | No | ArrayOfString | No | The list of service features (by name) for which to fetch the configuration. | |
i_account | No | unsignedLong | No | The unique ID of the account. Note: this field is read-only.. |
Max value: 4294967295 Min value: 1 |
i_batch | No | unsignedLong | No | The batch ID. Note: please use either i_account or id or login to look for an account (only one of the fields is applicable); when using i_batch field, control_number must be specified as well.. |
Max value: 4294967295 Min value: 1 |
i_subscriber | No | unsignedLong | No | The unique ID of the account's subscriber record. Refers to the Subscribers table. Note: this field is read-only; not used.. | |
id | No | string | No | The ID (PIN) of the account, unique in an environment. Note: please use either i_account or id or login to look for an account (only one of the fields is applicable).. |
Min value: 0 |
limit_alias_did_number_list | No | int | No | Include the list of DID numbers assigned as aliases to the account in the response. Specify the number of DID numbers to include (maximum is 100). Default value: 0 (not to include them at all). Note: for example, your portal has a page displaying the list of a customer's accounts with information about each account, including the list of DID numbers assigned as aliases to the account. An account may have dozens of such DID numbers assigned to it. Because of the limited space on the page, and in order to reduce the performance impact, you may want to display only the first three DID numbers per account. In this case, set the parameter to 3.. |
Max value: 100 Min value: 0 |
login | No | string | No | The account login for the account web self-care interface, unique in an environment. Note: please use either i_account or id or login to look for an account (only one of the fields is applicable).. |
Min value: 0 |
with_call_processing_mode | No | int | No | Indicates whether to fetch the account's call processing mode in the response. Possible values: 1 - include call processing mode information for account in the response; 0 - don't include call processing mode for account in the response. | |
with_customer_info | No | int | No | Indicates whether to include the customer_info field in the response. Possible values: 0 - don't include; 1 - include customer_info in the response.. | |
with_reseller_info | No | int | No | Indicates whether to include the reseller_info field in the response. Possible values: 0 - don't include; 1 - include reseller_info in the response.. | |
without_service_features | No | int | No | Indicates whether to fetch the service feature configuration for the account. Possible values: - 0 - fetch the service features configuration (default value); 1 - don't fetch the service features configuration.. |
GetAccountInfoResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
account_info | No | AccountInfo structure | No | The information about an account. | |
customer_info | No | CustomerInfo structure | No | The information about a retail customer. Note: available only if the with_customer_info flag is used and has a value of 1.. | |
reseller_info | No | CustomerInfo structure | No | The information about the reseller. Note: available only if the with_reseller_info flag is used and has a value of 1.. |
get_account_list | |
This method allows an API user to get the list of account records. The account must be viewable (owned) by the user making the request | |
Parameters | GetAccountListRequest |
Return Value | GetAccountListResponse |
Realm | administrator, reseller, retail customer, representative |
Standalone mode support | Yes |
GetAccountListRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
account_role_list | No | Array of AccountRoleInfo structure | No | The list of account roles to search for the accounts in. Used to define what a specific account is designated for (e.g. whether the account represents a phone line or a top-up voucher) and executes account ID validation. The UI equivalent of this field is the "Account role" input field on the Edit Account main panel. |
Min value: 1 |
batch_name | No | string | No | Filters accounts by the batch name to which they belong. Note: use % to specify the matching type (like %value - ends with, value% - starts with, %value% - contains). |
Max value: 32 Min value: 0 |
bill_status | No | string | No | Filters accounts by the status. Possible values: O - the account is open; I - the account is inactive; C - the account is terminated. |
Possible values: O, I, C |
billing_model | No | int | No | Filters accounts by the type. Possible values: -1 - debit, 0 - recharge voucher, 1 - credit, 2 - alias, 3 - internal, 4 - beneficiary. |
Possible values: 0, -1, 4, 1 |
blocked | No | string | No | Filters accounts by the "blocked" status. Possible values: Y - blocked; N - unblocked. |
Possible values: Y, N |
callshop_enabled | No | string | No | Filters accounts whose customers have the callshop feature enabled or disabled. Possible values: Y - enabled, N - disabled. |
Possible values: Y, N |
city | No | string | No | Filters accounts by the city of the account owner's address (city where the account owner resides). Note: use % to specify the matching type (like %value - ends with, value% - starts with, %value% - contains). | |
companyname | No | string | No | Filters accounts by the account owner's company name. Note: use % to specify the matching type (like %value - ends with, value% - starts with, %value% - contains). | |
cont1 | No | string | No | Filters accounts by the main contact person. Note: use % to specify the matching type (like %value - ends with, value% - starts with, %value% - contains). | |
cont2 | No | string | No | Filters accounts by the alternative contact person. Note: use % to specify the matching type (like %value - ends with, value% - starts with, %value% - contains). | |
control_number | No | unsignedLong | No | Filters accounts by the sequential number of the account in the batch. Possible values: range values, like 1-10, 1,5,7,10-17. | |
control_number_list | No | Array of AccountControlNumberInfo structure | No | Filters accounts by the list of control numbers. | |
country | No | string | No | Filters accounts by the code of the country in the ISO 3166-1 alpha-2 format. Example values: "UA", "KW", "ES", etc. | |
custom_fields_values | No | Array of CustomFieldsValuesInfo structure | No | Filters accounts by the list of Custom Fields values. | |
did_number | No | string | No | The search pattern for the account's DID number. Use the following wildcard symbols: the percent ( % ) wildcard allows you to match any string of characters; the underscore ( _ ) wildcard allows you to match any single character. |
Max value: 32 |
No | string | No | Filters accounts by the account's email address. Note: use % to specify the matching type (like %value - ends with, value% - starts with, %value% - contains). | ||
expand_alias | No | int | No | Indicates whether the information should be retrieved from the alias or from the related master account. Possible values: 1 - retrieve the account from master account for aliases; 0 - don't retrieve alias related information from master account. Note: applicable for account aliases. | |
extension_id | No | string | No | The search pattern for the account's extension number. Use the following wildcard symbols: the percent ( % ) wildcard allows you to match any string of characters; the underscore ( _ ) wildcard allows you to match any single character. |
Max value: 32 |
extension_name | No | string | No | The search pattern for the account's extension name. Use the following wildcard symbols: the percent ( % ) wildcard allows you to match any string of characters; the underscore ( _ ) wildcard allows you to match any single character. |
Max value: 32 |
faxnum | No | string | No | Filters accounts by the account owner's fax number. Note: use % to specify the matching type (like %value - ends with, value% - starts with, %value% - contains). | |
firstname | No | string | No | Filters accounts by the account owner's first name. Note: use % to specify the matching type (like %value - ends with, value% - starts with, %value% - contains). | |
free_of_extension | No | int | No | Indicates whether to fetch the accounts that aren't assigned to any extension. Possible values: 1 - yes, 0 - no. | |
get_not_closed_accounts | No | int | Yes | Indicates whether to fetch only accounts with statuses different from "closed". Possible values: 1 - yes, 0 - no. | |
get_only_real_accounts | No | int | Yes | Indicates whether to fetch only debit, credit and beneficiary accounts. Possible values: 1 - yes, 0 - no. | |
get_service_features | No | ArrayOfString | No | The list of service feature names to fetch for each account. Note: it can impact performance and increases the load on the system. | |
get_statuses | No | int | No | Indicates whether to fetch the statuses of the accounts. Note: it can impact performance and increases the load on the system. Possible values: 1 - yes, 0 - no. | |
get_total | No | int | Yes | Indicates whether to fetch the number of matched records and include it into the response. Possible values: 1 - yes, 0 - no. | |
has_extension | No | int | No | Filters the account list by the availability of an assigned extension. Possible values: 1 - return accounts that have an extension assigned; 0 - return accounts that do not have an extension assigned. | |
i_account_balance_control_type | No | unsignedLong | No | Filters accounts by the ID of the account's balance control type. Possible values: 1 - Undefined, 2 - Individual credit limit, 3 - Subordinate. |
Possible values: 1, 2, 3 |
i_addon_product | No | unsignedLong | No | Filters accounts by the ID of the record of the addon product that is assigned to the account. |
Max value: 4294967295 Min value: 1 |
i_batch | No | unsignedLong | Yes | Filters accounts by the ID of the batch to which the account belongs. |
Max value: 4294967295 Min value: 1 |
i_c_group | No | unsignedLong | No | Filters the account list by the specific huntgroup. If specified, only accounts assigned to that huntgroup will be returned. |
Max value: 4294967295 Min value: 1 |
i_customer | No | unsignedLong | No | Filters accounts by the ID of the customer record to which the account belongs. |
Max value: 4294967295 Min value: 1 |
i_customer_site | No | unsignedLong | Yes | Filters accounts by the ID of the customer site. |
Max value: 4294967295 Min value: 1 |
i_master_account | No | unsignedLong | No | Filters accounts by the internal ID of the master account record. | |
i_product | No | unsignedLong | No | Filters accounts by the ID of the account's product. |
Max value: 4294967295 Min value: 1 |
iccid | No | string | No | The search pattern for the Integrated Circuit Card Id of the assigned SIM card. Use the following wildcard symbols: the percent ( % ) wildcard allows you to match any string of characters; the underscore ( _ ) wildcard allows you to match any single character. | |
id | No | string | No | Filters accounts by the search pattern for account IDs. Note: use % to specify the matching type (like %value - ends with, value% - starts with, %value% - contains). |
Min value: 0 |
imsi | No | string | No | The search pattern for the International Mobile Subscriber Identity of the assigned SIM card. Use the following wildcard symbols: the percent ( % ) wildcard allows you to match any string of characters; the underscore ( _ ) wildcard allows you to match any single character. | |
lastname | No | string | No | Filters accounts by the account owner's last name. Note: use % to specify the matching type (like %value - ends with, value% - starts with, %value% - contains). | |
legal_intercept_only | No | int | Yes | Indicates whether to fetch only accounts with "Legal Intercept" enabled. Possible values: 1 - yes, 0 - no. | |
limit | No | int | No | The number of rows to retrieve. |
Default value: 50 Max value: 1000 Min value: 1 |
limit_alias_did_number_list | No | int | No | Include the list of DID numbers assigned as aliases to the account in the response. Specify the number of DID numbers to include (maximum is 100). Default value: 0 (not to include them at all). Note: for example, your portal has a page displaying the list of a customer's accounts with information about each account, including the list of DID numbers assigned as aliases to the account. An account may have dozens of such DID numbers assigned to it. Because of the limited space on the page, and in order to reduce the performance impact, you may want to display only the first three DID numbers per account. In this case, set the parameter to 3.. |
Max value: 100 Min value: 0 |
login | No | string | No | Filters accounts by the user login for the self-care web interface. Note: use % to specify the matching type (like %value - ends with, value% - starts with, %value% - contains). Possible values: only digits, letters and the following symbols: "@", "-", "_", "."; minimum value length: 4; maximum: 64 symbols. The UI equivalent of this field is the "Login" input field on the Edit account -> Personal info -> General info -> Web self-care panel. | |
midinit | No | string | No | Filters accounts by the account owner's middle initial(s). Note: use % to specify the matching type (like %value - ends with, value% - starts with, %value% - contains). Possible length: 25 symbols. | |
note | No | string | No | Find accounts by the short note. Note: use % to specify the matching type (like %value - ends with, value% - starts with, %value% - contains). | |
offset | No | int | No | The number of rows to skip at the beginning of the list. |
Default value: 0 Max value: 4294967295 Min value: 0 |
phone1 | No | string | No | Filters accounts by the main phone number. Note: use % to specify the matching type (like %value - ends with, value% - starts with, %value% - contains). | |
phone2 | No | string | No | Filters accounts by the alternative phone number. Note: use % to specify the matching type (like %value - ends with, value% - starts with, %value% - contains). | |
salutation | No | string | No | Filters accounts by the account owner's salutation. Possible values: "Mr", "Ms", "Mrs". | |
sim_description | No | string | No | The search pattern for the description of the assigned SIM card. Use the following wildcard symbols: the percent ( % ) wildcard allows you to match any string of characters; the underscore ( _ ) wildcard allows you to match any single character. | |
sip_status | No | int | No | Indicates whether to fetch accounts which are used by a SIP phone to register with a PortaSIP server. Possible values: 1 - yes, 0 - no. |
Max value: 1 Min value: 0 |
state | No | string | No | Filters accounts by the province or state of the account owner's address (the province or state where the account owner resides). | |
subscriber_email | No | string | No | Filters accounts by the subscriber's email address. Note: use % to specify the matching type (like %value - ends with, value% - starts with, %value% - contains). | |
with_addon_products | No | int | No | Indicates whether to fetch the add-on products of the account. Note: it can impact performance and increases the load on the system. Possible values: 1 - supplement account information with the list of add-on products, 0 - the list of addon products will not be included in the response. Default value: 0. | |
with_call_processing_mode | No | int | No | Indicates whether to fetch the accounts' call processing mode in the response. Possible values: 1 - include call processing mode information for every account in the response; 0 - don't include call processing mode for every account in the response. | |
with_sim_card_info | No | int | No | A flag that indicates whether the information about the assigned SIM card will be returned. Possible values: 1 - return the information about the assigned SIM card with the account information; 0 - do not include the information about the assigned SIM card in the response. Default value: 0. | |
zip | No | string | No | Filters accounts by the postal (zip) code. Note: you can use letters, digits and symbols ' ' (space) and '-' (dash); use % to specify the matching type (like %value - ends with, value% - starts with, %value% - contains). Possible length: 2-10 symbols. |
GetAccountListResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
account_list | No | Array of AccountInfo structure | No | The list of account records that match any filter used. The total number of accounts returned is limited by the limit parameter.. | |
total | No | int | No | The total number of accounts found. |
get_provisioning_status_list | |
The method enables an API user to retrieve the list of account provisioning statuses | |
Parameters | GetAccountProvisioningStatusListRequest |
Return Value | GetAccountProvisioningStatusListResponse |
Realm | administrator, reseller, retail customer, account |
Standalone mode support | Yes |
GetAccountProvisioningStatusListRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
i_account | No | unsignedLong | No | The unique ID of the account. | |
i_group | No | unsignedLong | No | The unique ID of the provisioning group. |
GetAccountProvisioningStatusListResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
provisioning_status_list | No | Array of AccountProvisioningStatusInfo structure | No | The list of the account provisioning statuses. |
move_account | |
This method enables an administrator to "move" an account to a different customer. The "movement" is performed in two steps: 1) The clone of the account is created for the appropriate customer; 2) The original account is terminated. If an account has any subscriptions (active and/or not yet active), they "move" together with it. The subscription usage data are preserved. For instance, the clone of the original account will be charged according to the promotional period that was applied before the transfer (e.g. $5 for the 9th subscription period). All subscriptions (both active and not yet active) of the original account are closed. The end date will be the day before the transfer is performed. No fees are applied to the original account (e.g. a cancellation fee). If the account is "moved" when the subscription charges in advance have already been applied, then a refund is issued for the "unused" subscription time (e.g. 15 days) | |
Parameters | MoveAccountRequest |
Return Value | MoveAccountResponse |
Realm | administrator |
Standalone mode support | No |
MoveAccountRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
batch_name | Yes | string | No | The name of the batch to put the account into. | |
i_account | Yes | unsignedLong | No | The unique ID of the account to be moved. | |
i_customer | Yes | unsignedLong | No | The unique ID of the customer to move account to. | |
i_product | No | unsignedLong | Yes | The unique ID of the product. | |
i_routing_plan | No | unsignedLong | Yes | The unique ID of the routing plan. | |
i_vd_plan | No | unsignedLong | Yes | The unique ID of the volume discount plan. |
MoveAccountResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
i_account | Yes | unsignedLong | No | The new unique ID of the account that was moved. | |
old_i_account | Yes | unsignedLong | No | The old ID of the account that was moved. | |
warnings | No | ArrayOfString | Yes | Warnings accumulated while moving the account. |
terminate_account | |
This method allows an API user to terminate an existing account record | |
Parameters | TerminateAccountRequest |
Return Value | TerminateAccountResponse |
Realm | administrator, reseller, representative |
Standalone mode support | No |
TerminateAccountRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
force | No | int | No | The flag specifies whether associated non-disconnectable active sessions should be ignored. | |
i_account | Yes | unsignedLong | No | The unique ID of the account. | |
release_assigned_did | No | int | No | The flag specifies whether the previously assigned DID number should be released to the pool (true by default). |
Default value: 1 |
TerminateAccountResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
success | Yes | int | No | 1 in case of success, 0 in case of failure. | |
warnings | No | ArrayOfString | No | Returns procedure warnings if any. |
update_account | |
This method enables an API user to update an existing account record using the supplied data. Note that if a user is not allowed to manage (create/read/update/delete access types) some field by an ACL, then the client application must not send this property in the request (Otherwise PortaBilling® will reject the whole request). That is why we recommend you to make sure that your customer portals and other external applications correspond to the ACL configuration in PortaBilling®. Use the get_my_permissions_for_objects method to find out the permissions for every object on the PortaBilling® web interface. | |
Parameters | UpdateAccountRequest |
Return Value | AddUpdateAccountResponse |
Realm | administrator, reseller, distributor, retail customer, account, cc staff, representative |
Standalone mode support | No |
UpdateAccountRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
account_info | Yes | AccountInfo structure | No | The account information. | |
release_assigned_did | No | int | No | Indicates whether the previously assigned DID number should be released to the pool. Possible values: 0 - don't release DID to the pool (keep assigned to the customer); 1 - release DID number to the pool (release DID number from the customer; enabled by default).. |
Default value: 1 |
validate_account_info | |
This method enables an API user to check if the supplied data can be used to create a new account record or update an existing one. If successful, the completed data is returned. Note that if a user is not allowed to manage (create/read/update/delete access types) some field by an ACL, then the client application must not send this property in the request (Otherwise PortaBilling® will reject the whole request). That is why we recommend you to make sure that your customer portals and other external applications correspond to the ACL configuration in PortaBilling®. Use the get_my_permissions_for_objects method to find out the permissions for every object on the PortaBilling® web interface. | |
Parameters | ValidateAccountInfoRequest |
Return Value | ValidateAccountInfoResponse |
Realm | administrator, reseller |
Standalone mode support | Yes |
ValidateAccountInfoRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
account_info | No | AccountInfo structure | No | Complete information about an account; note: omit i_account to check if data can be used to create a new account record. |
ValidateAccountInfoResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
account_info | No | AccountInfo structure | No | Data about an account, see AccountInfo above. |
get_role_info | |
This method enables an API user to get the information about an account role by i_account_role | |
Parameters | GetAccountRoleInfoRequest |
Return Value | GetAccountRoleInfoResponse |
Realm | administrator, reseller, distributor, account, retail customer, cc staff, representative |
Standalone mode support | Yes |
GetAccountRoleInfoRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
i_account_role | Yes | unsignedLong | No | The identifier of the account role. |
GetAccountRoleInfoResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
role_info | No | AccountRoleInfo structure | No | Information about an account role info. |
get_role_list | |
This method enables an API user to retrieve the information about account roles by their fields | |
Parameters | GetAccountRoleListRequest |
Return Value | GetAccountRoleListResponse |
Realm | administrator, reseller, distributor, account, retail customer, cc staff, representative |
Standalone mode support | Yes |
GetAccountRoleListRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
get_total | No | int | No | Get the total number of the retrieved records. | |
i_account_role | No | unsignedLong | No | The unique ID of the account role type. | |
inventory_usage | No | string | No | Specifies whether to retrieve the inventory for the account role type. |
Possible values: Y, N |
limit | No | int | No | The number of records to retrieve. | |
name | No | string | No | The name of the account role type. | |
offset | No | int | No | The number of rows to skip at the beginning of the list. Requires the limit property to be specified in the API request. |
Default value: 0 |
realm | No | string | No | The top realm of the account role type. | |
validation_format | No | string | No | The validation for the ID of the account role type. |
GetAccountRoleListResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
role_list | No | Array of AccountRoleInfo structure | Yes | The list of account roles. | |
total | No | int | No | The total number of the retrieved account rules. |
add_alias | |
This method allows an API user to add an alias | |
Parameters | AddAccountAliasRequest |
Return Value | AddAccountAliasResponse |
Realm | administrator, reseller, representative |
Standalone mode support | No |
Request example |
|
Response example |
|
AddAccountAliasRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
alias_info | Yes | AliasInfo structure | No | The alias information. |
AddAccountAliasResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
i_account | No | unsignedLong | Yes | The unique ID of the created alias. | |
success | Yes | int | No | The status of the adding alias. Possible values: 1 - the alias was added.. |
delete_alias | |
This method allows an API user to remove an alias | |
Parameters | DeleteAccountAliasRequest |
Return Value | DeleteAccountAliasResponse |
Realm | administrator, reseller, representative |
Standalone mode support | No |
DeleteAccountAliasRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
alias_info | Yes | AliasInfo structure | No | The alias information. | |
force | No | int | No | Indicates whether to ignore non-disconnectable active sessions. Possible values: 0 - don't ignore non-disconnectable active sessions and throw an exception if there are active sessions; 1 - ignore non-disconnectable active sessions and delete the alias.. | |
release_assigned_did | No | int | No | Indicates whether the previously assigned DID number should be released to the pool. Possible values: 0 - don't release DID to the pool (keep assigned to the customer); 1 - release DID number to the pool (release DID number from the customer; enabled by default).. |
Default value: 1 |
DeleteAccountAliasResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
success | Yes | int | No | The status of deleting the alias. Possible values: 1 - the alias was deleted.. | |
warnings | No | ArrayOfString | No | The warnings, if any, for instance a message about non-disconnected active sessions. |
get_alias_list | |
This method allows an API user to get the list of aliases | |
Parameters | GetAccountAliasListRequest |
Return Value | GetAccountAliasListResponse |
Realm | administrator, reseller, representative, account, retail customer |
Standalone mode support | Yes |
GetAccountAliasListRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
blocked | No | string | No | Filters aliases by the status of alias calls. Possible values: N - match aliases with calls enabled (SIP auth enabled); Y - match aliases with calls disabled (SIP auth disabled).. | |
check_did | No | int | No | Indicates whether to include the associated i_did_number for every alias matched. Possible values: 1 - include i_did_number for every alias matched; 0 - don't include i_did_number for every alias matched.. | |
get_total | No | int | Yes | Indicates whether to include the total number of found aliases in the response. Possible values: 0 - don't include the total field in the response; 1 - include the total field in the response.. | |
i_account_role | No | unsignedLong | No | Filters aliases by the account role. The UI equivalent of this field is the "Alias role" input field on the Search aliases panel.. | |
i_master_account | Yes | unsignedLong | No | Filters aliases by the account they belong to. | |
id | No | string | No | Filters aliases by ID. Note: use % as a wildcard: %value - ends with value; value% - starts with value; %value% - contains value). The UI equivalent of this field is the "Alias ID" input field on the Search aliases panel.. | |
limit | No | int | No | The number of rows to retrieve. | |
offset | No | int | No | The number of rows to skip at the beginning of the list. |
Default value: 0 |
realm | No | string | No | Filters aliases by realm. Note: use % as a wildcard: %value - ends with value; value% - starts with value; %value% - contains value. The UI equivalent of this field is the "Realm" input field on the Search aliases panel.. |
GetAccountAliasListResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
alias_list | No | Array of AliasInfo structure | No | The list of aliases. | |
total | No | int | No | The total number of matched aliases. |
update_alias | |
This method allows an API user to update an alias | |
Parameters | UpdateAccountAliasRequest |
Return Value | UpdateAccountAliasResponse |
Realm | administrator, reseller |
Standalone mode support | No |
UpdateAccountAliasRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
alias_info | Yes | AliasInfo structure | No | The alias information. | |
release_assigned_did | No | int | No | Indicates whether the previously assigned DID number should be released to the pool. Possible values: 0 - don't release DID to the pool (keep assigned to the customer); 1 - release DID number to the pool (release DID number from the customer; enabled by default).. |
Default value: 1 |
UpdateAccountAliasResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
success | Yes | int | No | Status of adding the alias. Possible values: 1 - the alias was added.. |
add_auto_payment | |
This method enables an API user to set up automated periodic payments | |
Parameters | AddUpdateAutoPaymentInfoRequest |
Return Value | AddUpdateAutoPaymentInfoResponse |
Realm | administrator, reseller, retail customer, account |
Standalone mode support | No |
AddUpdateAutoPaymentInfoRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
auto_payment_info | Yes | AutoPaymentInfo structure | No | Auto-payment data. |
AddUpdateAutoPaymentInfoResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
i_object | Yes | unsignedLong | No | The unique ID of either an account or a customer. |
delete_auto_payment | |
This method enables an API user to delete an account's automated periodic payment | |
Parameters | DeleteAutoPaymentRequest |
Return Value | DeleteAutoPaymentResponse |
Realm | administrator, reseller, retail customer, account |
Standalone mode support | No |
DeleteAutoPaymentRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
i_object | Yes | unsignedLong | No | The unique ID of an account or a customer. Not mandatory when the method that requires this structure is executed from the retail customer realm. |
DeleteAutoPaymentResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
success | Yes | int | No | 1 for success, 0 for failure. |
get_auto_payment_info | |
This method enables an API user to get an account’s automated periodic payment record | |
Parameters | GetAutoPaymentInfoRequest |
Return Value | GetAutoPaymentInfoResponse |
Realm | administrator, reseller, retail customer, account |
Standalone mode support | Yes |
GetAutoPaymentInfoRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
i_object | Yes | unsignedLong | No | The unique ID of an account or a customer. Not mandatory when the method that requires this structure is executed from the retail customer realm or the account realms. |
GetAutoPaymentInfoResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
auto_payment_info | Yes | AutoPaymentInfo structure | Yes | Auto-payment data. |
update_auto_payment | |
This method enables an API user to update automated periodic payments | |
Parameters | AddUpdateAutoPaymentInfoRequest |
Return Value | AddUpdateAutoPaymentInfoResponse |
Realm | administrator, reseller, retail customer, account |
Standalone mode support | No |
generate_accounts | |
This method enables an API user to generate a batch of accounts | |
Parameters | GenerateAccountsRequest |
Return Value | GenerateAccountsResponse |
Realm | administrator, reseller |
Standalone mode support | No |
GenerateAccountsRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
activation_date | No | date | No | The date when the account becomes usable. The UI equivalent of this field is the "Activation date" input field on the Account Generator -> Optional configuration -> Life cycle expanding panel.. |
Default value: current date |
addon_products | No | ArrayOfInt | No | The list of effective add-on products for the given accounts. The UI equivalent of this field is the Account Generator -> Add-on products panel.. | |
batch | Yes | string | No | The name of a batch. Batches are used to group accounts. Possible length: 32 characters. The UI equivalent of this field is the "New batch name" input field on the Account Generator -> Initial configuration panel.. |
Max value: 32 Min value: 1 |
billing_model | No | int | No | The account type. An account can be a debit, credit, or voucher type. A debit type is usually associated with prepaid cards and the account balance shows the available funds. A credit account is invoiced for incurred costs. A voucher-type account is used to refill debit or credit accounts - the balance of the voucher account is transferred to the main account. Possible values: -1 - debit; 0 - voucher; 1 - credit. The UI equivalent of this field is the "Type" input field on the Account Generator -> Initial configuration panel.. |
Default value: -1 Possible values: -1, 1, 0 |
blocked | No | string | No | Indicates whether the account will be blocked after creation. Note: the default value is N. Possible values: Y - block account's calls and disable authorization; N - do not block account's calls, authorization enabled.. |
Default value: N Possible values: Y, N |
check_available_dids | No | int | No | Indicates whether to check if the number of available DIDs is enough to generate the accounts requested. If gen_method is set to 'D' and the field is set to '1', the method will check available numbers and fail with an error if the total of available numbers is less than the value in the gen_amount field. Possible values: 0 - don't check the number of available DIDs; 1 - check the number of available DIDs before generating the accounts.. | |
check_available_sim_cards | No | int | No | Indicates whether to check if the number of available SIM cards is enough to generate the accounts requested. If the account role is set to 'Mobile' and the field is set to '1', the method will check available SIM cards and raise an error if the number of available SIM cards is less than the value in the gen_amount field. Possible values: 0 - don't check the number of SIM cards available; 1 - check the number of SIM cards available before generating the accounts.. | |
credit_limit | No | float | No | The account's credit limit value. Used to specify the credit allowance in the account's currency and to protect the system owner from account fraud when overusing services. Note: applicable to credit accounts only; default value is 0. The UI equivalent of this field is the "Credit limit" input field on the Account Generator -> Optional configuration panel.. | |
ecommerce_enabled | No | string | No | Indicates whether e-commerce is enabled to recharge an account's balance. Used to allow the account's owner to make online payments or set up periodical payments on the account's self-care page. Possible values: Y - e-commerce is enabled; N - e-commerce is disabled. The UI equivalent of this field is the "E-commerce enabled" switch on the Account Generator -> Optional configuration panel.. |
Default value: N Possible values: Y, N |
expiration_date | No | date | Yes | The date from which the account will become unusable. Used to specify the date when the account expires. Note: services will not be provided from this date. The UI equivalent of this field is the "Expiration date" input field on the Account Generator -> Optional configuration -> Life cycle expanding panel.. | |
gen_amount | No | int | No | The number of accounts to generate. Possible values: 1 - min value. The UI equivalent of this field is the "Quantity" input field on the Account Generator -> Initial configuration panel.. |
Default value: 1000 Max value: 10000 Min value: 1 |
gen_credentials_method | No | string | No | The login method and password generation. Possible values: empty - empty, auto - auto generated. The UI equivalent of this field is the "Credentials" input field on the Account Generator -> Optional configuration ->Web self-care expanding panel.. |
Default value: auto Possible values: empty, auto |
gen_h323_length | No | int | No | The length of the service password to generate. Note: used in combination with the generation method "auto_digits" (auto-generated digits). Possible values: digits; 1 - min value; 99 - max value. The UI equivalent of this field is the "Number of digits" input field on the Account Generator -> Optional configuration panel.. | |
gen_h323_method | No | string | No | The method of service password generation. Note: applicable to debit and voucher accounts only. Possible values: empty - empty, auto - auto-generated, auto_digits - auto-generated digits. The UI equivalent of this field is the "Service password" input field on the Account Generator -> Optional configuration panel.. |
Default value: empty Possible values: empty, auto, auto_digits |
gen_i_do_batch | No | unsignedLong | No | The ID of the DID owner batch from which to use DID numbers. Note: applicable for the DID Inventory method only. The UI equivalent of this field is the "Pricing batch" input field on the Account Generator -> Optional configuration panel.. | |
gen_id_length | No | int | No | The account ID length. Note: applicable for the Random method only. Possible length: min value - 4 digits, max value - 64 digits. The UI equivalent of this field is the "ID length" input field on the Account Generator -> Optional configuration panel.. |
Default value: 12 Max value: 128 Min value: 4 |
gen_id_prefix | No | string | No | The account ID prefix. Note: applicable for the Random method only. Possible length: 3 characters. The UI equivalent of this field is the "ID prefix" input field on the Account Generator -> Optional configuration panel.. |
Max value: 64 |
gen_method | No | string | No | The accounts generation method. Possible values: R - Random; S - Sequential; D - DID Inventory. The UI equivalent of this field is the "Generation method" input field on the Account Generator -> Optional configuration panel.. |
Default value: R Possible values: R, S, D |
gen_start_did | No | string | No | The starting DID number. Note: applicable for the DID Inventory method only. The UI equivalent of this field is the "Use DID numbers from" input field on the Account Generator -> Optional configuration panel.. | |
gen_start_id | No | string | No | The account's start ID. Note: applicable for the Sequential method only. Possible length: min - 4, max - 128. The UI equivalent of this field is the "Starting ID" input field on the Account Generator -> Optional configuration panel.. | |
gen_start_imsi | No | string | No | The starting IMSI SIM number. Applicable only for the Mobile account role. Used to specify the starting IMSI SIM numbers in the generated accounts. The starting sequence should be a string containing from 6 to 15 digits. Note: SIM cards with a specified starting IMSI should be available in the SIM card inventory. The UI equivalent of this field is the "Assign IMSI sequentially starting with" field on the "Account generation optional configuration" panel.. | |
gen_use_did_from | No | string | No | Specifies the type of available numbers from the DID Inventory for the current customer. Note: applicable only for the DID Inventory method; DID numbers with a specified type should be available in the DID inventory. Possible values: A - all; F - non-assigned; C - assigned.. | |
i_account_balance_control_type | No | unsignedLong | No | The ID of the account's balance control type. Used to regulate whether the credit account has an individual balance and credit limit or uses that of its customer. The account may have one of the following balance control types: subordinate - no individual account balance and credit limit; individual credit limit - the account has an individual balance and credit limit. Possible values: 1 - undefined, 2 - individual credit limit, 3 - subordinate.. | |
i_account_role | No | unsignedLong | No | The unique ID of the account's access role. Used to define what a specific account is designated for (e.g. whether the account represents a phone line or a top-up voucher) and executes account ID validation. Thus, for a phone line, one can only pick a valid phone number as an account ID and must assign the product with the same role. Possible values: 1 - Universal; 2 - Phone line; 3 - Auto attendant; 4 - Prepaid card; 5 - PINless; 6 - IPv4 address; 7 - User@domain; 8 - Mobile; 9 - Voucher. The UI equivalent of this field is the "Account role" input field on the Account Generator -> Initial configuration panel.. |
Default value: 1 |
i_acl | No | unsignedLong | No | The ID for the account's access level. Used to control user access to all of the resources in the system. Note: this field is deprecated, use i_role instead.. | |
i_batch | No | unsignedLong | No | The unique ID of the batch to which the account belongs. Batches are used to group accounts. Note: when creating an account, you can select an existing batch or create a new one. The UI equivalent of this field is the "Batch" input field on the Account Generator -> Initial configuration panel.. | |
i_customer | Yes | unsignedLong | No | The ID of the customer record to which the account belongs. A customer is a client (an individual or a company) to whom services are provided. Note: this field cannot be changed after the account is created.. | |
i_customer_site | No | unsignedLong | No | The ID of the customer site the account belongs to. Customer site is used to define a group of phone lines managed as a single entity and usually placed in a separate office building. It is allowed to apply certain configuration parameters or service restrictions to the accounts in that group. The UI equivalent of this field is the "Customer site" input field on the Account Generator -> Optional configuration panel.. | |
i_distributor | No | unsignedLong | No | The unique ID of the distributor associated with the account. The distributor resells your products to end users and earns commissions on those product sales. Note: applicable to debit and voucher accounts only. The UI equivalent of this field is the "Distributor" input field on the Account Generator -> Optional configuration panel.. | |
i_product | Yes | unsignedLong | No | The ID for the account's product. A product is the combination of services you provide to users for a price. The UI equivalent of this field is the "Product" input field on the Account Generator -> Initial configuration panel.. | |
i_role | No | unsignedLong | No | The ID of the account's access role. Used to define the access role assigned to this account. It contains a set of permissions to access components. Each account is created with a default role. The UI equivalent of this field is the "Access level" input field on the Account Generator -> Optional configuration -> Web self-care expanding panel.. | |
i_time_zone | No | unsignedLong | No | The ID for the account's time zone. Used to specify the time zone in which to display the date and time values on the account self-care interface. The UI equivalent of this field is the "Time zone" input field on the Account Generator -> Optional configuration -> Web self-care expanding panel.. |
Default value: 370 |
in_date_format | No | string | No | The input date format. Used to specify an input date format for the account self-care interface. The UI equivalent of this field is the "Date" input field on the Account Generator -> Optional configuration -> Web self-care -> Input format expanding panel.. |
Default value: YYYY-MM-DD Max value: 16 |
in_time_format | No | string | No | The input time format. Used to specify an input time format for the account self-care interface. The UI equivalent of this field is the "Time" input field on the Account Generator -> Optional configuration -> Web self-care -> Input format expanding panel.. |
Default value: HH24:MI:SS Max value: 16 |
inactive | No | string | No | Indicates whether the account will be inactive after creation. Note: applicable to debit and vouchers accounts only. Possible values: Y - yes; N - no. Default value - Y. The UI equivalent of this field is the "Requires manual activation" switch on the Account Generator -> Optional configuration panel.. |
Default value: Y Possible values: Y, N |
inactivity_expire_time | No | int | No | The availability period after last usage. Used to specify the number of days the account remains active after its last use or recharge. The UI equivalent of this field is the "Availability period after last usage, days" input field on the Account Generator -> Optional configuration -> Life cycle expanding panel.. |
Max value: 65535 Min value: 1 |
language | No | string | No | The code for the account's web language. Used to specify a desired language for the account self-care interface. Example values: en, ru, es, etc. The UI equivalent of this field is the "Web interface language" input field on the Account Generator -> Optional configuration -> Web self-care expanding panel.. |
Max value: 2 Min value: 2 |
life_time | No | int | Yes | The availability period after first usage. Used to specify the number of days the account remains active after its first use or recharge. The account will expire on the first usage date + lifetime days. The UI equivalent of this field is the "Availability period after first usage, days" input field on the Account Generator -> Optional configuration -> Life cycle expanding panel.. |
Max value: 65535 Min value: 1 |
opening_balance | No | float | No | The initial account balance. Note: applicable to debit accounts only. The UI equivalent of this field is the "Opening balance" input field on the Account Generator -> Optional configuration panel.. |
Default value: 10 Max value: 99999999999.99998 Min value: -9999999999.99999 Precision: 15, Scale: 5 |
out_date_format | No | string | No | The output date format. Used to specify an output date format for the account self-care interface. The UI equivalent of this field is the "Date" input field on the Account Generator -> Optional configuration -> Web self-care -> Output format expanding panel.. |
Default value: YYYY-MM-DD Max value: 16 |
out_date_time_format | No | string | No | The output date and time format. Used to specify an output date and time format for the account self-care interface. The UI equivalent of this field is the "Date & time" input field on the Account Generator -> Optional configuration -> Web self-care -> Output format expanding panel.. |
Default value: YYYY-MM-DD HH24:MI:SS Max value: 32 |
out_time_format | No | string | No | The output time format. Used to specify an output time format for the account self-care interface. The UI equivalent of this field is the "Time" input field on the Account Generator -> Optional configuration -> Web self-care -> Output format expanding panel.. |
Default value: HH24:MI:SS Max value: 16 |
service_features | No | Array of ServiceFeatureInfo structure | No | The set of service feature configuration options within the account. The UI equivalent of this field is the "Service" section on the Account generation popup.. |
GenerateAccountsResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
i_batch | No | unsignedLong | No | The unique ID of the batch to which the account belongs. Batches are used to group accounts. Note: when creating an account, you can select an existing batch or create a new one. The UI equivalent of this field is the "Batch" input field on the Edit Account -> Personal info -> General info -> Additional info -> Account info panel.. | |
success | Yes | int | No | Returns 1 if an accounts generation procedure was queued. |
generate_aliases | |
This method enables an API user to generate a batch of aliases | |
Parameters | GenerateAliasesRequest |
Return Value | GenerateAliasesResponse |
Realm | administrator, reseller |
Standalone mode support | No |
GenerateAliasesRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
blocked | No | string | No | Shows whether the alias will be blocked after creation and using it for the authentication is not possible; default: N. |
Default value: N Possible values: Y, N |
check_available_dids | No | int | No | If set the method will check all available numbers and terminate with an error if there are less numbers available than the value in the 'gen_amount' field. | |
gen_amount | No | int | No | The number of aliases to generate. |
Default value: 1000 Max value: 10000 Min value: 1 |
gen_i_do_batch | No | unsignedLong | No | The ID of DID owner batch to use DID numbers from. | |
gen_start_did | No | string | No | Starting DID number. |
Max value: 32 |
i_account_role | No | unsignedLong | No | The ID of the account role. An account role defines what a specific account is designated for (e.g. whether the account represents a phone line or a top-up voucher) and is used for account ID validation. |
Default value: 1 Possible values: 1, 2 |
i_master_account | Yes | unsignedLong | No | The ID of the parent account record. | |
realm | No | string | No | An account realm enables administrators to impose a scope of uniqueness for an account ID. |
Max value: 100 |
GenerateAliasesResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
success | Yes | int | No | Returns 1 if an aliases generation procedure was queued. |
update_accounts_batch | |
This method allows an API user to update accounts of a particular batch | |
Parameters | UpdateAccountsBatchRequest |
Return Value | UpdateAccountsBatchResponse |
Realm | administrator, reseller, retail customer |
Standalone mode support | Yes |
UpdateAccountsBatchRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
activate | No | int | No | Indicates that accounts should be activated. Only for debit accounts and vouchers. | |
activation_date | No | date | No | The date from which accounts are usable. | |
addon_products | No | ArrayOfInt | No | The list of effective add-on products for the given accounts. | |
advanced_search | No | AccountsAdvancedSearchInfo structure | No | Enables filtering accounts which should be updated by specific fields. | |
batch | No | string | No | The batch name. |
Max value: 32 Min value: 1 |
blocked | No | string | No | Indicates whether accounts should be blocked or unblocked. |
Possible values: Y, N |
charge | No | float | No | The amount to charge accounts. |
Max value: 99999999999.99998 Min value: 0.00001 Precision: 15, Scale: 5 |
control_number | No | string | No | Comma-separated integer control numbers and/or ranges of integer control numbers. For example: 3,5-9,12. |
Min value: 1 |
credit | No | float | No | The amount to credit accounts. |
Max value: 99999999999.99998 Min value: 0.00001 Precision: 15, Scale: 5 |
expiration_date | No | date | Yes | The date from which accounts will become unusable. | |
force_terminate | No | int | No | Indicates that accounts should be terminated (ignoring associated non-disconnectable active sessions). | |
i_batch | No | unsignedLong | No | The unique ID of batch record. | |
i_customer_site | No | unsignedLong | Yes | The unique ID of Customer Site record. | |
i_distributor | No | unsignedLong | Yes | The unique ID of Distributor. | |
i_product | No | unsignedLong | No | The unique ID of Product record . | |
i_role | No | unsignedLong | No | The unique ID of the account's access role. | |
i_time_zone | No | unsignedLong | No | The unique ID of Time Zone record. | |
ivr_language | No | string | Yes | Preferred IVR language. |
Max value: 5 Min value: 2 |
life_time | No | int | Yes | Accounts will expire on the first usage time + lifetime days. |
Max value: 65535 Min value: 1 |
opening_balance | No | float | No | The initial balance of the account. |
Max value: 99999999999.99998 Min value: -9999999999.99999 Precision: 15, Scale: 5 |
reapply_subscriptions | No | int | No | Product subscriptions will be reapplied for accounts. | |
redirect_number | No | string | No | Associated number. |
Max value: 128 |
terminate | No | int | No | Indicates that accounts should be terminated. | |
unified_messaging | No | string | No | Enable/disable or set as defined by the product UM service feature. |
Possible values: ~, Y, N |
UpdateAccountsBatchResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
success | Yes | int | No | Returns 1 if accounts batch update has been successful. | |
warnings | No | ArrayOfString | No | Returns procedure warnings if any. |
get_call_barring_options | |
This method allows an API user to retrieve all available options for account call barring and check their status | |
Parameters | GetCallBarringOptionsRequest |
Return Value | GetCallBarringOptionsResponse |
Realm | administrator, reseller, retail customer, account |
Standalone mode support | Yes |
GetCallBarringOptionsRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
get_effective_values | No | int | No | Possible values: 1 - Retreive the call barring rules defined at the customer level; 0 - Retreive only those call barring rules that were defined for the account. | |
i_account | Yes | unsignedLong | No | The unique ID of the account. |
GetCallBarringOptionsResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
options | No | Array of CallBarringRuleInfo structure | Yes | Call barring options. |
update_call_barring_options | |
This method allows an API user to update options for account call barring, i.e. enable or disable the corresponding items | |
Parameters | UpdateCallBarringOptionsRequest |
Return Value | UpdateCallBarringOptionsResponse |
Realm | administrator, reseller, retail customer, account |
Standalone mode support | No |
UpdateCallBarringOptionsRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
i_account | Yes | unsignedLong | No | The unique ID of the account. | |
options | Yes | Array of CallBarringRuleInfo structure | No | Call barring options. |
UpdateCallBarringOptionsResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
success | Yes | int | No | 1 in case of success, 0 in case of failure. |
update_accounts_call_processing_mode | |
The method enables an API user to set the account call processing mode | |
Parameters | UpdateAccountCallProcessingModeRequest |
Return Value | UpdateAccountCallProcessingModeResponse |
Realm | administrator, reseller, retail customer, account |
Standalone mode support | No |
UpdateAccountCallProcessingModeRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
call_processing_mode_info | Yes | AccountCallProcessingModeInfo structure | No | The account call processing mode information. Note: short_code is mandatory; i_response_message/effective_to are optional; other fields are not applicable; the mode becomes effective immediately. | |
i_account | No | unsignedLong | No | Filters accounts by their internal ID. Note: at least one of the filters must be specified.. | |
i_batch | No | unsignedLong | No | Filters accounts by their customer batch ID. Note: at least one of the filters must be specified.. | |
i_c_group | No | unsignedLong | No | Filters accounts by huntgroup ID. Note: at least one of the filters must be specified.. | |
i_customer | No | unsignedLong | No | Filters accounts by customer ID. Note: at least one of the filters must be specified.. | |
i_customer_site | No | unsignedLong | No | Filters accounts by their customer site ID. Note: at least one of the filters must be specified.. | |
id | No | unsignedLong | No | Filters accounts by their ID. Note: at least one of the filters must be specified.. |
UpdateAccountCallProcessingModeResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
total | No | int | No | The total number of account candidates for updating call processing mode. | |
total_mode_changed | No | int | No | The number of accounts the call procesing mode was changed for. |
add_cp_condition | |
This method allows an API user to add a call screening condition | |
Parameters | AddCPConditionRequest |
Return Value | AddCPConditionResponse |
Realm | administrator, reseller, retail customer, account, representative |
Standalone mode support | No |
AddCPConditionRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
cp_condition_info | Yes | CPConditionInfo structure | No | Call screening condition structure. |
AddCPConditionResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
i_cp_condition | Yes | unsignedLong | No | The unique ID of the call screening condition record. |
add_cp_rule | |
This method allows an API user to create a new call screening rule | |
Parameters | AddCPRuleRequest |
Return Value | AddCPRuleResponse |
Realm | administrator, reseller, retail customer, account, representative |
Standalone mode support | No |
AddCPRuleRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
cp_rule_info | Yes | CPRuleInfo structure | No | Call screening rule info structure. Note: i_account is a mandatory field. |
AddCPRuleResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
i_cp_rule | Yes | unsignedLong | No | The unique ID of the call screening rule record. |
arrange_cp_rules | |
This method allows an API user to redefine the order in which call screening rules are applied | |
Parameters | ArrangeCPRulesRequest |
Return Value | ArrangeCPRulesResponse |
Realm | administrator, reseller, retail customer, account, representative |
Standalone mode support | No |
ArrangeCPRulesRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
i_account | Yes | unsignedLong | No | The unique ID of the account. | |
rules | Yes | Array of unsignedLong structure | No | Array of IDs of CPRuleInfo structures. |
ArrangeCPRulesResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
success | Yes | int | No | One of the following: 1 - success, 0 - failed. |
delete_cp_condition | |
This method enables an API user to delete an existing call screening condition | |
Parameters | DeleteCPConditionRequest |
Return Value | DeleteCPConditionResponse |
Realm | administrator, reseller, retail customer, account, representative |
Standalone mode support | No |
DeleteCPConditionRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
cp_condition_info | Yes | CPConditionInfo structure | No | Call screening condition. |
DeleteCPConditionResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
success | Yes | int | No | One of the following: 1 - success, 0 - failed. |
delete_cp_rule | |
This method allows an API user to delete an existing call screening rule | |
Parameters | DeleteCPRuleRequest |
Return Value | DeleteCPRuleResponse |
Realm | administrator, reseller, retail customer, account, representative |
Standalone mode support | No |
DeleteCPRuleRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
cp_rule_info | Yes | CPRuleInfo structure | No | The unique ID of the call screening rule record. |
DeleteCPRuleResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
success | Yes | int | No | One of the following: 1 - success, 0 - failed. |
get_cp_condition_info | |
This method enables an API user to retrieve the info about a call screening condition | |
Parameters | GetCPConditionInfoRequest |
Return Value | GetCPConditionInfoResponse |
Realm | administrator, reseller, retail customer, account, representative |
Standalone mode support | Yes |
GetCPConditionInfoRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
i_cp_condition | Yes | unsignedLong | No | The unique ID of the call screening condition record. |
GetCPConditionInfoResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
cp_condition_info | No | CPConditionInfo structure | No | Call screening condition structure. |
get_cp_condition_list | |
This method allows an API user to retrieve the list of call screening conditions defined for a given customer | |
Parameters | GetCPConditionListRequest |
Return Value | GetCPConditionListResponse |
Realm | administrator, reseller, retail customer, account, representative |
Standalone mode support | Yes |
GetCPConditionListRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
get_total | No | int | No | Get the total number of the retrieved call processing rule data records. | |
i_account | Yes | unsignedLong | No | The unique ID of the account. | |
limit | No | int | No | The number of rows to retrieve. | |
name | No | string | No | Name pattern of the condition. | |
offset | No | int | No | The number of rows to skip at the beginning of the list. |
Default value: 0 |
type | No | string | Yes | One of the following: FromNumber, ToNumber, TimeWindow. |
GetCPConditionListResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
cp_condition_list | No | Array of CPConditionInfo structure | No | Array of CPConditionInfo structures. | |
total | No | int | No | The total number of the retrieved call processing rule records. |
get_cp_rule_list | |
This method allows an API user to retrieve the information about defined call screening rules | |
Parameters | GetCPRuleListRequest |
Return Value | GetCPRuleListResponse |
Realm | administrator, reseller, retail customer, account, representative |
Standalone mode support | Yes |
GetCPRuleListRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
get_total | No | int | No | Get the total number of the retrieved rate data records. | |
i_account | Yes | unsignedLong | No | The unique ID of the account. | |
limit | No | int | No | The number of rows to retrieve. | |
offset | No | int | No | The number of rows to skip at the beginning of the list. |
GetCPRuleListResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
cp_rule_list | No | Array of CPRuleInfo structure | No | Array of CPRuleInfo structures. | |
total | No | int | No | The total number of records. |
update_cp_condition | |
This method allows an API user to update an existing call screening condition | |
Parameters | UpdateCPConditionRequest |
Return Value | UpdateCPConditionResponse |
Realm | administrator, reseller, retail customer, account, representative |
Standalone mode support | No |
UpdateCPConditionRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
cp_condition_info | Yes | CPConditionInfo structure | No | Call screening condition structure. |
UpdateCPConditionResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
i_cp_condition | Yes | unsignedLong | No | The unique ID of the call screening condition rule. |
update_cp_rule | |
This method allows an API user to update an existing call screening rule | |
Parameters | UpdateCPRuleRequest |
Return Value | UpdateCPRuleResponse |
Realm | administrator, reseller, retail customer, account, representative |
Standalone mode support | No |
UpdateCPRuleRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
cp_rule_info | Yes | CPRuleInfo structure | No | Call screening rule info structure. Note: i_account will be ignored. |
UpdateCPRuleResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
i_cp_rule | Yes | unsignedLong | No | The unique ID of the call screening rule record. |
assign_commitment | |
The method enables an API user to assign a commitment to an account | |
Parameters | AssignCommitmentRequest |
Return Value | AssignCommitmentResponse |
Realm | administrator, reseller |
Standalone mode support | No |
AssignCommitmentRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
i_account | Yes | unsignedLong | No | The identifier of the account record. | |
i_commitment | Yes | unsignedLong | No | The identifier of the commitment record. | |
min_terminate_date | No | date | No | The end date of the minimum period after which the commitment can be terminated without penalties. | |
sale_discount_configuration_list | No | Array of SaleDiscountConfigurationInfo structure | No | The list of the sale discounts configuration. Allows to apply additional discounts to the recurring charges configured on the commitment level. The sale discounts are applied along with the commitment discounts. The sale discount period can be bigger than the standard commitment discount period. | |
start_date | No | date | No | The date when the commitment services are enabled. The charges activation may be postponed by the config option 'Commitments.ActivationDelay'. |
AssignCommitmentResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
i_account_commitment | No | unsignedLong | No | The unique identifier of the account commitment record. |
cancel_scheduled_commitment_replacement | |
The method enables an API user to cancel a scheduled commitment replacement | |
Parameters | DeleteScheduledCommitmentRecordReplacementRequest |
Return Value | DeleteScheduledCommitmentRecordReplacementResponse |
Realm | administrator, reseller |
Standalone mode support | No |
DeleteScheduledCommitmentRecordReplacementRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
i_account_commitment | Yes | unsignedLong | No | The unique identifier of the account commitment record. |
DeleteScheduledCommitmentRecordReplacementResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
success | No | int | No | The result of the operation, or an exception in case of failure. |
cancel_scheduled_commitment_termination | |
The method enables an API user to cancel a scheduled commitment record replacement. All the rules for applying penalties will be reset | |
Parameters | CancelScheduledCommitmentTerminationRequest |
Return Value | CancelScheduledCommitmentTerminationResponse |
Realm | administrator, reseller |
Standalone mode support | No |
CancelScheduledCommitmentTerminationRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
i_account_commitment | No | unsignedLong | No | The unique identifier of the account commitment record. |
CancelScheduledCommitmentTerminationResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
success | No | int | No | The result of the operation, or an exception in case of failure. |
estimate_assigned_commitment_penalty_list | |
The method enables an API user to estimate the penalty for a commitment termination | |
Parameters | EstimateAssignedCommitmentPenaltyListRequest |
Return Value | EstimateAssignedCommitmentPenaltyListResponse |
Realm | administrator, reseller |
Standalone mode support | No |
EstimateAssignedCommitmentPenaltyListRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
commitment_one_time_term_list | No | Array of AccountCommitmentOneTimeTermInfo structure | No | The list of the one-time terms with the information whether the penalties should be applied. May be used for overwriting the global 'apply_penalties' flag. | |
commitment_recurring_term_list | No | Array of AccountCommitmentRecurringTermInfo structure | No | The list of the recurring terms with the information whether the penalties should be applied. May be used for overwriting the global 'apply_penalties' flag. | |
finish_date | Yes | date | No | The date when the commitment finishes. | |
i_account_commitment | Yes | unsignedLong | No | The unique identifier of the account commitment record. | |
penalty_period_from | No | date | No | Calculate penalties starting from the specified date. | |
penalty_period_to | No | date | No | Calculate penalties until the specified date. |
EstimateAssignedCommitmentPenaltyListResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
commitment_one_time_term_list | No | Array of AccountCommitmentOneTimeEstimateTermInfo structure | No | The list of the penalties for the one-time charges termination. | |
commitment_recurring_term_list | No | Array of AccountCommitmentRecurringEstimateTermInfo structure | No | The list of the penalties for the recurring charges termination. |
get_assigned_commitment_record_info | |
The method enables an API user to get the information about the commitment assigned to an account | |
Parameters | GetAssignedCommitmentRecordInfoRequest |
Return Value | GetAssignedCommitmentRecordInfoResponse |
Realm | administrator, reseller |
Standalone mode support | No |
GetAssignedCommitmentRecordInfoRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
i_account_commitment | Yes | unsignedLong | No | The unique identifier of the account commitment record. |
GetAssignedCommitmentRecordInfoResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
account_commitment_info | No | AccountCommitmentInfo structure | No | The account commitment record information. |
get_assigned_commitment_record_list | |
The method enables an API user to get the set of commitments assigned to an account | |
Parameters | GetAssignedCommitmentRecordListRequest |
Return Value | GetAssignedCommitmentRecordListResponse |
Realm | administrator, reseller |
Standalone mode support | No |
GetAssignedCommitmentRecordListRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
get_total | No | int | No | Get the total number of the retrieved records. | |
i_account | No | unsignedLong | No | The unique identifier of the account. | |
limit | No | int | No | The number of rows to retrieve. | |
offset | No | int | No | The number of rows to skip at the beginning of the list. |
Default value: 0 |
with_pause_times_left | No | int | No | The flag specifies whether it's required to return the number of times the commitment can be paused during the current year. |
GetAssignedCommitmentRecordListResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
account_commitment_list | No | Array of AccountCommitmentInfo structure | No | The set of account commitment records. | |
total | No | int | No | The total number of found records. |
get_assigned_commitment_terms | |
The method enables an API user to get account commitment terms associated with an assigned commitment | |
Parameters | GetAssignedCommitmentTermsRequest |
Return Value | GetAssignedCommitmentTermsResponse |
Realm | administrator, reseller |
Standalone mode support | No |
GetAssignedCommitmentTermsRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
i_account_commitment | No | unsignedLong | No | The unique identifier of the account commitment record. |
GetAssignedCommitmentTermsResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
commitment_one_time_term_list | No | Array of AccountCommitmentOneTimeTermInfo structure | No | The list of one-time terms associated with the account commitment record. | |
commitment_recurring_term_list | No | Array of AccountCommitmentRecurringTermInfo structure | No | The list of recurring terms associated with the account commitment record. |
get_scheduled_commitment_record_replacement_info | |
The method enables an API user to get the information about a scheduled commitment replacement | |
Parameters | GetScheduledCommitmentRecordReplacementRequest |
Return Value | GetScheduledCommitmentRecordReplacementResponse |
Realm | administrator, reseller |
Standalone mode support | No |
GetScheduledCommitmentRecordReplacementRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
i_account_commitment | Yes | unsignedLong | No | The unique identifier of the account commitment record. |
GetScheduledCommitmentRecordReplacementResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
account_commitment_replacement_info | No | ScheduledCommitmentReplacementInfo structure | No | The information about the scheduled account commitment replacement. |
pause_assigned_commitment_record | |
The method enables an API user to temporary pause commitment conditions. The recurring charges won't be applied and the services won't be provided during the pause | |
Parameters | PauseAssignedCommitmentRecordRequest |
Return Value | PauseAssignedCommitmentRecordResponse |
Realm | administrator, reseller |
Standalone mode support | No |
PauseAssignedCommitmentRecordRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
i_account_commitment | Yes | unsignedLong | No | The unique identifier of the account commitment record. | |
pause_from_date | No | date | No | Specifies the start date of the pause. | |
pause_to_date | No | date | No | Specifies the end date of the pause. |
PauseAssignedCommitmentRecordResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
success | No | int | No | The result of the operation, or an exception in case of failure. |
schedule_commitment_record_replacement | |
The method enables an API user to schedule a commitment replacement with a new one. The new addon product, specified in the request, will be assigned to the account until the specified replacement date | |
Parameters | ScheduleCommitmentRecordReplacementRequest |
Return Value | ScheduleCommitmentRecordReplacementResponse |
Realm | administrator, reseller |
Standalone mode support | No |
ScheduleCommitmentRecordReplacementRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
account_commitment_replacement_info | Yes | ScheduledCommitmentReplacementInfo structure | No | The information about the scheduled account commitment replacement. |
ScheduleCommitmentRecordReplacementResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
success | No | int | No | The result of the operation, or an exception in case of failure. |
terminate_assigned_commitment_record | |
The method enables an API user to terminate a commitment. The user may set custom rules for applying termination penalties to the commitment itself, or overwrite the rule for applying penalties for separate terms | |
Parameters | TerminateAssignedCommitmentRecordRequest |
Return Value | TerminateAssignedCommitmentRecordResponse |
Realm | administrator, reseller |
Standalone mode support | No |
TerminateAssignedCommitmentRecordRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
apply_penalties | No | string | No | The flag specifies whether the penalties should be applied for early termination (default: they should). It may be overwritten for the specific commitment terms. |
Possible values: Y, N |
apply_prev_penalty | No | string | No | The flag specifies whether the penalties should be applied from previous commitments (default: they should). |
Possible values: Y, N |
commitment_one_time_term_list | No | Array of AccountCommitmentOneTimeTermInfo structure | No | The list of the one-time terms with the information whether the penalties should be applied. May be used for overwriting the global 'apply_penalties' flag. | |
commitment_recurring_term_list | No | Array of AccountCommitmentRecurringTermInfo structure | No | The list of the recurring terms with the information whether the penalties should be applied. May be used for overwriting the global 'apply_penalties' flag. | |
finish_date | No | date | No | Specifies the date on which the commitment should be terminated. The services will be deactivated and the charges terminated on the specified date at the end of the day in the customer's timezone. If no date is specified, the commitment will be terminated on the same day, at the end of the day in the customer's timezone. If no date is specified and the commitment activation delay (specified by the Commitments.ActivationDelay config option) is not yet over, the commitment will be terminated immediately, the addons will be deactivated and the customer won't be charged. | |
i_account_commitment | No | unsignedLong | No | The unique identifier of the account commitment record. | |
penalty_period_from | No | date | No | Specifies the date staring from which the penalties are calculated. | |
penalty_period_to | No | date | No | Specifies the date until which the penalties are calculated. |
TerminateAssignedCommitmentRecordResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
success | No | int | No | The result of the operation, or an exception in case of failure. |
transfer_assigned_commitment_record | |
The method enables an API user to move an assigned commitment to another account | |
Parameters | TransferAssignedCommitmentRecordRequest |
Return Value | TransferAssignedCommitmentRecordResponse |
Realm | administrator, reseller |
Standalone mode support | No |
TransferAssignedCommitmentRecordRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
apply_transfer_fee | No | string | No | The flag specifies whether the transfer fee should be applied. |
Possible values: Y, N |
i_account_commitment | Yes | unsignedLong | No | The unique identifier of the account commitment record. | |
i_account_to | Yes | unsignedLong | No | The identifier of the account to move the commitment to. | |
i_new_commitment | No | unsignedLong | No | The unique identifier of the new commitment if the old one should be replaced. |
TransferAssignedCommitmentRecordResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
i_account_commitment | Yes | int | No | The transferred commitment record identifier. |
unpause_assigned_commitment_record | |
The method enables an API user to unpause a previously paused commitment record | |
Parameters | UnpauseAssignedCommitmentRecordRequest |
Return Value | UnpauseAssignedCommitmentRecordResponse |
Realm | administrator, reseller |
Standalone mode support | No |
UnpauseAssignedCommitmentRecordRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
i_account_commitment | No | unsignedLong | No | The unique identifier of the account commitment record. |
UnpauseAssignedCommitmentRecordResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
success | No | int | No | The result of the operation, or an exception in case of failure. |
update_assigned_commitment_record | |
The method enables an API user to update a commitment assigned to an account | |
Parameters | UpdateAssignedCommitmentRecordRequest |
Return Value | UpdateAssignedCommitmentRecordResponse |
Realm | administrator, reseller |
Standalone mode support | No |
UpdateAssignedCommitmentRecordRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
account_commitment_info | No | AccountCommitmentInfo structure | No | The updated account commitment info. |
UpdateAssignedCommitmentRecordResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
i_account_commitment | No | unsignedLong | No | The unique identifier of the account commitment record. |
get_custom_fields_schema | |
This method allows an API user to get the list of account's custom fields with information about their types and allowed values | |
Parameters | GetAccountCustomFieldsSchemaRequest |
Return Value | GetAccountCustomFieldsSchemaResponse |
Realm | administrator, reseller, retail customer, account, distributor, cc staff, representative |
Standalone mode support | Yes |
GetAccountCustomFieldsSchemaRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
i_account | Yes | unsignedLong | No | The unique ID of the account record. If not provided, the ID of the entity that is logged in will be used. |
GetAccountCustomFieldsSchemaResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
custom_fields | No | Array of AccountCustomFieldsInfo structure | Yes | The list of Custom Fields with information for the given account. |
get_custom_fields_values | |
This method allows an API user to get the list of account's custom fields | |
Parameters | GetAccountCustomFieldsValuesRequest |
Return Value | GetAccountCustomFieldsValuesResponse |
Realm | administrator, reseller, retail customer, account, representative |
Standalone mode support | Yes |
GetAccountCustomFieldsValuesRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
i_account | Yes | unsignedLong | No | The unique ID of the account record. |
GetAccountCustomFieldsValuesResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
custom_fields_values | No | Array of CustomFieldsValuesInfo structure | Yes | The list of Custom Fields values for the given account. |
update_custom_fields_values | |
This method allows an API user to modify customer's custom fields | |
Parameters | UpdateAccountCustomFieldsValuesRequest |
Return Value | UpdateAccountCustomFieldsValuesResponse |
Realm | administrator, reseller, retail customer, account, representative |
Standalone mode support | No |
Request example |
|
Response example |
|
UpdateAccountCustomFieldsValuesRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
custom_fields_values | Yes | Array of CustomFieldsValuesInfo structure | Yes | The list of Custom Fields values for the given account. | |
i_account | No | unsignedLong | No | The unique ID of the account record. |
UpdateAccountCustomFieldsValuesResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
custom_fields_values | No | Array of CustomFieldsValuesInfo structure | Yes | The list of Custom Fields values for the given account. | |
i_account | No | unsignedLong | Yes | The unique ID of the account record. |
add_preferable_account | |
This method enables an API user to add a record to the account’s Favourites list | |
Parameters | AddPreferableAccountRequest |
Return Value | AddPreferableAccountResponse |
Realm | administrator, reseller, retail customer, account |
Standalone mode support | No |
AddPreferableAccountRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
preferable_account_info | Yes | PreferableAccountInfo structure | No | Information about a frequently used account. |
AddPreferableAccountResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
i_preferable_account | Yes | unsignedLong | No | The unique ID of the frequently used account. |
delete_preferable_account | |
This method enables an API user to delete a record in the account’s Favourites list | |
Parameters | DeletePreferableAccountRequest |
Return Value | DeletePreferableAccountResponse |
Realm | administrator, reseller, retail customer, account |
Standalone mode support | No |
DeletePreferableAccountRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
i_preferable_account | Yes | unsignedLong | No | The unique ID of the frequently used account. |
DeletePreferableAccountResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
success | No | int | No | One of the following: 1 - success, 0 - failed. |
get_preferable_account | |
This method enables an API user to obtain information about the account’s Favourites list record | |
Parameters | GetPreferableAccountRequest |
Return Value | GetPreferableAccountResponse |
Realm | administrator, reseller, retail customer, account |
Standalone mode support | Yes |
GetPreferableAccountRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
i_preferable_account | Yes | unsignedLong | No | The unique ID of the frequently used account. |
GetPreferableAccountResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
preferable_account_info | No | PreferableAccountInfo structure | No | Information about a frequently used account. |
get_preferable_account_list | |
This method enables an API user to obtain the list of the account’s Favourites list records | |
Parameters | GetPreferableAccountListRequest |
Return Value | GetPreferableAccountListResponse |
Realm | administrator, reseller, retail customer, account |
Standalone mode support | Yes |
GetPreferableAccountListRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
get_total | No | int | No | Get the total number of the retrieved frequently used accounts. | |
group_name | No | string | No | The name used to group frequently used accounts. | |
i_owner_account | Yes | unsignedLong | No | The unique ID of the owner account for a frequently used account. | |
limit | No | int | No | The number of rows to retrieve. Mandatory for an API request with the offset property specified. |
Max value: 1000 Min value: 1 |
offset | No | int | No | The number of rows to skip at the beginning of the list. Requires the limit property to be specified in the API request. |
Default value: 0 Max value: 4294967295 Min value: 0 |
GetPreferableAccountListResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
preferable_account_list | No | Array of PreferableAccountInfo structure | No | The list of frequently used accounts. | |
total | No | int | No | The number of the retrieved frequently used accounts. |
update_preferable_account | |
This method enables an API user to update a record in the account’s Favourites list | |
Parameters | UpdatePreferableAccountRequest |
Return Value | UpdatePreferableAccountResponse |
Realm | administrator, reseller, retail customer, account |
Standalone mode support | No |
UpdatePreferableAccountRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
preferable_account_info | Yes | PreferableAccountInfo structure | No | Information about a frequently used account. |
UpdatePreferableAccountResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
i_preferable_account | Yes | unsignedLong | No | The unique ID of the frequently used account. |
add_followme_number | |
This method allows an API user to add a new follow-me entry (number) associated with an account. If successful, a new ID number is returned. Note: the newly added number becomes the last entry in the list of the account’s follow-me numbers | |
Parameters | AddFollowMeNumberRequest |
Return Value | AddUpdateFollowMeNumberResponse |
Realm | administrator, reseller, retail customer, account, representative |
Standalone mode support | No |
AddFollowMeNumberRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
number_info | No | FollowMeNumberInfo structure | No | Follow-me number to be added to account's follow-me entries. |
AddUpdateFollowMeNumberResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
i_follow_me_number | Yes | unsignedLong | No | ID of follow-me number database record. |
add_followme_number_list | |
This method allows an API user to add a list of follow-me entries (numbers) associated with an account | |
Parameters | AddFollowMeNumberListRequest |
Return Value | AddUpdateFollowMeNumberListResponse |
Realm | administrator, reseller, retail customer, account, representative |
Standalone mode support | No |
AddFollowMeNumberListRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
followme_numbers | No | Array of FollowMeNumberInfo structure | No | Array of Follow-me numbers is to be added to account's follow-me entries. |
AddUpdateFollowMeNumberListResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
success | No | int | No | Follow-Me numbers are saved and valid. |
arrange_followme_numbers | |
This method arranges follow-me entries in a specified order | |
Parameters | ArrangeFollowMeNumbersRequest |
Return Value | ArrangeFollowMeNumbersResponse |
Realm | administrator, reseller, retail customer, account |
Standalone mode support | No |
ArrangeFollowMeNumbersRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
i_account | Yes | unsignedLong | No | The unique ID of the account record. | |
numbers | No | Array of unsignedLong structure | No | The list of i_follow_me_number values in the desired order; this may be partial, i.e. it is possible to swap the first two numbers, providing two values only. |
ArrangeFollowMeNumbersResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
success | Yes | int | No | 1 in case of success, 0 in case of failure. |
delete_followme_number | |
This method allows an API user to delete an existing follow-me entry (number) associated with the account. It requires an ID number returned, for example, by the add_followme_number method | |
Parameters | DeleteFollowMeNumberRequest |
Return Value | DeleteFollowMeNumberResponse |
Realm | administrator, reseller, retail customer, account |
Standalone mode support | No |
DeleteFollowMeNumberRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
i_follow_me_number | Yes | unsignedLong | No | ID of follow-me number database record to be deleted. |
DeleteFollowMeNumberResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
success | Yes | int | No | 1 in case of success, 0 in case of failure. |
get_account_followme | |
This method retrieves the follow-me settings associated with an account. Follow-me entries (numbers) are returned in the order of their priority | |
Parameters | GetAccountFollowMeRequest |
Return Value | GetAccountFollowMeResponse |
Realm | administrator, reseller, retail customer, account, representative |
Standalone mode support | Yes |
GetAccountFollowMeRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
i_account | No | unsignedLong | No | The unique ID of the account record. | |
i_follow_me | No | unsignedLong | No | ID of the Follow_Me record. | |
with_period_definition | No | unsignedLong | No | If set, each follow-me number will contain a 'period_definition' field in the response. |
GetAccountFollowMeResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
default_followme_numbers_timeout | No | int | No | The default number of seconds to wait until a call is answered. | |
followme_info | No | FollowMeInfo structure | No | Follow-me settings associated with the account. | |
followme_numbers | No | Array of FollowMeNumberInfo structure | No | The list of follow-me numbers associated with the account. |
update_account_followme | |
This method allows an API user to update the follow-me settings associated with an account. It does not add or update follow-me entries | |
Parameters | UpdateAccountFollowMeRequest |
Return Value | UpdateAccountFollowMeResponse |
Realm | administrator, reseller, retail customer, account, representative |
Standalone mode support | No |
UpdateAccountFollowMeRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
followme_info | Yes | FollowMeInfo structure | No | Follow-me settings associated with the account. | |
i_account | Yes | unsignedLong | No | The unique ID of the account record. |
UpdateAccountFollowMeResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
i_follow_me | Yes | unsignedLong | No | The unique ID of the follow-me database record. |
update_followme_number | |
This method allows an API user to update an existing follow-me entry (number) associated with an account. It requires an ID number returned, for example, by the add_followme_number method | |
Parameters | UpdateFollowMeNumberRequest |
Return Value | AddUpdateFollowMeNumberResponse |
Realm | administrator, reseller, retail customer, account, representative |
Standalone mode support | No |
UpdateFollowMeNumberRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
i_follow_me_number | Yes | unsignedLong | No | ID of follow-me number database record to be updated. | |
number_info | Yes | FollowMeNumberInfo structure | No | Follow-me number to be added to account's follow-me entries. |
update_followme_number_list | |
This method enables an API user to update, add or remove numbers from the list of follow-me entries associated with an account. It requires an ID number to be returned, for example, by the add_followme_number method. For adding new follow-me entries to the list, this method requires specifying such parameters as i_follow_me, name, redirect_number, and active. For removing unnecessary follow-me entries from the list, their IDs must not be included in the request | |
Parameters | UpdateFollowMeNumberListRequest |
Return Value | AddUpdateFollowMeNumberListResponse |
Realm | administrator, reseller, retail customer, account, representative |
Standalone mode support | No |
UpdateFollowMeNumberListRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
followme_numbers | No | Array of FollowMeNumberInfo structure | No | Array of Follow-me number to be updated. |
get_account_state | |
This method allows an administrator to obtain the current condition applied to the account by the Fraud Prevention feature (e.g. Active, Screened, Quarantined) | |
Parameters | GetAccountStateRequest |
Return Value | GetAccountStateResponse |
Realm | administrator, reseller |
Standalone mode support | Yes |
GetAccountStateRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
i_acc_state_type | No | unsignedLong | No | The unique ID of the account state type: 1 - voice_fraud_suspicion. This property is mandatory if state_name and service_type are not specified. | |
i_account | Yes | unsignedLong | No | The unique ID of the account record. | |
service_type | No | string | No | The name of the service type. This property is mandatory if i_acc_state_type is not specified. |
Possible values: INTERNAL, SESSION, VOICE, DATA, NETACCESS, QUANTITY, WIFI, DIALUP, MSG, CONFERENCE |
state_name | No | string | No | The name of the account state type. This property is mandatory if i_acc_state_type is not specified. |
Possible values: voice_fraud_suspicion |
GetAccountStateResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
value | No | int | No | The state of the account. Possible values: 0 - ACTIVE, 1 - SCREENED - Allow calls only via the Screening IVR, 2 - SCREENED - Allow calls only via the Screening IVR. A caller failed to validate that they are an authorized user once, 3 - SCREENED - Allow calls only via the Screening IVR. A caller failed to validate that they are an authorized user twice, 4 - SCREENED - Allow calls only via the Screening IVR. A caller failed to validate that they are an authorized user three times, 5 - QUARANTINED - Disallow all calls. |
set_account_state | |
This method allows an administrator to change the account's condition for the Fraud Prevention feature (e.g. Active, Screened, Quarantined) | |
Parameters | SetAccountStateRequest |
Return Value | SetAccountStateResponse |
Realm | administrator, reseller |
Standalone mode support | No |
SetAccountStateRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
i_acc_state_type | No | unsignedLong | No | The unique ID of the account state type: 1 - voice_fraud_suspicion This property is mandatory if state_name and service_type are not specified. | |
i_account | Yes | unsignedLong | No | The unique ID of the account record. | |
notify_users | No | int | No | Specifies whether the state change notification should be triggered for administrators (the notification for customers is always triggered). | |
service_type | No | string | No | The name of the service type. This property is mandatory if i_acc_state_type is not specified. |
Possible values: INTERNAL, SESSION, VOICE, DATA, NETACCESS, QUANTITY, WIFI, DIALUP, MSG, CONFERENCE |
state_name | No | string | No | The name of the account state type. Possible value: voice_fraud_suspicion service_type. This property is mandatory if i_acc_state_type is not specified. |
Possible values: voice_fraud_suspicion |
value | Yes | int | No | The state of the account. Possible values: 0 - ACTIVE; 1 - SCREENED - Allow calls only via the Screening IVR; 2 - SCREENED - Allow calls only via the Screening IVR. A caller failed to validate that they are an authorized user once; 3 - SCREENED - Allow calls only via the Screening IVR. A caller failed to validate that they are an authorized user twice; 4 - SCREENED - Allow calls only via the Screening IVR. A caller failed to validate that they are an authorized user three times; 5 - QUARANTINED - Disallow all calls. |
Max value: 5 Min value: 0 |
SetAccountStateResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
success | Yes | int | No | Indicates whether the account's state setting was: 1 - successful, 0 - unsuccessful. |
update_huntgroups_subscription | |
This method enables an account to subscribe to or unsubscribe from the assigned huntgroups | |
Parameters | UpdateHuntgroupsSubscriptionRequest |
Return Value | UpdateHuntgroupsSubscriptionResponse |
Realm | administrator, retail customer, account |
Standalone mode support | No |
UpdateHuntgroupsSubscriptionRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
i_account | Yes | unsignedLong | No | The unique ID of the account. | |
subscribe_to_huntgroups | No | Array of HGSubscriptionInfo structure | No | The list of huntgroups that the account needs to log in to. Note: 'unsubscribe_from_huntgroups' takes precedence over the 'subscribe_to_huntgroups', so the same huntgroup passed in subscribe and unsubscribe field will result in unsubscribing from that huntgroup. | |
unsubscribe_from_huntgroups | No | Array of HGSubscriptionInfo structure | No | The list of huntgroups that the account needs to log out from. Note: 'unsubscribe_from_huntgroups' takes precedence over the 'subscribe_to_huntgroups', so the same huntgroup passed in subscribe and unsubscribe field will result in unsubscribing from that huntgroup. |
UpdateHuntgroupsSubscriptionResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
success | Yes | int | No | The success flag. Possible values: 1 - the operation was successful. |
assign_cpe_ports_list | |
This method enables an API user to assign CPE ports to an account | |
Parameters | AssignCPEPortsListRequest |
Return Value | AssignCPEPortsListResponse |
Realm | administrator, reseller, retail customer |
Standalone mode support | No |
AssignCPEPortsListRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
cpe_ports_list | Yes | Array of CPEPortShortInfo structure | No | The list of information about CPE ports. | |
i_account | Yes | unsignedLong | No | The account identifier. Used to define the account to which the ports of the CPE will be assigned. |
AssignCPEPortsListResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
success | Yes | int | No | The status of adding CPE ports to an account. Possible values: 1 - all CPE ports added to the account, 0 - some or all ports were not added.. | |
warnings | No | ArrayOfString | No | The warnings, if any, for CPE ports that are not added. |
assign_ua | |
This method allows an API user to assign a UA to an account | |
Parameters | AssignUARequest |
Return Value | AssignUAResponse |
Realm | administrator, reseller |
Standalone mode support | No |
AssignUARequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
i_account | Yes | unsignedLong | No | The unique ID of the account record. | |
i_ua | Yes | unsignedLong | No | ID of UA record. | |
port | No | int | No | UA port used by this account. Note: if the type of UA is PortaPhone, the port field is not mandatory. |
Min value: 1 |
ports_config_list | No | Array of AssignMultiserviceUAPortInfo structure | No | List of ports configuration. Only for multiservice devices. Substitutes the 'port' field if passed. |
AssignUAResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
success | No | int | No | 1 in case of success, 0 in case of failure. |
get_assigned_cpe_ports_list | |
This method enables an API user to get the information about the CPE ports that are assigned to the account. | |
Parameters | GetAccountAssignedCPEPortsListRequest |
Return Value | GetAssignedCPEPortsListResponse |
Realm | administrator, reseller, retail customer |
Standalone mode support | Yes |
GetAccountAssignedCPEPortsListRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
i_account | Yes | unsignedLong | No | The identifier of the account searched for. |
GetAssignedCPEPortsListResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
assigned_cpe_ports_list | Yes | Array of AssignedCPEPortInfo structure | No | The assigned CPE ports list. |
release_ua | |
This method allows an API user to release an account's UA | |
Parameters | ReleaseUARequest |
Return Value | ReleaseUAResponse |
Realm | administrator, reseller, retail customer |
Standalone mode support | No |
ReleaseUARequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
i_account | No | unsignedLong | No | The identifier of the account. Used to release all account's UAs. Note: either i_account or i_ua_link must be specified.. | |
i_ua_link | No | unsignedLong | No | The identifier of the UA link. Used to release a specific account's UA, has a higher priority. Note: either i_account or i_ua_link must be specified.. |
ReleaseUAResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
success | No | int | No | 1 in case of success, 0 in case of failure. |
get_account_product_info | |
This method allows an API user to get the information about the account's product | |
Parameters | GetAccountProductInfoRequest |
Return Value | GetProductInfoResponse |
Realm | retail customer, account |
Standalone mode support | Yes |
GetAccountProductInfoRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
i_account | Yes | unsignedLong | No | The unique ID of the account record. |
GetProductInfoResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
product_info | No | ProductInfo structure | No | The product information. |
get_member_of_huntgroups_list | |
This method allows an API user to get account's huntgroup | |
Parameters | GetMemberOfHuntgroupsList |
Return Value | GetHGListInfoResponse |
Realm | retail customer, account |
Standalone mode support | Yes |
GetMemberOfHuntgroupsList | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
i_account | Yes | unsignedLong | No | The unique ID of the account record. |
GetHGListInfoResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
huntgroup_list | No | Array of HGInfo structure | No | The list of huntgroups. | |
total | No | int | No | Number of huntgroups. |
get_moh_list_info | |
This method allows an API user to get the list of account's music on hold entries | |
Parameters | GetAccountMOHListInfoRequest |
Return Value | GetAccountMOHListInfoResponse |
Realm | retail customer, account |
Standalone mode support | Yes |
GetAccountMOHListInfoRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
i_account | Yes | unsignedLong | No | The unique ID of the account record. |
GetAccountMOHListInfoResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
moh_list_info | No | AccountMOHListInfo structure | No | Account MOH List object. |
get_permitted_sip_proxies_info | |
This method allows an API user to get the list of permitted IP addresses for proxying | |
Parameters | GetAccountPermittedProxyInfoRequest |
Return Value | GetAccountPermittedProxyInfoResponse |
Realm | retail customer, account |
Standalone mode support | Yes |
GetAccountPermittedProxyInfoRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
i_account | Yes | unsignedLong | No | The unique ID of the account record. |
GetAccountPermittedProxyInfoResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
is_add_new_sip_proxy_allowed | No | int | No | Indicates whether the adding of a new proxy is allowed. | |
permitted_sip_proxies | No | Array of PermittedSipProxiesInfo structure | Yes | The list of permitted SIP proxies. |
get_service_wallet_xdr_list | |
This method enables the user to fetch the Account Service Wallet XDRs | |
Parameters | GetAccountSWXDRListRequest |
Return Value | GetAccountSWXDRListResponse |
Realm | administrator, reseller, retail customer, account |
Standalone mode support | Yes |
GetAccountSWXDRListRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
connect_time_after | No | dateTime | No | Get xDRs with connect_time after this date. | |
connect_time_before | No | dateTime | No | Get xDRs with connect_time before this date. | |
from_date | Yes | dateTime | No | Get xDRs with bill_time starting from this date. | |
get_total | No | int | No | Get the total number of the retrieved xDRs. |
Default value: 0 Max value: 1 Min value: 0 |
history_pattern | No | string | Yes | Specifies whether to show xDRs with history that matches the pattern. | |
i_account | Yes | unsignedLong | No | The unique ID of the account record. Not mandatory when the method that requires this structure is executed from the account realm. | |
i_dest_group | No | unsignedLong | No | The unique ID of the destination group. | |
limit | No | int | No | The number of rows to retrieve. Mandatory for an API request with the offset property specified. |
Min value: 0 |
offset | No | int | No | The number of rows to skip at the beginning of the list. Requires the limit property to be specified in the API request. |
Min value: 0 |
to_date | Yes | dateTime | No | Get xDRs with bill_time before this date. | |
with_aux_xdrs | No | int | No | Includes the array of auxiliary xDRs to the retrieved xDRs list. | |
with_usage | No | int | No | Includes usage records to the retrieved xDRs list. |
GetAccountSWXDRListResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
total | No | int | No | The number of the retrieved xDRs. | |
xdr_list | Yes | Array of ServiceWalletXDRInfo structure | No | Array of the account service wallet xDRs and taxes. |
get_services_consumption | |
This method allows an API user to get the information about services consumed by an account | |
Parameters | GetAccountConsumedServiceRequest |
Return Value | GetAccountConsumedServiceResponse |
Realm | administrator, reseller, retail customer, account |
Standalone mode support | Yes |
GetAccountConsumedServiceRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
from_date | No | dateTime | No | Include xDRs starting from this date. Note: matches xDRs with bill time after this date.. | |
get_total | No | int | No | Indicates whether to include the total number of retrieved services in the response. Possible values: 0 - don't include the total number of matched records; 1 - include the total number of matched records.. |
Default value: 0 |
group_by_roaming | No | int | No | Indicates whether xDRs will be grouped by their roaming status. Possible values: 1 - group xDRs by their roaming status; 0 - don't group xDRs.. | |
i_account | No | unsignedLong | No | The unique ID of the account record. | |
i_invoice | No | unsignedLong | No | Indicates what xDRs will be included. Possible values: null - Midterm xDRs and out-of-turn xDRs; 0 - Out-of-turn xDRs; Not set - xDRs of all types.. | |
i_service | No | unsignedLong | No | The unique ID of the service record. | |
limit | No | int | No | The number of rows to retrieve. |
Default value: 50 |
offset | No | int | No | The number of rows to skip at the beginning of the list. |
Default value: 0 |
show_hidden | No | int | No | Specifies whether hidden xDRs will be included in the response. Note: the default value is 1; the field is available for administrators only.. | |
show_unsuccessful | No | int | No | Indicates whether to include xDRs of unsuccessful attempts. Possible values: 1 - include xDRs of unsuccessful attempts; 0 - don't include xDRs of unsuccessful attempts.. | |
to_date | No | dateTime | No | Include xDRs before this date. Note: matches xDRs with bill time before this date. |
GetAccountConsumedServiceResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
consumed_service_list | No | Array of ConsumedServiceInfo structure | Yes | The list of ConsumedServices records. | |
total | No | int | No | The total number of the retrieved services. |
get_sip_status | |
This method allows an API user to check if an account is currently being used by a SIP UA to register with the SIP server and retrieve registration information, such as the user agent’s identification or URI | |
Parameters | GetSipStatusRequest |
Return Value | GetSipStatusResponse |
Realm | administrator, reseller, representative |
Standalone mode support | Yes |
GetSipStatusRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
i_account | Yes | unsignedLong | No | The unique ID of the account record. |
GetSipStatusResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
additional_sip_info_list | No | Array of SipStatusInfo structure | No | Additional information about SIP UA registrations. | |
sip_info | No | SipStatusInfo structure | No | Information about SIP UA registration. | |
sip_status | No | int | Yes | 1 - online (account is used by SIP UA to register with the SIP server), 0 - offline. |
get_status_history | |
This method allows an API user to retrieve account status change history | |
Parameters | GetAccountStatusHistoryRequest |
Return Value | GetAccountStatusHistoryResponse |
Realm | administrator, reseller, retail customer |
Standalone mode support | Yes |
GetAccountStatusHistoryRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
i_account | Yes | unsignedLong | No | The unique ID of the account record. | |
i_status | No | unsignedLong | No | The unique ID of the status record. Enables retrieving account history by the status. One of the following status options is possible: 1 - 'Open'; 2 - 'Closed'; 3 - 'Inactive'. |
Possible values: 1, 2, 3 |
limit | No | int | No | The number of rows to retrieve. Mandatory for an API request with the offset property specified. | |
offset | No | int | No | The number of rows to skip at the beginning of the list. Requires the limit property to be specified in the API request. |
Default value: 0 |
GetAccountStatusHistoryResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
status_history_list | Yes | Array of StatusHistoryInfo structure | Yes | The list of account status changes. |
get_vd_counter_history_list | |
The method enables an API user to retrieve a list of the counter updates | |
Parameters | GetAccountVdCounterHistoryListRequest |
Return Value | GetAccountVdCounterHistoryListResponse |
Realm | administrator, reseller, retail customer, account |
Standalone mode support | Yes |
GetAccountVdCounterHistoryListRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
get_total | No | int | No | Include the total number of records. | |
i_avd_counter | Yes | unsignedLong | No | The ID of the Counter record from Account_VD_Counters table. | |
i_xdr | No | unsignedLong | No | The ID of the xDR record from CDR_Accounts table. | |
limit | No | int | No | The number of records to retrieve. | |
offset | No | int | No | The number of records to skip at the beginning. |
Default value: 0 |
GetAccountVdCounterHistoryListResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
total | No | int | No | The total number of the retrieved records. | |
vd_counter_history_list | No | Array of AccountVdCounterHistoryInfo structure | No | The list of the counter updates. |
get_vd_notification_list | |
The method enables an API user to retrieve the list of volume discount notifications for the account | |
Parameters | GetAccountVdNotificationListRequest |
Return Value | GetAccountVdNotificationListResponse |
Realm | administrator |
Standalone mode support | Yes |
GetAccountVdNotificationListRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
addon_priority | No | int | No | The add-on product's precedence level. If there are more than one add-on products assigned to an account they will be sorted according to the specified precedence level. Possible values: 0 - Main product, 10 - Low, 15 - Medium low, 20 - Medium, 25 - Medium high, 30 - High. |
Possible values: 0, 10, 15, 20, 25, 30, 255 |
get_total | No | int | No | Include the total number of records. | |
i_account | No | unsignedLong | No | The unique ID of the account record. | |
i_dest_group | No | unsignedLong | No | The unique ID of the destination group to apply the top-up to. | |
i_service | No | unsignedLong | No | The unique ID of the service record. | |
limit | No | int | No | The number of records to retrieve. | |
offset | No | int | No | The number of records to skip at the beginning. |
Default value: 0 |
peak_level | No | int | No | Possible values: 0 - The peak period; 1 - The off-peak period; 2 - The 2nd off-peak period. |
Possible values: 0, 1, 2 |
GetAccountVdNotificationListResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
total | No | int | No | The total number of the retrieved records. | |
vd_notification_list | No | Array of AccountVdNotificationInfo structure | No | The list of the notifications. |
get_xdr_list | |||||||
This method retrieves Account XDR records | |||||||
Parameters | GetAccountXDRListRequest | ||||||
Return Value | GetAccountXDRListResponse | ||||||
Realm | administrator, reseller, account, retail customer, representative | ||||||
Standalone mode support | No | ||||||
Attachments |
|
GetAccountXDRListRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
call_id | No | string | No | Filters xDRs by the identifier of the call. | |
call_recording | No | int | No | Filters xDRs by the available call recordings. Possible values: 1 - match only the xDRs with available call recording; 0 - match xDRs without call recording available.. | |
cld | No | string | No | Filters xDRs by the Called Line Identification. Note: use % as a wildcard: %value - ends with value; value% - starts with value; %value% - contains value. The UI equivalent of this field is the "To (CLI)" input field on the Account xDRs search page.. | |
cli | No | string | No | Filters xDRs by the Calling Line Identification. Note: use % as a wildcard: %value - ends with value; value% - starts with value; %value% - contains value. The UI equivalent of this field is the "From (CLI)" input field on the Account xDRs search page.. | |
connect_time_after | No | dateTime | No | Filters xDRs by connect time. Note: matches xDRs with connect_time after this date.. | |
connect_time_before | No | dateTime | No | Filters xDRs by connect time. Note: matches xDRs with connect_time before this date.. | |
enable_safe_mode | No | int | No | The flag indicates whether to check the amount of data before processing. Note: if the number of xDRs found is too many, an exception will be thrown; the max number of xDRs is configured via the configurator in option [API]MaxxDRsToProcess. Possible values: 1 - check the number of matched xDRs; 0 - don't check the number of xDRs matched.. | |
format | No | string | No | Shows the format of the output file when downloading xDRs. Possible values: csv.. | |
from_date | No | dateTime | No | Filters xDRs by the billing time. Note: matches the xDRs with the billing time after this date. The UI equivalent of this field is the "From date" input field on the Account xDRs search page.. | |
get_split_xdrs | No | int | No | Indicates whether to include split xDRs information in the response. Possible values: 0 - don't include split xDRs information in the response; 1 - include split xDRs information in the response.. | |
get_total | No | int | No | Indicates whether to include the total number of matched xDRs in the response. Possible values: 0 - don't include the total value in the response; 1 - include the total value in the response.. |
Default value: 0 |
h323_conf_id | No | string | No | Filters xDRs by the session identifier. | |
history_pattern | No | string | No | Filters xDRs by the history that matches the pattern. Note: use % as a wildcard: %value - ends with value; value% - starts with value; %value% - contains value. Possible values: null - match xDRs without history value; any text value - matches the pattern.. | |
i_account | No | unsignedLong | No | Filters xDRs by the ID of the account associated with the xDR. | |
i_dest_group | No | unsignedLong | No | Filters xDRs by the ID of the destination group. | |
i_service | No | unsignedLong | Yes | Filters xDRs by the ID of the service. The UI equivalent of this field is the "Service" input field on the Account xDRs search panel.. | |
i_service_type | No | unsignedLong | No | Filters xDRs by the ID of the service type for the service associated with the xDR. | |
limit | No | int | Yes | The number of rows to return in the response. |
Default value: 0 |
offset | No | int | Yes | The number of rows to skip at the beginning of the list. |
Default value: 0 |
quality | No | string | No | Filters xDRs by the call quality. Possible values: good, fair, poor, or unknown.. |
Possible values: unknown, poor, fair, good |
roaming | No | int | No | Filters xDRs by the roaming status. | |
show_unsuccessful | No | int | No | Indicates whether to include the xDRs of unsuccessful attempts. Possible values: 1 - include the xDRs of unsuccessful attempts; 0 - don't include the xDRs of unsuccessful attempts. The UI equivalent of this field is the "Show unsuccessful attempts" switch on the Account xDRs search page.. | |
to_date | No | dateTime | No | Filters xDRs by the billing time. Note: matches the xDRs with the billing time before this date The UI equivalent of this field is the "To date" input field on the Account xDRs search page.. | |
with_cr_download_ids | No | int | No | Indicates whether to include the IDs for the recorded files. Possible values: 0 - don't include the call recording IDs for every xDRs in the response (when available); 1 - include the call recording IDs for every xDRs in the response (when available).. | |
with_netaccess_usage | No | int | No | Indicates whether to include the bytes_downloaded and bytes_uploaded fields for every netaccess xDR in the response. Possible values: 0 - don't include the bytes_downloaded and bytes_uploaded fields for every netaccess xDR; 1 - include the bytes_downloaded and bytes_uploaded' fields for every netaccess xDR.. |
GetAccountXDRListResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
total | No | int | No | The total number of xDRs found. | |
xdr_list | Yes | Array of AccountXDRInfo structure | No | The list of xDRs. |
get_xdr_quality_info | |
The method enables an API user to fetch the information about XDR metric data | |
Parameters | GetAccountXDRQualityInfoRequest |
Return Value | GetAccountXDRQualityInfoResponse |
Realm | administrator, reseller |
Standalone mode support | Yes |
GetAccountXDRQualityInfoRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
id | Yes | unsignedLong | No | ID of the xDR record. |
GetAccountXDRQualityInfoResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
quality_info | No | XDRQualityMetricInfo structure | Yes | The information about xDR quality metrics. |
mark_xdr_out_of_turn | |
This method allows an administrator to include a transaction on an out-of-turn invoice to be issued on demand | |
Parameters | MarkXdrOutOfTurnRequest |
Return Value | MarkXdrOutOfTurnResponse |
Realm | administrator, reseller |
Standalone mode support | No |
MarkXdrOutOfTurnRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
i_xdr | Yes | unsignedLong | No | The unique ID of the xDR record. |
MarkXdrOutOfTurnResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
success | Yes | int | No | 1 for success, 0 for failure. |
add_allowed_location | |
This method enables an API user to add a new allowed location | |
Parameters | AddAllowedLocationRequest |
Return Value | AddAllowedLocationResponse |
Realm | administrator, reseller |
Standalone mode support | No |
AddAllowedLocationRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
allowed_location_info | No | AllowedLocationInfo structure | No | Allowed location information. |
AddAllowedLocationResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
i_a_verified_locations | Yes | unsignedLong | No | The ID of the account's allowed location record. |
delete_allowed_location | |
This method enables an API user to delete an allowed location | |
Parameters | DeleteAllowedLocationRequest |
Return Value | DeleteAllowedLocationResponse |
Realm | administrator, reseller |
Standalone mode support | No |
DeleteAllowedLocationRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
i_a_verified_locations | Yes | unsignedLong | No | The ID of the account's allowed location record. |
DeleteAllowedLocationResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
success | No | int | No | 1 in case of success, 0 in case of failure. |
get_allowed_location_list | |
This method enables an API user to get the list of allowed locations | |
Parameters | GetAllowedLocationListRequest |
Return Value | GetAllowedLocationListResponse |
Realm | administrator, reseller |
Standalone mode support | Yes |
GetAllowedLocationListRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
get_total | No | int | No | Get the total number of the retrieved allowed locations. | |
i_account | Yes | unsignedLong | No | The unique ID of the account record. | |
limit | No | int | No | The number of rows to retrieve. | |
offset | No | int | No | The number of rows to skip at the beginning of the list. |
Default value: 0 |
period_from | No | dateTime | No | The start date and time for the allowed location. | |
period_to | No | dateTime | No | The end date and time for the allowed location. | |
verified_by | No | string | No | The mark that shows whether the record was set by screening or by admin via the web interface. |
Possible values: A, S |
GetAllowedLocationListResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
allowed_location_list | No | Array of AllowedLocationInfo structure | No | The list of the account's allowed locations. | |
total | No | int | No | The number of the retrieved records. |
get_used_location_list | |
This method enables an API user to get the list of used locations | |
Parameters | GetUsedLocationListRequest |
Return Value | GetUsedLocationListResponse |
Realm | administrator, reseller |
Standalone mode support | Yes |
GetUsedLocationListRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
get_total | No | int | No | Get the total number of the retrieved used locations. | |
group_by_ip | No | int | No | Group usage locations by their subscriber ip. | |
i_account | Yes | unsignedLong | No | The unique ID of the account record. | |
limit | No | int | No | The number of rows to retrieve. | |
offset | No | int | No | The number of rows to skip at the beginning of the list. |
Default value: 0 |
GetUsedLocationListResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
total | No | int | No | The number of the retrieved records. | |
used_location_list | No | Array of UsedLocationInfo structure | No | The list of the account's allowed locations. |
update_allowed_location | |
This method enables an API user to update an allowed location | |
Parameters | UpdateAllowedLocationRequest |
Return Value | UpdateAllowedLocationResponse |
Realm | administrator, reseller |
Standalone mode support | No |
UpdateAllowedLocationRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
allowed_location_info | No | AllowedLocationInfo structure | No | Allowed location information. |
UpdateAllowedLocationResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
i_a_verified_locations | Yes | unsignedLong | No | The ID of the account's allowed location record. |
delete_payment_method | |
This method allows an API user to delete the payment information | |
Parameters | DeleteAccountPaymentMethodRequest |
Return Value | DeleteAccountPaymentMethodResponse |
Realm | administrator, reseller, retail customer, account |
Standalone mode support | No |
DeleteAccountPaymentMethodRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
i_account | Yes | unsignedLong | No | ID of account record. |
DeleteAccountPaymentMethodResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
success | Yes | int | No | 1 in case of success, 0 in case of failure. |
estimate_taxes | |
This method enables an API user to show tax rates or calculate the tax for a list of xDRs. To calculate the tax, the provided xDRs must have the charged_amount specified. All other properties are optional. | |
Parameters | AccountEstimateTaxesRequest |
Return Value | AccountEstimateTaxesResponse |
Realm | administrator, reseller, retail customer, account, distributor |
Standalone mode support | Yes |
AccountEstimateTaxesRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
calc_taxes | No | int | No | Specifies whether to calculate the tax or just show tax rates Possible values: 0 or undefined - return tax rates; 1 - calculate the tax for the provided xDRs. |
Default value: 0 |
i_account | Yes | unsignedLong | No | The unique ID of the account record. | |
issue_date | No | dateTime | No | The date when transactions took place (xDRs were created). It is used only for the EZtax (formerly known as BillSoft EZtax) plug-in. |
Default value: current date and time |
use_xdrs_from_db_up_to_date | No | dateTime | No | Get transactions (xDRs) from the database instead of xdr_list. The transactions for the period starting from the previous bill_to time to the specified time will be taken. Possible values: A specific date and time in the 'YYYYMM-DD HH24:MI:SS' format; 'now'. | |
xdr_list | No | Array of EstimateTaxesXDRInfo structure | No | List of xDRs. |
AccountEstimateTaxesResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
taxes_list | No | Array of EstimatedTax structure | No | List of the estimated/calculated taxes. | |
warnings | No | ArrayOfString | No | Returns procedure warnings if any. |
get_payment_method_info | |
This method allows an API user to retrieve the information about the payment method (e.g. payment card info) assigned to an account | |
Parameters | GetAccountPaymentMethodInfoRequest |
Return Value | GetAccountPaymentMethodInfoResponse |
Realm | administrator, reseller, retail customer, account |
Standalone mode support | Yes |
GetAccountPaymentMethodInfoRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
empty_if_not_configured | No | int | No | Set this flag to receive undef value if payment method not configured. When it's not provided error returns. | |
i_account | Yes | unsignedLong | No | The unique ID of the account. |
GetAccountPaymentMethodInfoResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
payment_method_info | No | AccountPaymentMethodInfo structure | No | PaymentMethodInfo object. |
get_payment_transaction_list | |
This method allows an API user to get a list of account's payment transactions | |
Parameters | GetAccountPaymentTransactionListRequest |
Return Value | GetAccountPaymentTransactionListResponse |
Realm | administrator, reseller, retail customer, account, cc staff, distributor |
Standalone mode support | Yes |
GetAccountPaymentTransactionListRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
from_date | No | dateTime | No | Get records starting from this date. | |
get_total | No | int | No | Get the total number of the retrieved transactions. | |
hide_restricted | No | int | No | Specifies whether it is necessary to remove the payment transactions of the terminated entities from the response. | |
i_account | No | unsignedLong | No | The unique ID of the account. | |
i_merchant_account | No | unsignedLong | No | The unique payment system ID for the transaction. | |
i_payment_method | No | unsignedLong | No | Unique ID of the payment method. | |
i_payment_transaction | No | unsignedLong | No | The unique ID of a payment transaction. | |
limit | No | int | No | The number of rows to retrieve. Mandatory for an API request with the offset property specified. | |
offset | No | int | No | The number of rows to skip at the beginning of the list. Requires the limit property to be specified in the API request. |
Default value: 0 |
search | No | string | No | A pattern that enables searching by the 'x_transaction_id', 'payment_method_info' fields. | |
status | No | string | No | Status of the transaction. |
Possible values: VOIDED, CANCELLED, COMPLETED, FAILED, AUTHORIZED, STARTED |
test_mode | No | string | No | Indicates whether the payment processor was in the test mode at the moment when the transaction was processed - Y/N. |
Possible values: Y, N |
to_date | No | dateTime | No | Get records before this date. |
GetAccountPaymentTransactionListResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
payment_transactions | No | Array of AccountTransactionInfo structure | Yes | The set of payment transactions. | |
total | No | int | No | The total number of the retrieved records. |
topup_account | |
This method allows an API user to top up an account using voucher | |
Parameters | TopupAccountRequest |
Return Value | TopupAccountResponse |
Realm | administrator, reseller, retail customer, account |
Standalone mode support | Yes |
TopupAccountRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
account_info | Yes | AccountInfo structure | No | Data about an account. Note: only i_account is used. | |
use_debit_voucher | No | int | Yes | Specifies whether to use another prepaid card to recharge an account (both accounts must have the same main product assigned). Possible values: 1 - Use prepaid card, 0 - Use voucher. | |
voucher_info | Yes | VoucherInfo structure | No | The information about a voucher. |
TopupAccountResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
amount | Yes | float | No | Amount by which the account's balance will increase. | |
available_funds | No | float | No | For debit accounts, this is equal to the h323-credit-amount. For credit accounts, this returns the actual amount of available funds (the difference between the credit limit and the current balance with respect to the credit limits for the individual account and customer). This field is not present in the response for accounts with the unlimited available funds. | |
balance | Yes | float | No | The current amount of the account's balance. | |
billing_model | Yes | string | No | Shows the account type. | |
breakage | Yes | float | Yes | The breakage amount of the account's product. | |
credit_limit | Yes | float | Yes | The account's credit limit value. | |
currency | Yes | string | No | Shows the account currency. | |
customer_balance | Yes | float | No | The customer's balance. | |
customer_credit_limit | Yes | float | Yes | The customer's credit limit value. |
update_payment_method | |
This method enables an API user to assign a preferred payment method to an account. For online payment methods, all the information required by the payment processor should be provided, and an appropriate payment processor must be set up and properly configured beforehand. Note that the number, name, address, and/or zip fields are not mandatory in the PaymentMethodInfo structure as long as credit card was already set | |
Parameters | UpdateAccountPaymentMethodRequest |
Return Value | UpdateAccountPaymentMethodResponse |
Realm | administrator, reseller, retail customer, account |
Standalone mode support | No |
UpdateAccountPaymentMethodRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
i_account | Yes | unsignedLong | No | The unique ID of the account. | |
payment_method_info | Yes | AccountPaymentMethodInfo structure | No | Data about payment method. |
UpdateAccountPaymentMethodResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
i_credit_card | Yes | unsignedLong | Yes | ID of modified payment method record. |
add_phonebook_record | |
This method allows an API user to add a record to the account's Phonebook | |
Parameters | AddUpdatePhoneBookRecordRequest |
Return Value | AddUpdatePhoneBookRecordResponse |
Realm | administrator, reseller, retail customer, account |
Standalone mode support | No |
AddUpdatePhoneBookRecordRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
phonebook_rec_info | No | PhoneBookRecInfo structure | No | Phonebook record data. |
AddUpdatePhoneBookRecordResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
i_account_phonebook | No | unsignedLong | Yes | The unique ID of the PhoneBook's record. |
delete_phonebook_record | |
This method allows an API user to delete a record from the account's Phonebook | |
Parameters | DeletePhoneBookRecordRequest |
Return Value | DeletePhoneBookRecordResponse |
Realm | administrator, reseller, retail customer, account |
Standalone mode support | No |
DeletePhoneBookRecordRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
i_account_phonebook | No | unsignedLong | No | The unique ID of the Phone book record. |
DeletePhoneBookRecordResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
success | No | int | No | One of the following: 1 - success, 0 - failed. |
estimate_call_price | |
This method allows an API user to see the price for calls to a specific destination (e.g. to a number from a user’s contact list) with applicable volume discounts | |
Parameters | AccountEstimateCallPriceRequest |
Return Value | AccountEstimateCallPriceResponse |
Realm | administrator, reseller, distributor, account, retail customer, cc staff |
Standalone mode support | Yes |
AccountEstimateCallPriceRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
i_account | No | unsignedLong | No | The unique ID of the owner account. | |
number | Yes | string | No | A number to estimate the call price for. |
Min value: 1 |
rating_context | No | string | No | An abstract string with rating context information. For example: 'i_service_type=3,i_node=1,accessCode=ANY,selectCode=ANY,oliCode=0'. |
AccountEstimateCallPriceResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
call_price_info | Yes | EstimatedCallPriceInfo structure | No | The information about the estimated call price. |
get_phonebook_list | |
This method allows an API user to obtain the list of the account's Phonebook records | |
Parameters | GetPhoneBookListRequest |
Return Value | GetPhoneBookListResponse |
Realm | administrator, reseller, retail customer, account |
Standalone mode support | Yes |
GetPhoneBookListRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
get_total | No | int | No | Get the total number of Phone book records. |
Default value: 0 |
i_account | Yes | unsignedLong | No | The unique ID of the owner account. Not mandatory when the method that requires this structure is executed from the account realm. | |
limit | Yes | int | No | Limit of Phonebook records (the maximum quantity of Phonebook records, number of rows to retrieve). | |
offset | Yes | int | No | Starting position for a Phonebook list (number of rows to skip at the beginning of the list). | |
phone_number_pattern | No | string | No | Phone Number Pattern. |
Default value: % |
GetPhoneBookListResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
phonebook_rec_list | No | Array of PhoneBookRecInfo structure | No | The list of Phonebook records. | |
total | No | int | No | The total number of Phone book records. |
get_phonebook_record | |
This method allows an API user to obtain the account's Phonebook record | |
Parameters | GetPhoneBookRecordRequest |
Return Value | GetPhoneBookRecordResponse |
Realm | administrator, reseller, retail customer, account |
Standalone mode support | Yes |
GetPhoneBookRecordRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
i_account_phonebook | Yes | unsignedLong | No | The unique ID of the Phonebook's record. |
GetPhoneBookRecordResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
phonebook_rec_info | No | PhoneBookRecInfo structure | Yes | Phonebook record data. |
update_phonebook_record | |
This method allows an API user to update a record in the account's Phonebook | |
Parameters | AddUpdatePhoneBookRecordRequest |
Return Value | AddUpdatePhoneBookRecordResponse |
Realm | administrator, reseller, retail customer, account |
Standalone mode support | No |
assign_sim_card | |
This method enables an API user to assign a SIM card from the SIM card inventory to an account | |
Parameters | AssignSIMCardRequest |
Return Value | AssignSIMCardResponse |
Realm | administrator, reseller, retail customer |
Standalone mode support | No |
AssignSIMCardRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
i_account | Yes | unsignedLong | No | The ID of the account record. | |
i_sim_card | Yes | unsignedLong | No | The ID of the SIM card record. | |
iccid | No | string | No | The Integrated Circuit Card ID of the SIM card record. Should be a string of 19 to 20 digits. |
AssignSIMCardResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
success | Yes | int | No | Returns 1 if the SIM card was assigned to an account. |
release_sim_card | |
This method enables an API user to release a previously assigned SIM card from an account | |
Parameters | ReleaseSIMCardRequest |
Return Value | ReleaseSIMCardResponse |
Realm | administrator, reseller |
Standalone mode support | No |
ReleaseSIMCardRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
i_account | Yes | unsignedLong | No | The ID of the account record. |
ReleaseSIMCardResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
success | Yes | int | No | Returns 1 if the SIM card was successfully released. |
get_service_features | |
This method allows an API user to access service features data | |
Parameters | GetAccountServiceFeaturesRequest |
Return Value | GetAccountServiceFeaturesResponse |
Realm | administrator, reseller, retail customer, account |
Standalone mode support | Yes |
GetAccountServiceFeaturesRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
i_account | Yes | unsignedLong | No | The unique ID of the account. An account represents an actual user of the service.. |
GetAccountServiceFeaturesResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
service_features | No | Array of ServiceFeatureInfo structure | Yes | The list of a service's features. |
update_service_features | |
This method allows an API user to update settings for account service features | |
Parameters | UpdateAccountServiceFeaturesRequest |
Return Value | UpdateAccountServiceFeaturesResponse |
Realm | administrator, reseller, retail customer, account |
Standalone mode support | No |
Request example |
|
Response example |
|
UpdateAccountServiceFeaturesRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
detailed_response | No | int | No | Specifies whether a list of Service Features will be returned in the response or not. | |
i_account | No | unsignedLong | No | The unique ID of the account. | |
service_features | No | Array of ServiceFeatureInfo structure | Yes | The list of service features. |
UpdateAccountServiceFeaturesResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
i_account | No | unsignedLong | No | The unique ID of the account. | |
service_features | No | Array of ServiceFeatureInfo structure | No | The list of service features. |
activate_subscriptions | |
This method allows an API user to instantly activate an accounts's pending subscriptions, where the start date is less than or equal to today's date (in the customer’s time zone). An activation fee will be charged for each subscription, if applicable | |
Parameters | ActivateAccountSubscriptionsRequest |
Return Value | ActivateAccountSubscriptionsResponse |
Realm | administrator, reseller |
Standalone mode support | No |
ActivateAccountSubscriptionsRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
i_account | Yes | unsignedLong | No | The unique ID of the account. |
ActivateAccountSubscriptionsResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
success | Yes | int | No | 1 in case of success, 0 in case of failure. |
add_subscription | |
This method allows an API user to add a new subscription associated with an account. If successful, a new subscription ID is returned | |
Parameters | AddAccountSubscriptionRequest |
Return Value | AddUpdateAccountSubscriptionResponse |
Realm | administrator, reseller |
Standalone mode support | No |
AddAccountSubscriptionRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
i_account | Yes | unsignedLong | No | The unique ID of the account. | |
subscription_info | Yes | AccountSubscriptionInfo structure | No | Note: i_account_subscription will be ignored; i_subscription is a mandatory field, and must be unique among all of the account's pending and active subscriptions. |
AddUpdateAccountSubscriptionResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
i_account_subscription | Yes | unsignedLong | No | The unique ID of the created/modified account subscription record. |
charge_subscription_fees | |
This method allows an administrator to immediately charge all of an account's subscriptions (otherwise later this will be done automatically) | |
Parameters | ChargeAccountSubscriptionFeesRequest |
Return Value | ChargeAccountSubscriptionFeesResponse |
Realm | administrator |
Standalone mode support | No |
ChargeAccountSubscriptionFeesRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
i_account | Yes | unsignedLong | No | The unique ID of the account record to be charged. | |
immediately_in_advance | No | int | No | Amount of periods that should be charged in advance. |
Max value: 50 Min value: 1 |
ChargeAccountSubscriptionFeesResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
success | Yes | int | No | 1 in case of success, 0 in case of failure. |
close_subscription | |
This method allows an API user to close an existing active subscription associated with an account. It requires an ID number returned, for example, by the add_subscription method | |
Parameters | CloseDeleteAccountSubscriptionRequest |
Return Value | CloseAccountSubscriptionResponse |
Realm | administrator, reseller |
Standalone mode support | No |
CloseDeleteAccountSubscriptionRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
i_account_subscription | Yes | unsignedLong | No | The unique ID of the account's subscription record to be closed/deleted. |
CloseAccountSubscriptionResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
i_account_subscription | Yes | unsignedLong | No | The unique identifier of the account's subscription record. |
delete_subscription | |
This method allows an API user to delete a pending subscription associated with an account. It requires an ID number returned, for example, by the add_subscription method | |
Parameters | CloseDeleteAccountSubscriptionRequest |
Return Value | DeleteAccountSubscriptionResponse |
Realm | administrator, reseller |
Standalone mode support | No |
DeleteAccountSubscriptionResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
success | Yes | int | No | 1 in case of success, 0 in case of failure. |
get_subscriptions | |
This method allows an API user to get the list of subscription records associated with an account | |
Parameters | GetAccountSubscriptionsRequest |
Return Value | GetAccountSubscriptionsResponse |
Realm | administrator, reseller, retail customer, account, representative |
Standalone mode support | Yes |
GetAccountSubscriptionsRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
commitment_name | No | string | No | The commitment name. | |
i_account | Yes | unsignedLong | No | The unique ID of the account. | |
i_commitment | No | unsignedLong | No | The unique ID of the commitment. | |
with_regular_discount_list | No | int | No | The flag specifies whether it's required to return the list of regular discounts for assigned subscription. | |
with_upcharge_list | No | int | No | The flag specifies whether it's required to return the list of upcharges for assigned subscription. |
GetAccountSubscriptionsResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
subscriptions | No | Array of AccountSubscriptionInfo structure | No | Set of account subscription data records. |
update_subscription | |
This method allows an API user to update an existing subscription record associated with an account. It requires an ID number returned, for example, by the add_subscription method | |
Parameters | UpdateAccountSubscriptionRequest |
Return Value | AddUpdateAccountSubscriptionResponse |
Realm | administrator, reseller, retail customer, account |
Standalone mode support | No |
UpdateAccountSubscriptionRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
i_account | Yes | unsignedLong | No | The unique ID of the account. | |
i_account_subscription | Yes | unsignedLong | No | The unique ID of the account subscription record to be updated. | |
subscription_info | Yes | AccountSubscriptionInfo structure | No | Note: i_account_subscripti on and i_subscription will be ignored. |
get_transactions_total_info | |
This method allows an API user to get the list of account's transactions | |
Parameters | GetAccountTransactionsTotalInfoRequest |
Return Value | GetAccountTransactionsTotalInfoResponse |
Realm | administrator, reseller, retail customer, account |
Standalone mode support | Yes |
GetAccountTransactionsTotalInfoRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
billing_model | No | int | No | Specifies the account type for which to show transactions; one of the following: -1 - Debit account; 1 - Credit account. |
Possible values: -1, 1 |
cld | No | string | No | The called party phone number. | |
cli | No | string | No | The calling party phone number. | |
from_date | Yes | dateTime | No | Get transactions made after this date. | |
i_account | Yes | unsignedLong | No | The unique ID of the account record. | |
i_service | No | unsignedLong | Yes | The unique ID of the Service record; refers to the Services table. | |
show_unsuccessful | No | int | No | Show the records of unsuccessful attempts. The field applies only to the admin realm. | |
to_date | Yes | dateTime | No | Get transactions made before this date. |
GetAccountTransactionsTotalInfoResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
count | No | int | No | The total number of transactions. | |
iso_4217 | No | string | No | Transactions currency. | |
per_service_info | No | Array of AccountPerServiceInfo structure | Yes | The list of objects containing information on per-service basis. | |
sessions_count | No | int | No | The total number of sessions. | |
total_amount | No | float | No | Total transactions amount. | |
total_info | No | Array of TotalTransInfo structure | No | The list of per-service total values. |
make_transaction | |
This method allows an API user to adjust an account's balance or issue a payment transaction, including e-commerce transactions | |
Parameters | MakeAccountTransactionRequest |
Return Value | MakeAccountTransactionResponse |
Realm | administrator, reseller, retail customer, account, cc staff, distributor |
Standalone mode support | No |
MakeAccountTransactionRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
action | Yes | string | No | The balance adjustment operation type. Defines how the balance will be adjusted. Note: the availability of certain actions is based on the system configuration, for instance, whether the remittance is configured or the payment processor is configured. Possible values: Manual Charge, Manual Credit, Manual Payment, Promotional Credit, Refund, E-Commerce Payment, E-Commerce Refund, Authorization Only, Capture Payment, Void, Transfer Funds, and TransferTo. The UI equivalent of this field is the "Operation type" input field on the Edit Account -> Balance adjustment dialog.. |
Possible values: Manual Charge, Manual Credit, Manual Payment, Promotional Credit, Refund, E-Commerce Payment, E-Commerce Refund, Authorization Only, Capture Payment, Void, Transfer Funds, TransferTo |
amount | Yes | float | No | An amount by which the customer's balance will increase/decrease. Note: The number of digits depends on the maximum number of decimal places allowed by the currency. The UI equivalent of this field is the "Amount" input field on the Edit Account -> Balance adjustment dialog -> Charge amount step.. |
Min value: 0 |
card_info | No | AccountPaymentMethodInfo structure | No | The payment method information for this transaction. Note: for e-commerce transactions, if no card_info is specified the system will use the stored card information.. | |
date_inside_billing_period | No | date | No | The date associated with the manual charge/credit transaction. Used for invoice adjustment. Note: for example, you can specify a date for a manual credit transaction for when an account was credited.. | |
datetime_inside_billing_period | No | dateTime | No | The date and time associated with the manual charge/credit. Used for invoice adjustment; the field has higher priority than date_inside_billing_period. Note: for example, you can specify a date for manual credit action for when an item is credited.. | |
enable_balance_fraud_protection | No | int | No | Indicates whether to perform balance fraud checks to make sure the charged amount never exceeds the available balance. Note: is used in manual charges from external applications as overdraft protection. Possible values: 1 - check whether the account has enough available funds to perform balance adjustment; 0 - don't check the account's balance.. | |
h323_conf_id | No | string | No | The tax transaction code that should be applied to a transaction. The UI equivalent of this field is the "Tax transaction code" input field on the Edit Account -> Balance adjustment dialog -> Charge amount step.. |
Max value: 36 |
i_account | Yes | unsignedLong | No | The ID of the account whose balance has to be adjusted. | |
i_payment_transaction | No | unsignedLong | No | The field identifies a previously issued authorization only/e-commerce payment transaction. Used for capture payment and e-commerce refund transactions.. | |
i_service | No | unsignedLong | No | The ID of the service the transaction is applied for. The UI equivalent of this field is the "Service" input field on the Edit Account -> Balance adjustment dialog -> Charge amount step.. | |
internal_comment | No | string | No | An internal comment on this transaction. Note: not visible in the xDR browser and accessible only directly from the database. The UI equivalent of this field is the "Internal comment" input field on the Edit Account -> Balance adjustment dialog -> Charge amount step. |
Max value: 200 |
recipient_id | No | int | No | The ID of the recipient account record for transactions between accounts. Note: applicable to balance transfers between accounts.. | |
return_url | No | string | No | The URL to redirect users back to after they authenticate or cancel their payment on the payment method's app or site. Note: applicable to e-commerce transactions for payment processors with external authorization.. | |
save_card | No | string | No | The flag indicates whether the supplied payment method should be saved as preferred if payment is successful. Possible values: Y - save card; N - don't save card. The UI equivalent of this field is the "Save credit card information for future use" switch on the Edit Account -> Balance adjustment dialog -> Billing address step.. |
Default value: N Possible values: Y, N |
suppress_notification | No | int | No | The flag indicates whether to suppress sending the result notification to the account. Possible values: 1 - do not send email notification to the account, 0 - send email notification to the account.. | |
transaction_id | No | string | No | Applicable to capture payment and e-commerce refund transactions. Note: must contain the ID of a previously issued authorization only/e-commerce payment transaction.. |
Max value: 48 |
visible_comment | No | string | No | A comment on this transaction which is visible in the xDR browser. The UI equivalent of this field is the "Visible comment" input field on the Edit Account -> Balance adjustment dialog -> Charge amount step.. |
MakeAccountTransactionResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
authorization | No | string | No | The e-commerce authorization code. | |
balance | Yes | float | No | The account's updated balance. | |
i_payment_transaction | No | unsignedLong | No | The unique ID of the transaction. | |
i_xdr | No | unsignedLong | No | The unique ID of the xDR record. | |
redirect_url | No | string | No | The URL to redirect a user to in order to authenticate the transaction (3D Secure). Note: applicable to e-commerce transactions for payment processors that support Strong Security Authorization.. | |
result_code | No | string | No | The e-commerce operation result code. | |
transaction_id | No | string | No | The e-commerce transaction ID. |
register_transaction | |
This method enables an API user to register a transaction initiated for an account | |
Parameters | AccountRegisterTransactionRequest |
Return Value | AccountRegisterTransactionResponse |
Realm | administrator, reseller, account |
Standalone mode support | No |
AccountRegisterTransactionRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
amount | Yes | float | No | The amount for payment. | |
i_account | No | unsignedLong | No | Unique ID of the Account for which a transaction will be registered. | |
i_payment_method | Yes | unsignedLong | No | Unique ID of the chosen Payment Method. |
AccountRegisterTransactionResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
transaction | No | TransactionInfo structure | No | The information about the transaction. |
get_full_vd_counter_info | |
This method allows an API user to get full information about volume discount counters | |
Parameters | GetAccountFullVDCounterListInfoRequest |
Return Value | GetFullVDCounterListInfoResponse |
Realm | administrator, retail customer, account, reseller, cc staff, representative, distributor |
Standalone mode support | Yes |
GetAccountFullVDCounterListInfoRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
i_account | Yes | unsignedLong | No | The unique ID of the account record. Not mandatory when the method that requires this structure is executed from the account realm. | |
separate_units | No | int | No | Specifies whether to provide threshold values and discount amount units (e.g., minutes) in a separate field. | |
with_discount_info | No | int | No | Specifies whether to provide the discount information of a counter. | |
with_service_pool_info | No | int | No | Specifies whether to provide service pool information of counter. |
GetFullVDCounterListInfoResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
counter_list | No | Array of FullCounterInfo structure | Yes | Array of full counter objects. |
get_used_vd_dest_group_list | |
This method enables an API user to obtain information about the volume discount destination groups used by the account | |
Parameters | GetAccountUsedVdDestGroupListRequest |
Return Value | GetAccountUsedVdDestGroupListResponse |
Realm | administrator |
Standalone mode support | Yes |
GetAccountUsedVdDestGroupListRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
date_from | Yes | dateTime | No | The start of the date-time interval to search for the volume discount destination groups. | |
date_to | No | dateTime | No | The end of the date-time interval to search for the volume discount destination groups (leave empty for current date-time). | |
i_account | Yes | unsignedLong | No | The unique ID of the owner account. | |
i_service_type | No | unsignedLong | No | The unique ID of the service type. |
GetAccountUsedVdDestGroupListResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
vd_dest_group_list | Yes | Array of VdDestGroupInfo structure | No | Array of vd destination groups. |
get_vd_counter_info | |
This method enables an API user to retrieve the information about an account-level counter | |
Parameters | GetAccountVdCounterInfoRequest |
Return Value | GetAccountVdCounterInfoResponse |
Realm | administrator |
Standalone mode support | Yes |
GetAccountVdCounterInfoRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
i_avd_counter | Yes | unsignedLong | No | The unique ID of the record. |
GetAccountVdCounterInfoResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
vd_counter_info | No | CounterInfo structure | No | The information about the account-level counter. |
get_vd_counter_list | |
This method allows an API user to get the information about volume discount counters for the specified account | |
Parameters | GetAccountVDCounterListRequest |
Return Value | GetAccountVDCounterListResponse |
Realm | administrator, reseller |
Standalone mode support | Yes |
GetAccountVDCounterListRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
detailed_info | No | int | Yes | Detailed information. | |
dg_name | No | string | No | Destination group name pattern. | |
i_account | Yes | unsignedLong | No | The unique ID of the account record. | |
peak_level | No | int | No | ID of the Peak Level (0 - Peak Period, 1 - Off-Peak Period, 2 - 2nd Off-Peak Period). |
Possible values: 0, 1, 2 |
service_name | No | string | No | Service name pattern. |
GetAccountVDCounterListResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
counter_list | No | Array of CounterInfo structure | Yes | Array of counter objects. |
vd_topup | |
This method allows an administrator to top-up the volume of a service (e.g. free minutes or gigabytes) provided to an end-user (account) with the discount | |
Parameters | AccountVDTopupRequest |
Return Value | VDTopupResponse |
Realm | administrator, reseller, retail customer, account |
Standalone mode support | No |
AccountVDTopupRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
addon_priority | No | int | No | The add-on product's precedence level. If there are more than one add-on products assigned to an account they will be sorted according to the specified precedence level. Possible values: 0 - Main product, 10 - Low, 15 - Medium low, 20 - Medium, 25 - Medium high, 30 - High. |
Default value: 255 Possible values: 0, 10, 15, 20, 25, 30, 255 |
h323_conf_id | No | string | No | Custom data for third-party application processing. |
Max value: 255 |
i_account | Yes | unsignedLong | No | The unique ID of the account record. Not mandatory when the method that requires this structure is executed from the account realm. | |
i_dest_group | Yes | unsignedLong | No | The unique ID of the destination group to apply the top-up to. |
Min value: 0 |
i_service | Yes | unsignedLong | No | The unique ID of the service record. |
Min value: 1 |
payment_info | No | AccountPaymentInfo structure | No | The payment information. | |
peak_level | Yes | int | No | Possible values: 0 - The peak period; 1 - The off-peak period; 2 - The 2nd off-peak period. |
Possible values: 0, 1, 2 |
topup_amount | Yes | float | No | The top-up amount. | |
topup_expires | No | dateTime | No | A date and time in the UTC format when the topped up volume discount becomes expired (YYYY-MM-DD HH24:MI:SS). |
Min value: current date and time |
voucher_info | No | VoucherInfo structure | No | The information about a voucher. |
VDTopupResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
counter_info | No | FullCounterInfo structure | No | The volume discount counter. See the FullCounterInfo structure in the Customer Information section. | |
redirect_url | No | string | No | The URL to redirect a user to in order to authenticate the transaction (3D Secure). | |
status | No | string | No | This field specifies the status of the transaction on the payment gateway side. Possible values: STARTED - transaction pending, COMPLETED - transaction completed, FAILED - transaction failed. |
get_acl_list | |
This method allows an API user to get the list of ACL | |
Parameters | GetAclListRequest |
Return Value | GetAclListResponse |
Realm | administrator, reseller |
Standalone mode support | Yes |
GetAclListRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
group | No | string | No | The name of ACL group to search. |
Max value: 32 |
limit | No | int | No | The number of rows to retrieve. Mandatory for an API request with the offset property specified. | |
name | No | string | No | Search ACL by name. |
Max value: 64 |
offset | No | int | No | The number of rows to skip at the beginning of the list. Requires the limit property to be specified in the API request. |
Max value: 4294967295 |
subsystem | No | string | No | The name of subsystem ACL belongs to. |
Max value: 32 |
type | No | string | No | Type of ACL to search. Possible values: Component, User, Customer, CC Staff, Account, Vendor, Representative, Reseller, Distributor. |
Possible values: Component, User, Customer, CC Staff, Account, Vendor, Representative, Reseller, Distributor |
with_i_acl | No | unsignedLong | No | If the entity has customized default ACL (instead of the predefined one), specify the unique ID of this customized default ACL here. Then it will be included to the list. |
GetAclListResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
acl_list | Yes | Array of AclInfo structure | No | The list of ACL records. | |
total | No | int | No | The total number of found ACLs. |
get_my_permissions_for_objects | |
This method allows an API user to get a list of ACL permissions for specific objects on the PortaBilling web interface | |
Parameters | GetMyAclForObjectsRequest |
Return Value | GetMyAclForObjectsResponse |
Realm | administrator, reseller, retail customer, account, cc staff, representative, distributor |
Standalone mode support | Yes |
GetMyAclForObjectsRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
objects | Yes | Array of string structure | No | A list of web interface objects for which the ACL permissions will be collected (e.g. selfcare, WebForms, etc.). |
GetMyAclForObjectsResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
access_level | No | AccessLevelInfo structure | No | The information about the ACL permissions. |
disable_api_notifications | |
This method enables an API user to disable the receipt of notifications about the status of API requests execution in the asynchronous mode | |
Parameters | DisableAsyncApiNotificationsRequest |
Return Value | DisableAsyncApiNotificationsResponse |
Realm | administrator, reseller, distributor, cc staff, representative, retail customer, account |
Standalone mode support | No |
Mode | Syncronous only |
DisableAsyncApiNotificationsRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
Does not include any properties |
DisableAsyncApiNotificationsResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
success | Yes | int | No | A non-zero value means that the operation has been successful. |
enable_api_notifications | |
This method enables an API user to receive notifications about the status of API requests execution in the asynchronous mode | |
Parameters | EnableAsyncApiNotificationsRequest |
Return Value | EnableAsyncApiNotificationsResponse |
Realm | administrator, reseller, distributor, cc staff, representative, retail customer, account |
Standalone mode support | No |
Mode | Syncronous only |
EnableAsyncApiNotificationsRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
Does not include any properties |
EnableAsyncApiNotificationsResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
success | Yes | int | No | A non-zero value means that the operation has been successful. |
delete_request_list | |
This method enables deleting async requests | |
Parameters | DeleteAsyncRequestListRequest |
Return Value | DeleteAsyncRequestListResponse |
Realm | administrator, reseller, distributor, cc staff, representative, retail customer, account |
Standalone mode support | No |
Mode | Syncronous only |
DeleteAsyncRequestListRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
request_list | Yes | Array of AsyncRequestInfo structure | No | The set of async request records. |
Min value: 1 |
DeleteAsyncRequestListResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
success | Yes | int | No | A non-zero value means that the operation has been successful. |
get_request_info | |
This method enables an API user to check the status of the JSON request being executed in the asynchronous mode | |
Parameters | GetAsyncRequestInfoRequest |
Return Value | GetAsyncRequestInfoResponse |
Realm | administrator, reseller, distributor, cc staff, representative, retail customer, account |
Standalone mode support | No |
GetAsyncRequestInfoRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
i_async_request | Yes | unsignedLong | No | The unique ID of the request. |
GetAsyncRequestInfoResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
request_info | No | AsyncRequestInfo structure | No | The asynchronous request info. |
get_request_list | |
This method enables getting the list of async requests | |
Parameters | GetAsyncRequestListRequest |
Return Value | GetAsyncRequestListResponse |
Realm | administrator, reseller, distributor, cc staff, representative, retail customer, account |
Standalone mode support | No |
Mode | Syncronous only |
GetAsyncRequestListRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
Does not include any properties |
GetAsyncRequestListResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
request_list | No | Array of AsyncRequestInfo structure | No | A set of asynchronous request records. |
add_authz_rule | |
This method allows an API user to define manual authentication rules allowing PortaSIP servers to handle incoming calls in the desired manner | |
Parameters | AddUpdateAuthzRuleRequest |
Return Value | AddUpdateAuthzRuleResponse |
Realm | administrator |
Standalone mode support | No |
AddUpdateAuthzRuleRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
authz_rule_info | Yes | AuthzRuleInfo structure | No | Authentication rule data. | |
override_autogenerated | No | int | No | Specifies whether to override existing autogenerated rules: 1 - if an autogenerated rule for this IP address already exists, override it by the new manual rule, 0 - if an autogenerated rule for this IP address already exists, throw SOAP fault 'duplicate ip pattern'. |
AddUpdateAuthzRuleResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
i_authz_rule | No | unsignedLong | No | The unique ID of the created authentication rule. |
delete_authz_rule | |
This method allows an API user to delete authentication rules | |
Parameters | DeleteAuthzRuleRequest |
Return Value | DeleteAuthzRuleResponse |
Realm | administrator |
Standalone mode support | No |
DeleteAuthzRuleRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
i_authz_rule | Yes | unsignedLong | No | The unique ID of the authentication rule record to delete. |
DeleteAuthzRuleResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
success | Yes | int | No | 1 in case of success, 0 in case of failure. |
get_authz_method_type_list | |
This method enables an API user to get the list of authentication method types | |
Parameters | GetAuthzMethodTypeListRequest |
Return Value | GetAuthzMethodTypeListResponse |
Realm | administrator |
Standalone mode support | Yes |
GetAuthzMethodTypeListRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
Does not include any properties |
GetAuthzMethodTypeListResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
authz_method_type_list | Yes | Array of AuthzMethodTypeInfo structure | No | The list of authentication method types. |
get_authz_rule_list | |
This method allows an API user to get a list of authentication rules that show how PortaSIP servers handle incoming calls. An authentication rule combines an authorization method and call parameters | |
Parameters | GetAuthzRuleListRequest |
Return Value | GetAuthzRuleListResponse |
Realm | administrator |
Standalone mode support | No |
GetAuthzRuleListRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
auto_link_type | No | string | Yes | The filter to search the authentication rules by the 'auto_link_type' DB column. | |
autogenerated | No | int | No | The filter to search autogenerated or manually created authentication rules. Possible values: 1 - autogenerated, 0 - manually created. | |
with_extended_info | No | int | No | If set to 1, the method returns the following additional fields in the response AuthzRuleInfo structures: 'account_id', 'connection_description' and 'node_name'. |
GetAuthzRuleListResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
authz_rule_list | Yes | Array of AuthzRuleInfo structure | Yes | A list of authentication rules found. |
rearrange_authz_rule_list | |
This method enables an API user to change the 'order_number' value of all existing manually created authentication rules | |
Parameters | RearrangeAuthzRuleListRequest |
Return Value | RearrangeAuthzRuleListResponse |
Realm | administrator |
Standalone mode support | No |
RearrangeAuthzRuleListRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
authz_rule_list | Yes | Array of RearrangeAuthzRuleInfo structure | No | The list of authentication rules. |
Min value: 2 |
RearrangeAuthzRuleListResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
success | Yes | int | No | 1 in case of success, exception error message in case of failure. |
update_authz_rule | |
This method allows an API user to update manual authentication rules to change how PortaSIP servers handle incoming calls | |
Parameters | AddUpdateAuthzRuleRequest |
Return Value | AddUpdateAuthzRuleResponse |
Realm | administrator |
Standalone mode support | No |
disconnect_session | |
This method enables an administrator to disconnect a session that was established through PortaSIP Nodes or via the RADIUS protocol | |
Parameters | DisconnectSessionRequest |
Return Value | DisconnectSessionResponse |
Realm | administrator, reseller |
Standalone mode support | No |
DisconnectSessionRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
billing_session_id | No | string | No | The h323-conf-id of the session. |
Max value: 36 Min value: 1 |
service_session_id | No | string | No | The call-id of the session. |
Max value: 100 Min value: 1 |
DisconnectSessionResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
success | Yes | int | No | 1 in case of success. |
get_active_calls_list | |
This method allows an API user to get the list of active calls | |
Parameters | GetActiveCallsRequest |
Return Value | GetActiveCallsResponse |
Realm | administrator, reseller, retail customer, account |
Standalone mode support | Yes |
GetActiveCallsRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
actual | No | string | No | Return only actual records. |
Default value: N Possible values: Y, N |
i_account | No | unsignedLong | No | The unique ID of the account. | |
i_customer | No | unsignedLong | No | The unique ID of the customer. | |
limit | No | int | No | The number of rows to retrieve. Mandatory for an API request with the offset property specified. |
Min value: 1 |
offset | No | int | No | The number of rows to skip at the beginning of the list. Requires the limit property to be specified in the API request. |
Default value: 0 Max value: 4294967295 Min value: 0 |
GetActiveCallsResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
active_calls_list | Yes | Array of ActiveCallInfo structure | Yes | The list of active calls. |
get_active_sessions_list | |
This method enables an API user to get the list of active sessions | |
Parameters | GetActiveSessionsRequest |
Return Value | GetActiveSessionsResponse |
Realm | administrator, reseller |
Standalone mode support | Yes |
GetActiveSessionsRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
account_id | No | string | No | The ID (PIN) of the account on the PortaBilling interface, unique in the environment. |
Max value: 128 |
call_id | No | string | No | The call-id of the session. |
Max value: 100 |
cld | No | string | No | The called line phone number. |
Max value: 128 |
cli | No | string | No | The calling line phone number. |
Max value: 128 |
get_total | No | int | No | Get the total number of the retrieved active session records. | |
h323_conf_id | No | string | No | The h323-conf-id of the session. |
Max value: 36 |
hotlined | No | string | No | The flag that shows whether the session is hotlined (Internet sessions only). |
Possible values: Y, N |
i_connection | No | unsignedLong | No | The unique ID of the connection. | |
i_customer | No | unsignedLong | No | The unique ID of the customer record. | |
i_node | No | unsignedLong | No | The unique ID of the node. | |
i_parent | No | unsignedLong | Yes | Omit for a direct customer; i_customer of the reseller for a subcustomer. | |
i_service_type | No | unsignedLong | No | The unique ID of the service type. | |
i_vendor | No | unsignedLong | No | The unique ID of the vendor record. | |
limit | No | int | No | The number of rows to retrieve. Mandatory for an API request with the offset property specified. | |
offset | No | int | No | The number of rows to skip at the beginning of the list. Requires the limit property to be specified in the API request. |
Default value: 0 |
on_net | No | string | No | Filter the session list by the on-net status. Possible values: 'on-net_only' - Include only on-net sessions; 'exclude' - Do not include on-net sessions; 'exclude_incoming' - Do not include incoming on-net sessions. |
Possible values: on-net_only, exclude, exclude_incoming |
parent_session_id | No | string | Yes | The parent session ID. |
Max value: 36 |
source_ip | No | string | No | The IP address of the entity. |
Max value: 15 Min value: 7 |
with_cld_country | No | int | No | Specifies whether the information about country and subdivision of CLD should be included in the response. | |
with_nodes | No | int | No | Specifies whether the information about used nodes should be included in the response. | |
with_resale_hierarchy | No | int | No | Specifies whether the information about the resellers hierarchy should be included in the response. |
GetActiveSessionsResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
active_session_list | No | Array of ActiveSessionInfo structure | No | The list of active sessions. | |
total | No | int | No | The total number of the retrieved sessions. |
manage_active_call_recording | |
This method allows an API user to start or stop recording during the call | |
Parameters | ManageActiveCallRecordingRequest |
Return Value | ManageActiveCallRecordingResponse |
Realm | administrator, retail customer, account |
Standalone mode support | No |
ManageActiveCallRecordingRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
call_id | Yes | string | No | The unique ID of the call. | |
command | Yes | string | No | Allows you to start or stop call recording. One of the following: stop; start. |
Possible values: start, stop |
ManageActiveCallRecordingResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
cld_status | Yes | string | No | Callee part call recording start/stop status; enum [ FAILED - some errors happened during attempt to enabled/disable recording; DENIED - action isn't allowed according to BE data; OK - action processed successfully ]. | |
cli_status | Yes | string | No | Caller part call recording start/stop status; enum [ FAILED - some errors happened during attempt to enabled/disable recording; DENIED - action isn't allowed according to BE data; OK - action processed successfully ]. |
add_disconnect_queue_record | |
This method allows an administrator to disconnect an Internet session (by adding a record to the disconnect queue) | |
Parameters | AddDisconnectQueueRecordRequest |
Return Value | AddDisconnectQueueRecordResponse |
Realm | administrator |
Standalone mode support | No |
AddDisconnectQueueRecordRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
account_id | Yes | string | No | Account number. |
Max value: 128 |
at_time | No | dateTime | No | Time when status should be applied. |
Default value: current date and time |
i_node | No | unsignedLong | No | Unique ID of Nodes record (should be POD server). |
Min value: 1 |
i_service_type | No | unsignedLong | No | The unique ID of the related service type. Default: 6 (NETACCESS). |
Default value: 6 Min value: 2 |
param1 | No | string | No | Formatted disconnector parameters string. |
Max value: 255 |
session_id | No | string | No | ID of the session to work with. |
Max value: 36 |
tx_expire | No | dateTime | No | Expiration time. |
AddDisconnectQueueRecordResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
i_pod | Yes | unsignedLong | No | The unique ID of the disconnect request. Refers to the DisconnectQuery table. |
get_brandpane_archive | |||||||
This method enables an API user to get the brandpane template and css files. The brandpane-related files are returned in a MIME attachment | |||||||
Parameters | GetBrandpaneArchiveRequest | ||||||
Return Value | GetBrandpaneArchiveResponse | ||||||
Realm | administrator, reseller, retail customer, account | ||||||
Standalone mode support | Yes | ||||||
Attachments |
|
GetBrandpaneArchiveRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
realm | No | string | No | The realm name as in the configuration (accounts, customer, cc_staff, representative, admin, vendor). |
Possible values: |
GetBrandpaneArchiveResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
css_file_name | No | string | No | The path to the brandpane's style - CSS file (e.g. /brandpane/env_3/accounts/brandpane.css). | |
html_file_name | No | string | No | The path to the brandpane's template - HTML file named 'brandpane.tmpl' (e.g. /brandpane/env_3/accounts/brandpane.tmpl. |
add_bundle_promotion | |
This method allows an API user to add a new bundle promotion | |
Parameters | AddBundlePromotionRequest |
Return Value | AddUpdateBundlePromotionResponse |
Realm | administrator |
Standalone mode support | No |
AddBundlePromotionRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
bundle_promotion_info | Yes | BundlePromotionInfo structure | No | The information about the bundle promotion. Note that the name, i_dest_group_set, iso_4217 parameters of the BundlePromotionInfo structure are mandatory in this case. |
AddUpdateBundlePromotionResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
i_bd_plan | No | unsignedLong | No | The unique ID of the Bundle Promotion Plan. |
delete_bundle_promotion | |
This method allows an API user to delete the bundle promotion | |
Parameters | GetDeleteBundlePromotionRequest |
Return Value | DeleteBundlePromotionResponse |
Realm | administrator |
Standalone mode support | No |
GetDeleteBundlePromotionRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
i_bd_plan | Yes | unsignedLong | No | The unique ID of the bundle promotion plan. |
DeleteBundlePromotionResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
success | Yes | int | No | Possible values: 1 - The bundle promotion is successfully deleted. 0 - The bundle promotion has not been deleted. |
get_bundle_promotion_info | |
This method allows an API user to get the bundle promotion information | |
Parameters | GetDeleteBundlePromotionRequest |
Return Value | GetBundlePromotionInfoResponse |
Realm | administrator, reseller |
Standalone mode support | Yes |
GetBundlePromotionInfoResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
bundle_promotion_info | No | BundlePromotionInfo structure | No | The information about the bundle promotion. |
get_bundle_promotion_list | |
This method allows an API user to get the list of bundle promotions | |
Parameters | GetBundlePromotionListRequest |
Return Value | GetBundlePromotionListResponse |
Realm | administrator, reseller |
Standalone mode support | Yes |
GetBundlePromotionListRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
filter | No | string | No | Allows retrieving bundle promotions by the name or part of the name. | |
get_total | No | int | No | Specifies whether to show the total number of found bundle promotions. Then, even if, e.g. the limit property is specified, the total number of bundle promotions that satisfy other conditions will be shown. | |
i_dest_group_set | No | unsignedLong | Yes | The unique ID of the destination group set associated with this bundle promotion plan. | |
iso_4217 | No | string | No | The bundle promotion plan currency in the three-letter format (ISO 4217). | |
limit | No | int | No | The number of rows to retrieve. Mandatory for an API request with the offset property specified. | |
managed_by | No | unsignedLong | No | The unique ID of the reseller who manages the required bundle promotions. | |
managed_by_admin | No | string | No | Specifies that only those bundle promotions that are managed by administrator must be retrieved. Possible values: Y - Retrieve only bundle promotions managed by admin; N - Retrieve all bundle promotions. |
Default value: N Possible values: Y, N |
offset | No | int | No | The number of rows to skip at the beginning of the list. Requires the limit property specified in the API request. |
Default value: 0 |
GetBundlePromotionListResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
bundle_promotion_list | Yes | Array of BundlePromotionInfo structure | Yes | The list of Bundle Promotion Plans. | |
total | No | int | No | The total number of bundle promotion plans found. |
update_bundle_promotion | |
This method allows an API user to update the bundle promotion information | |
Parameters | UpdateBundlePromotionRequest |
Return Value | AddUpdateBundlePromotionResponse |
Realm | administrator, reseller |
Standalone mode support | No |
UpdateBundlePromotionRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
bundle_promotion_info | No | BundlePromotionInfo structure | No | The information about the bundle promotion. |
add_criterion | |
This method allows an API user to add a new bundle promotion criterion | |
Parameters | AddUpdateCriterionRequest |
Return Value | AddUpdateCriterionResponse |
Realm | administrator, reseller |
Standalone mode support | No |
AddUpdateCriterionRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
criterion_info | Yes | CriterionInfo structure | No | The information about the bundle promotion criteria. The i_bd_criteria parameter is mandatory for the update_criterion method. |
AddUpdateCriterionResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
i_bd_criteria | No | unsignedLong | No | The unique ID of the bundle promotion criterion. |
delete_criterion | |
This method allows an API user to delete the bundle promotion criterion | |
Parameters | DeleteCriterionRequest |
Return Value | DeleteCriterionResponse |
Realm | administrator, reseller |
Standalone mode support | No |
DeleteCriterionRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
i_bd_criteria | Yes | unsignedLong | No | The unique ID of the bundle promotion criterion. |
DeleteCriterionResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
success | Yes | int | No | Possible values: 1 - The bundle promotion criteria are successfully deleted. 0 - The bundle promotion criteria have not been deleted. |
get_criteria_list | |
This method allows an API user to get the list of the bundle promotion criteria | |
Parameters | GetCriteriaListRequest |
Return Value | GetCriteriaListResponse |
Realm | administrator, reseller |
Standalone mode support | Yes |
GetCriteriaListRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
get_total | No | int | No | Specifies whether to show the total number of criteria found. Then, even if, e.g. the limit property is specified, the total number of criteria that satisfy other conditions will be shown. | |
i_bd_plan | Yes | unsignedLong | No | The unique ID of the Bundle Promotion Plan. | |
limit | No | int | No | The number of rows to retrieve. Mandatory for an API request with the offset property specified. | |
offset | No | int | No | The number of rows to skip at the beginning of the list. Requires the limit property to be specified in the API request. | |
with_thresholds | No | int | No | Specifies whether to show the list of thresholds associated with the criteria. 1 - Show the list of thresholds. 0 - Do not show the list of thresholds. |
GetCriteriaListResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
criteria_list | Yes | Array of CriterionInfo structure | Yes | The list of Bundle Discount Criteria found. | |
total | No | int | No | The total number of Criteria found. |
get_criterion | |
This method allows an API user to get the information about the bundle promotion criterion | |
Parameters | GetCriterionRequest |
Return Value | GetCriterionInfoResponse |
Realm | administrator, reseller |
Standalone mode support | Yes |
GetCriterionRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
i_bd_criteria | Yes | unsignedLong | No | The unique ID of the bundle promotion criteria. | |
with_thresholds | No | int | No | Specifies whether to show the list of thresholds associated with the criteria. Possible values: 1 - Show the list of thresholds. 0 - Do not show the list of thresholds. |
GetCriterionInfoResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
criterion_info | No | CriterionInfo structure | Yes | The information about the bundle promotion criterion. |
update_criterion | |
This method allows an API user to update the bundle promotion criterion | |
Parameters | AddUpdateCriterionRequest |
Return Value | AddUpdateCriterionResponse |
Realm | administrator, reseller |
Standalone mode support | No |
add_dates_batch | |
This method enables an API user to add the list of calendar date records | |
Parameters | AddDatesBatchRequest |
Return Value | AddDatesBatchResponse |
Realm | administrator |
Standalone mode support | No |
AddDatesBatchRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
date_list | Yes | Array of CalendarDateInfo structure | No | The list of calendar date records. |
Min value: 1 |
AddDatesBatchResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
success | Yes | int | No | 1 for success. |
delete_dates_batch | |
This method enables an API user to delete the list of calendar date records | |
Parameters | DeleteDatesBatchRequest |
Return Value | DeleteDatesBatchResponse |
Realm | administrator |
Standalone mode support | No |
DeleteDatesBatchRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
date_list | No | Array of CalendarDateInfo structure | No | The list of calendar date records to delete. Only the "i_calendar_day" field must be specified for each record. Note: it overrides the "from", "to" and "type" filters. These filters are ignored if "date_list" is present. |
Min value: 1 |
from | No | date | No | Delete all calendar date records starting from this date. Cannot be used with the "date_list" parameter. | |
to | No | date | No | Delete all calendar date records up to and including this date. Cannot be used with the "date_list" parameter. | |
type | No | string | No | Delete only calendar date records of a specific type. Cannot be used with the "date_list" parameter. Possible values: working, non-working. |
Possible values: non-working, working |
DeleteDatesBatchResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
success | Yes | int | No | 1 for success. |
get_date_list | |
This method enables an API user to get the list of calendar date records (e.g. the list of non-working days for this year) | |
Parameters | GetDateListRequest |
Return Value | GetDateListResponse |
Realm | administrator |
Standalone mode support | No |
GetDateListRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
from | No | date | No | Get all calendar date records starting from this date. | |
limit | No | int | No | The number of rows to retrieve. Used to limit the number of records returned in the response. Can be used without the "offset" parameter. | |
offset | No | int | No | The number of rows to skip at the beginning of the list. Can be used only if the "limit" parameter is set. Default value: 0. |
Default value: 0 |
to | No | date | No | Get all calendar date records up to and including this date. | |
type | No | string | No | Get only calendar date records of a specific type. Possible values: working, non-working. |
Possible values: non-working, working |
GetDateListResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
date_list | Yes | Array of CalendarDateInfo structure | Yes | The list of calendar date records. |
update_dates_batch | |
This method enables an API user to update the list of calendar date records | |
Parameters | UpdateDatesBatchRequest |
Return Value | UpdateDatesBatchResponse |
Realm | administrator |
Standalone mode support | No |
UpdateDatesBatchRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
date_list | Yes | Array of CalendarDateInfo structure | No | The list of calendar date records. |
Min value: 1 |
UpdateDatesBatchResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
success | Yes | int | No | 1 for success. |
upload_dates | |||||||
This method enables an API user to upload a file with calendar date records information | |||||||
Parameters | UploadDatesBatchRequest | ||||||
Return Value | UploadDatesBatchResponse | ||||||
Realm | administrator | ||||||
Standalone mode support | No | ||||||
Attachments |
|
UploadDatesBatchRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
Does not include any properties |
UploadDatesBatchResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
success | Yes | int | No | 1 for success. |
add_call_barring_class | |
This method enables an API user to create a new call barring class record using the supplied data | |
Parameters | AddCallBarringClassRequest |
Return Value | AddCallBarringClassResponse |
Realm | administrator |
Standalone mode support | No |
AddCallBarringClassRequest | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
call_barring_class_info | Yes | CallBarringClassInfo structure | No | Information about the call barring class. |
AddCallBarringClassResponse | |||||
Property | Mandatory | Type | Nillable | Description | Possible values |
i_cp_condition | Yes | unsignedLong | No | The unique ID of the call barring class. |