Auris Virtual CLEC Web Services - Help Document |
- Protocol Description | |
- Standard Transaction Submission | |
- Transaction Types | |
- Response Codes & Messages |
Protocol Description |
Auris Virtual CLEC Web Services allows clients' applications to securely connect directly to the Auris Application/Web Server and submit transaction data. All requests will be initiated by the client. The client submits the data in one of the two ways Https-Post or Https-Get. The Https Post/Get must consists of a set of fields that are required for each transaction, and a set of fields that are optional. The Client has the option of sending the configuration of the response on a per-transaction basis or using the default settings. The server responds a Name/Value pairs according to the client configuration. The 'Name' is the field name and indicates what information is being submitted and the 'Value' contains the content of the field. To implement, a developer would design a script that does the following: 1. Obtains all of the information needed to process a transaction. 2. Initiates a secure Https Post/Get from their server to https://service1.auris.com/vclec/ProcServices.asp? 3. Receives the response from the gateway and processes the response to display the appropriate result to the end user. Please contact Auris Technology to get your web services account (user_id + user_pw) when you are ready for development. Although it is not required, we recommend for you to register your server's IP Addresses with us so we only allow registered IPs to access web services for your security. |
Standard Transaction Submission |
The following tables contain the data fields that may be submitted to the system with any type of transaction. Each table contains the following information: Field Name - Name of the parameter that may be submitted on a transaction. Required - Indicates whether the field is required on a transaction. If Conditional, indicates that the field is required based on the existence or value of another field. In cases where a dependency exists, an explanation is provided. Field Type - Shows the data type and the data length for the field. Description - Provides additional details on how the field is used. |
Field Name | Required | Field Type | Description |
transaction_type | Yes | Integer | Constant value (Transaction Types) |
user_id | Yes | String (20) | Unique identifier of the client to access the Web Services. Auris will provide this identifier to the client. |
user_pw | Yes | String (20) | User Password of the client. Auris will provide this identifier to the client. |
field_delimeter | No | String (2) | Characters that will be used to separate fields in the transaction response. The system will use the character passed in this field or '&' as default if no value is passed. |
column_delimeter | No | String (2) | Characters that will be used between Name And Value pairs in the transaction response. The system will use the character passed in this field or '=' as default if no value is passed. |
response_type | No | String (2) | Constant value ('01'=text/html, '02'=text/plain, '03'=text/xml, '04'=redirect) The system will use the reponse type passed in this field or text/html as default if no value is passed. |
redirect_link | No | String (255) | Web page which resides on the clients' server. The system will redirect the user to this link with response values in query String. response_type parameter should be set to '04' for this option. |
Transaction Types |
Code | Transaction Type | Transaction Description |
401 | Insert Product | Create a new Virtual CLEC product, with or without a parent product. Billing details of the product can't be set at moment of creation, only on updates. |
402 | Get Product | Get all information of an existing Virtual CLEC product. |
403 | Update Product | Update an existing Virtual CLEC product. With this function all billing parameters can be set for a given product. |
404 | Get Product Minute Plan Regions | Returns all regions that are associated to the given plan id. These regions form the in-plan region group. |
405 | Insert Product Minute Plan Regions | Add a new region to a plan's in-plan region group. |
406 | Update Product Minute Plan Regions | Update a region that's part of a plan's in-plan region group. You can update the initial and increment period rounding for calls made to that region. |
407 | Copy Product Minute Plan | Copy a plan information into a new plan. |
408 | Get Account Details By ANI | Get all information for an account associated to the given ANI. This function also returns the account extra info if is available. |
409 | Insert Payment to Account | Post a payment or a recharge to a given account. With this function an amount (to pay a bill) or an out_of_plan_payment_amount (to recharge a PIN) must be sent. |
410 | Update Account | Update an account status, and/or override the product parameters (minimun balance, simultaneous calls, include lines) at the account level. |
411 | Update Account Extra Info | Update a given account extra information, customer name and contact information. |
412 | Create Account | Create an account tied to a single specific product with an initial account balance and initial out-of-plan balance. The account can be created with a disabled status thus delaying the start of billing to a later time. |
413 | Insert Account Extra Info | Add contact information (contact name, address, phone and email) to an existing account. |
414 | Insert ANI | Add a specific ANI number on the given account. This ANI will use and share (if account has more ANIs) the account's plan minutes and use the out-of-plan balance to make calls to regions not covered by the account's plans. |
415 | Get ANI(s) on Account | Get a list of all ANI numbers registered with a given account. |
416 | Delete ANI | Delete an ANI number from a given account. |
417 | Get Account Minute Plans By Account | Get all plans information for a given account. This function will return all plans that an account has and its respective billing and limits information. |
418 | Attach Account Minute Plan To Account | Add a new plan to an existing account. Only plans available to the account are allowed to be added. This availability is determined by the account's product and the plans already attached to the account. |
419 | Enable Plans | Enable one or more plans that are on disabled status. The bill cycle can be controlled also with this function, since the function allows for the continuing use of the current bill cycle or change it to a new one. Fees can also be tied as part of the enabling process (activation fees). |
420 | Disable Plans | Disable one or more plans that are on enable status. A bill flag can be used to indicate whether the plan(s) will continue to be billed or not. |
421 | Insert Adjustment | Apply an amount or a percentage adjustment to a given invoice. Adjustment are used to modify past invoices and can only be applied to them. |
422 | Insert Coupon | Create a coupon that can be applied at the product or plan level to modify the billing process. All coupons must be created before they can be applied. Coupons are used during billing events (registrations, additional orders, bill cycles). And can modify the amount of money or time duration calculated during a billing event. A single coupon can be used multiple times on different accounts. |
423 | Update Coupon | Update the information of an existing coupon. |
424 | Attach Coupon To Account | Apply a coupon to an existing account. It can be applied to specific plans, for 1 or more bill cycle periods (sticky coupon). The amount or duration period of the original coupon can be overriden. |
425 | Detach Coupon From Account | Detach a coupon from a existing plan on a given account. The detachment won't affect past billing events were the coupon has been used. |
426 | Insert Fee | Add a fee to a product or plan. This fee can be one time or recurring. |
427 | Update Fee | Update an existing fee. Can update the amount, description, status and whether is recurring or not. |
428 | Get FileGen Types | Get a list of all file types the Virtual CLEC system can generate for a given company and product. |
429 | Insert FileGen Request | Send a request for a specific file type for a given company and product. Files are never available inmediately for download, a request must be send first to start the file generation process. Then keep track of the file status using the transaction type 430. |
430 | Check FileGen File Request Status | Send a request for status for a specific file id, once the file is ready for download a URL is sent as part of the result to obtain the file. |
431 | Get Fees | Get a list of all fees that apply to a given plan id. It can be filtered by sending only the non-recurring, recurring or both. |
432 | Get Billing Record Types | Returns a list of all billing record types for a given company id. |
433 | Get Coupons Attached To Account | Get a list of all coupons attached to a given account without regards to whether it has been applied or not. |
434 | Get Redeemed Coupons By Account | Get a list of all coupons attached to a given account that have been applied already. |
435 | Get Coupons By Company Id | Get a list of all available coupons for a given company Id. |
437 | Get Available Plans With Taxes | Get a list of all plans available to a given account Id. If a zip code is provided each plan will return with the total tax amount. |
438 | Update Product Minute Plan | Update a plan assigned to a given product. |
439 | Insert Product Minute Plan | Create a new plan and assign to the given product. This plan will be available on that product. |
440 | Get Products Minute Plans | Get all the billing and limits information of the given plan Id. |
441 | Get In-Plan Call History | Returns a list of all in-plan calls made on the given card Id for the given month period. The in-plan calls are those calls that are covered by the plans' minutes that are attached to the account related to the given card Id. |
442 | Get Billing History For Account | Returns a list of all billing events for the given account Id during the given month period (if ALL is sent, then all available billing records are returned). |
443 | Get Countries | Get a list of countries with their Id. |
444 | Get Regions | Get a list of regions with their Id, and their country information (name, code and Id) |
445 | Get Invoices By Account | Get a list of all invoice Id and their bill date for the given account Id. |
446 | Enable Plans With Payment | Post a payment to a given account Id and if one or more plans are disabled, enable them. As with transaction type 409, the bill cycle period can also be changed or not. Fees can be applied since there is also a plan status change on this transaction type. |
447 | Get Estimated Cost of Next Bill | Get the amount of money the given account Id will be billed for each plan it has attached on the next bill cycle day. To get the given account Id next bill cycle date use the transaction type 417. |
448 | Delete Account Minute Plan | Delete a plan from a given account. This is the transaction type to call if a customer wants to cancel a plan. |
449 | Get DID Region Associations by PlanID | Returns a list of all region Ids available for DID numbers that are associated to the given plan Id. |
450 | Insert DID Region Association | Associate a region Id to a given plan Id for DID ordering. To order DID numbers a plan must have regions associated to it, since DID numbers have different costs for different regions. |
451 | Delete DID Region Association | Delete a region Id association from a plan Id for DID ordering. |
452 | Get Plans by DID Association by RegionID | Given a region Id it returns all DID plans that are associated to the given region. A customer that wants DID numbers for the given region ID will select plans from this list. |
453 | Search DID | Determine if there a DID numbers available for the given country code and area/city code. |
454 | Delete DID | Delete a DID number from the given account Id. This transaction type is independent from plan cancellation, a customer can returns a DID number without cancelling the plan that hosted the number. |
455 | Migrate DID to a Different Plan | Use this transaction type to move DID numbers from one plan to another. |
456 | Assign DID | Assign a DID number for the given country and city/area code to the given plan id. The transaction type 453 should always be called first to determine if there are DID numbers available for the given region. There are some countries that require a valid in-country address in order to provide a DID number. |
457 | Get Account Details by AccountID | Returns all account information for the given account Id. This also includes the account extra information, billing information and any product override that were applied to the account. |
458 | Get Account DID(s) by AccountID | Get a list of all DID numbers and their plan Ids attached to the given account Id. |
459 | DID FollowMe Insert | Assign an ANI to a DID number attached to the given account Id. A DID number can have up to 10 ANIs assigned to it. These ANI are not the same as the ones registered with the account. |
460 | DID FollowMe Delete | Delete an ANI from a DID number. |
461 | ANI Availability Check | Determine if a given ANI number is already registered with a given product id. |
462 | Apply Coupon Now | Apply a duration coupon to an account plan inmediately. This function is to be used whenever a number of minutes/seconds needs to be added to a plan in the middle of a bill cycle period. Duration from the applied coupon will only move to the following bill cycle periods if the plan has rollover duration enabled, otherwise any unused duration will be lost. |
463 | Update Account Minute Plan | This function allows for the update of a single account plan to have different settings overriding the original plan values when the customer signed up for it. |
464 | Refresh Account Plan Attributes from Product Plan | If a plan currently sold have its settings changed, existing customers that have already signed up for the changed plan will keep their original settings. This function allows those customers to have their plans refreshed with the new settings of the changed plan. |
465 | Get Invoice Details | This function returns all the details for the given invoice id (See transaction type 445. This function will return a separate line (or element) for each of the given invoice items like, plan charges, plan taxes, plan fees, product fees and any coupon detail applied to the invoice during the bill run. |
466 | Set Peak Times | This function allows the definition of the peak times for a given period. Any time period not covered by the peak times is defined as off-peak. |
467 | Get Peak Times | This function returns all the peak time periods for the given product id (See transaction type 466). |
468 | Delete Product Minute Plan Regions | This function removes a region or multiple regions from a Product Minute Plan. |
471 | Update DID Region Association | This function updates DID regions to allow region limits and allows a flag to determine which inventory pool to search through. |
474 | Shift Next Bill Date (Days) | This function updates the next bill date on accounts that are active +- days passed in. |
475 | Re-Calculate Account Minimum Balance | This function re-calculates the minimum balance for the specified account. |
510 | VOIP Account Information | Retrieves VOIP Account Information of the specified account. |
511 | VOIP Account Registration
(for existing prepaid customers) |
Creates a new VOIP account and registers VOIP Box's Virtual ANI number under the specified account. A VOIP box (using its valid MAC address) and DID Access Number(s) can be assigned to this account later. |
512 | VOIP Account Registration with New PIN Creation/Activation |
Creates a new VOIP account and registers VOIP Box's Virtual ANI number under a newly created and activated PIN with the amount provided under the identified product. A VOIP box (using its valid MAC address) and DID Access Number(s) can be assigned to this account later. |
513 | VOIP MAC Address Registration | Registers the entered MAC Address to a VOIP Box under the specified account. |
514 | VOIP VoiceMail | Performs several sub functions such as displaying or updating voice mail information of the accounts, deleting voice mail messages etc. |
515 | VOIP Account Delete | Deletes VOIP Accounts. |
516 | VOIP Account Check | Checks if the specified VOIP Account is already registered in the system. |
517 | VOIP Change Password | Updates VOIP Account Password. |
Insert Product Request |
Field Name | Required | Field Type | Description |
transaction_type | Yes | Integer | Constant value = 401 |
parent_product_id | No | Integer | ProductID of Parent Product. Constant value (0=deactive, 1=active). Default is 0. |
product_Name | Yes | String (50) | Description for Product |
reference_id | No | String (20) | Reference identifier assigned by client. This value is recorded for reporting purposes and will be passed back in the response. |
Field Name | Field Type | Description |
response_code | Integer | Indicates the result of the transaction as an integer (Response Codes). |
response_msg | String (80) | Indicates the result of the transaction as a text, which corresponds with the Response Code. |
response_desc | String (255) | Brief description of the result, which corresponds with the Response Code. |
transaction_type | Integer | Constant value = 401 |
transaction_id | Integer | Unique number assigned by Auris to identify the transaction in the system and can be used to submit a modification of this transaction at a later time, such as voiding, crediting or capturing the transaction. |
reference_id | String (20) | Echoed. |
ProductID | Integer | The ID value of the created product. |
Get Product Request |
Field Name | Required | Field Type | Description |
transaction_type | Yes | Integer | Constant value = 402 |
product_id | Yes | Integer | Product ID |
reference_id | No | String (20) | Reference identifier assigned by client. This value is recorded for reporting purposes and will be passed back in the response. |
Update Product Request |
Field Name | Required | Field Type | Description |
transaction_type | Yes | Integer | Constant value = 403 |
product_id | Yes | Integer | Product ID |
product_Name | No | String (50) | Description for Product. If this field is empty or not sent the product name will remain unchanged. |
pbprebill | Yes | Integer | Is the product pre-billed? (1 = Yes) |
product_min_plan_balance | No | Numeric(9,4) | Default = 0 Minimum balance for an active account of this product. |
out_of_plan_liability | No | Numeric(9,4) | Default = 0 Default amount of credit out of plan. |
add_line_fee | No | Numeric(9,4) | Default = 0 Cost for adding a line when greater than included lines in the plan. |
account_delinquency_period | Yes | Integer | Number of days before account should be turned off for non payment. |
payment_grace_period | No | Integer | Default = 0 Days after BillRun to collect funds before a late fee charge. |
payment_late_fee | No | Numeric(9,4) | Default = 0 Fee charged when Payment Grace Period is reached after Bill Run and Pament not posted. |
enable_payment_late_fee | No | Integer | Default = 0 Enables the above fee. |
multi_use | Yes | Integer | Product can have multiple lines on one account. |
multi_ani | No | Integer | Default value = 1. Product can have multiple ANI numbers on the same account. |
generate_invoices | No | Integer | Default value = 0. Indicate whether or not product generates invoices. |
draw_funds_from_prepaid_card | No | Integer | Default value = 0. Use 1 to draw any available funds from prepaid cardid for the bill cycle rate, otherwise use 0. |
apply_taxes | No | Integer | Default value = 0. Use 1 if the product will have taxes calculated and applied. |
simultaneous_calls | No | Integer | Default value = 1. Number of simultaneous calls allowed on this product per account. |
include_lines | No | Integer | Default value = 1. Maximum number of lines included on the product. |
bill_cycle_days | Yes | Integer | Number of days to define the product bill cycle period. |
bill_cycle_months | Yes | Integer | Number of months to define the product bill cycle period. |
is_prepaid | No | TinyInt | Default value = 1. Define whether the product is prepaid or not. |
fixed_monthly_bill_date | No | Integer | Default value = 0. Indicate the day of the month if the product is to be billed on a fixed date. |
last_use_exp_days | No | Integer | Default value = 0. Number of days without account activity before expiration statusID is set. |
reference_id | No | String (20) | Reference identifier assigned by client. This value is recorded for reporting purposes and will be passed back in the response. |
Field Name | Field Type | Description |
response_code | Integer | Indicates the result of the transaction as an integer (Response Codes). |
response_msg | String (80) | Indicates the result of the transaction as a text, which corresponds with the Response Code. |
response_desc | String (255) | Brief description of the result, which corresponds with the Response Code. |
transaction_type | Integer | Constant value = 403 |
transaction_id | Integer | Unique number assigned by Auris to identify the transaction in the system and can be used to submit a modification of this transaction at a later time, such as voiding, crediting or capturing the transaction. |
reference_id | String (20) | Echoed. |
Success | Integer | Value indicating the result of the function. 0 = FALSE/FAIL, 1 = TRUE/PASS. |
Get Product Minute Plan Regions Request |
Field Name | Required | Field Type | Description |
transaction_type | Yes | Integer | Constant value = 404 |
product_id | Yes | Integer | Product ID |
plan_id | Yes | Integer | Plan ID |
reference_id | No | String (20) | Reference identifier assigned by client. This value is recorded for reporting purposes and will be passed back in the response. |
Insert Product Minute Request |
Field Name | Required | Field Type | Description |
transaction_type | Yes | Integer | Constant value = 405 |
product_id | Yes | Integer | Product ID |
plan_id | Yes | Integer | Plan ID |
region_id | Yes | String(MAX) | Comma Delimited List of RegionIDs (See Output of Transaction Type 444 for RegionID List) |
reference_id | No | String (20) | Reference identifier assigned by client. This value is recorded for reporting purposes and will be passed back in the response. |
Field Name | Field Type | Description |
response_code | Integer | Indicates the result of the transaction as an integer (Response Codes). |
response_msg | String (80) | Indicates the result of the transaction as a text, which corresponds with the Response Code. |
response_desc | String (255) | Brief description of the result, which corresponds with the Response Code. |
transaction_type | Integer | Constant value = 405 |
transaction_id | Integer | Unique number assigned by Auris to identify the transaction in the system and can be used to submit a modification of this transaction at a later time, such as voiding, crediting or capturing the transaction. |
reference_id | String (20) | Echoed. |
Success | Integer | Value indicating the result of the function. 0 = FALSE/FAIL, 1 = TRUE/PASS. |
Update Product Minute Plan Regions Request |
Field Name | Required | Field Type | Description |
transaction_type | Yes | Integer | Constant value = 406 |
product_id | Yes | Integer | Product ID |
plan_id | Yes | Integer | Plan ID |
region_id | Yes | String(MAX) | Comma delimited list of region ids (See Output of Transaction Type 444 for RegionID List) |
bill_sec_first | Yes | Integer | First rounding increment for the call. |
bill_sec_inc | Yes | Integer | Additional rounding increment for the call. |
reference_id | No | String (20) | Reference identifier assigned by client. This value is recorded for reporting purposes and will be passed back in the response. |
Field Name | Field Type | Description |
response_code | Integer | Indicates the result of the transaction as an integer (Response Codes). |
response_msg | String (80) | Indicates the result of the transaction as a text, which corresponds with the Response Code. |
response_desc | String (255) | Brief description of the result, which corresponds with the Response Code. |
transaction_type | Integer | Constant value = 406 |
transaction_id | Integer | Unique number assigned by Auris to identify the transaction in the system and can be used to submit a modification of this transaction at a later time, such as voiding, crediting or capturing the transaction. |
reference_id | String (20) | Echoed. |
Success | Integer | Value indicating the result of the function. 0 = FALSE/FAIL, 1 = TRUE/PASS. |
Copy Product Minute Plan Request |
Field Name | Required | Field Type | Description |
transaction_type | Yes | Integer | Constant value = 407 |
product_id | Yes | Integer | Product ID |
plan_name | Yes | String(50) | Plan Name for the newly copied plan |
description | Yes | String(100) | Plan Description for the newly copid plan |
source_plan_id | Yes | Integer | PlanID to copy from for new plan |
reference_id | No | String (20) | Reference identifier assigned by client. This value is recorded for reporting purposes and will be passed back in the response. |
Field Name | Field Type | Description |
response_code | Integer | Indicates the result of the transaction as an integer (Response Codes). |
response_msg | String (80) | Indicates the result of the transaction as a text, which corresponds with the Response Code. |
response_desc | String (255) | Brief description of the result, which corresponds with the Response Code. |
transaction_type | Integer | Constant value = 407 |
transaction_id | Integer | Unique number assigned by Auris to identify the transaction in the system and can be used to submit a modification of this transaction at a later time, such as voiding, crediting or capturing the transaction. |
reference_id | String (20) | Echoed. |
plan_id | Integer | Plan ID |
Get Account Details By ANI Request |
Field Name | Required | Field Type | Description |
transaction_type | Yes | Integer | Constant value = 408 |
product_id | No | Integer | Product ID |
plan_ids | No | Integer | Plan ID to retrieve product_id |
ani | Yes | Varchar(28) | Number to look up account by |
reference_id | No | String (20) | Reference identifier assigned by client. This value is recorded for reporting purposes and will be passed back in the response. |
Insert Payment To Account Request |
Field Name | Required | Field Type | Description |
transaction_type | Yes | Integer | Constant value = 409 |
product_id | Yes | Integer | Product ID |
account_id | Yes | BigInt | Account ID |
amount | No | Numeric(9,4) | Default = 0 Amount to apply to Account balance. |
out_of_plan_payment_amount | No | Numeric(9,4) | Default = 0 Amount to apply to PIN balance in Prepaid (Out of Plan region credit). |
reference_id | No | String (20) | Reference identifier assigned by client. This value is recorded for reporting purposes and will be passed back in the response. |
Field Name | Field Type | Description |
response_code | Integer | Indicates the result of the transaction as an integer (Response Codes). |
response_msg | String (80) | Indicates the result of the transaction as a text, which corresponds with the Response Code. |
response_desc | String (255) | Brief description of the result, which corresponds with the Response Code. |
transaction_type | Integer | Constant value = 409 |
transaction_id | Integer | Unique number assigned by Auris to identify the transaction in the system and can be used to submit a modification of this transaction at a later time, such as voiding, crediting or capturing the transaction. |
reference_id | String (20) | Echoed. |
Success | Integer | Value indicating the result of the function. 0 = FALSE/FAIL, 1 OR GREATER = TRUE/PASS. |
Update Account Request |
Field Name | Required | Field Type | Description |
transaction_type | Yes | Integer | Constant value = 410 |
product_id | Yes | Integer | Product ID |
account_id | Yes | BigInt | Account ID |
status_id | Yes | Integer | 1 for Enabled; 0 for Disabled. |
time_zone | No | Integer | Time Zone defaults to -5 if time_zone is empty |
minimum_balance | No | Numeric(9,4) | Override product minimum balance. |
simultaneous_calls | No | Integer | Override product simultaneous calls. |
include_lines | No | Integer | Override product maximum line count. |
termination_date | No | DateTime | The account and plans will be terminated on this date. |
reference_id | No | String (20) | Reference identifier assigned by client. This value is recorded for reporting purposes and will be passed back in the response. |
Field Name | Field Type | Description |
response_code | Integer | Indicates the result of the transaction as an integer (Response Codes). |
response_msg | String (80) | Indicates the result of the transaction as a text, which corresponds with the Response Code. |
response_desc | String (255) | Brief description of the result, which corresponds with the Response Code. |
transaction_type | Integer | Constant value = 410 |
transaction_id | Integer | Unique number assigned by Auris to identify the transaction in the system and can be used to submit a modification of this transaction at a later time, such as voiding, crediting or capturing the transaction. |
reference_id | String (20) | Echoed. |
Success | Integer | Value indicating the result of the function. 0 = FALSE/FAIL, 1 = TRUE/PASS. |
Update Account Extra Info Request |
Field Name | Required | Field Type | Description |
transaction_type | Yes | Integer | Constant value = 411 |
product_id | Yes | Integer | Product ID |
account_id | Yes | BigInt | Account ID |
last_name | No | String(30) | Last Name |
first_name | No | String(30) | First Name |
middle_initial | No | String(10) | Middle Initial |
Yes | String(255) | ||
phone1 | No | String(28) | Phone 1 |
phone2 | No | String(28) | Phone 2 |
address1 | No | String(max) | Address 1 |
address2 | No | String(max) | Address 2 |
city | No | String(30) | City |
us_state | No | String(2) | US State |
foreign_state | No | String(30) | Foreign State |
zip_code | No | String(10) | Used for Taxes |
country_id | Yes | Integer | Country ID |
building_no | No | String(20) | Building number in address if available. |
salutation | No | String(20) | Salutation examples: Mr., Mrs., Ms., Dr. |
company_name | No | String(100) | Company Name |
account_info_id | Yes | BigInt | ID used to update the information |
reference_id | No | String (20) | Reference identifier assigned by client. This value is recorded for reporting purposes and will be passed back in the response. |
Field Name | Field Type | Description |
response_code | Integer | Indicates the result of the transaction as an integer (Response Codes). |
response_msg | String (80) | Indicates the result of the transaction as a text, which corresponds with the Response Code. |
response_desc | String (255) | Brief description of the result, which corresponds with the Response Code. |
transaction_type | Integer | Constant value = 411 |
transaction_id | Integer | Unique number assigned by Auris to identify the transaction in the system and can be used to submit a modification of this transaction at a later time, such as voiding, crediting or capturing the transaction. |
reference_id | String (20) | Echoed. |
Success | Integer | Value indicating the result of the function. 0 = FALSE/FAIL, 1 = TRUE/PASS. |
Create Account Request |
Field Name | Required | Field Type | Description |
transaction_type | Yes | Integer | Constant value = 412 |
product_id | Yes | Integer | Product ID |
balance | Yes | Numeric(9,4) | Initial Balance to start account (Suggested Balance = 0). |
status_id | Yes | Integer | 1 = Enabled; 0 = Disabled; |
time_zone | No | Integer | UTC based time zone. Only hours format. Ex. -5 for Eastern Standard Time. |
existing_card_id | No | Integer | Existing cardID from Auris Prepaid. (Can setup funds drawn from prepaid) |
out_of_plan_credit | No | Numeric(9,4) | Initial amount of out-of-plan balance to give account. |
reference_id | No | String (20) | Reference identifier assigned by client. This value is recorded for reporting purposes and will be passed back in the response. |
Field Name | Field Type | Description |
response_code | Integer | Indicates the result of the transaction as an integer (Response Codes). |
response_msg | String (80) | Indicates the result of the transaction as a text, which corresponds with the Response Code. |
response_desc | String (255) | Brief description of the result, which corresponds with the Response Code. |
transaction_type | Integer | Constant value = 412 |
transaction_id | Integer | Unique number assigned by Auris to identify the transaction in the system and can be used to submit a modification of this transaction at a later time, such as voiding, crediting or capturing the transaction. |
reference_id | String (20) | Echoed. |
AccountID | BigInt | Returns account ID value. 0 = FAILED, 1 OR GREATER = PASS/ACCOUNT CREATED. |
Insert Account Extra Info Request |
Field Name | Required | Field Type | Description |
transaction_type | Yes | Integer | Constant value = 413 |
product_id | Yes | Integer | Product ID |
account_id | Yes | Integer | Account ID |
last_name | No | String(30) | Last Name |
first_name | No | String(30) | First Name |
middle_initial | No | String(10) | Middle Initial |
Yes | String(255) | ||
phone1 | No | String(28) | Phone 1 |
phone2 | No | String(28) | Phone 2 |
address1 | No | String(max) | Address 1 |
address2 | No | String(max) | Address 2 |
city | No | String(30) | City |
us_state | No | String(2) | US State |
foreign_state | No | String(30) | Foreign State |
zip_code | No | String(10) | Zip Code |
country_id | Yes | Integer | Country ID |
building_no | No | String(20) | Building number in address if available. |
salutation | No | String(20) | Salutation examples: Mr., Mrs., Ms., Dr. |
company_name | No | String(100) | Company Name |
reference_id | No | String (20) | Reference identifier assigned by client. This value is recorded for reporting purposes and will be passed back in the response. |
Field Name | Field Type | Description |
response_code | Integer | Indicates the result of the transaction as an integer (Response Codes). |
response_msg | String (80) | Indicates the result of the transaction as a text, which corresponds with the Response Code. |
response_desc | String (255) | Brief description of the result, which corresponds with the Response Code. |
transaction_type | Integer | Constant value = 413 |
transaction_id | Integer | Unique number assigned by Auris to identify the transaction in the system and can be used to submit a modification of this transaction at a later time, such as voiding, crediting or capturing the transaction. |
reference_id | String (20) | Echoed. |
AccountInfoID | BigInt | Account Info Id |
Inser ANI Request |
Field Name | Required | Field Type | Description |
transaction_type | Yes | Integer | Constant value = 414 |
product_id | Yes | Integer | Product ID |
account_id | Yes | BigInt | Account ID |
ani | Yes | String(28) | User Calling Number |
charge_ani | No | Integer | Default = 1 Will charge the additional line fee if this fee amount is greater than zero. |
is_voip | No | Integer | Default = 0 Will attempt to insert your ani as a voip number the system recognizes. |
reference_id | No | String (20) | Reference identifier assigned by client. This value is recorded for reporting purposes and will be passed back in the response. |
Field Name | Field Type | Description |
response_code | Integer | Indicates the result of the transaction as an integer (Response Codes). |
response_msg | String (80) | Indicates the result of the transaction as a text, which corresponds with the Response Code. |
response_desc | String (255) | Brief description of the result, which corresponds with the Response Code. |
transaction_type | Integer | Constant value = 414 |
transaction_id | Integer | Unique number assigned by Auris to identify the transaction in the system and can be used to submit a modification of this transaction at a later time, such as voiding, crediting or capturing the transaction. |
reference_id | String (20) | Echoed. |
Success | Integer | Value indicating the result of the function. 0 = FALSE/FAIL, 1 = TRUE/PASS. |
Get Ani(s) on Account Request |
Field Name | Required | Field Type | Description |
transaction_type | Yes | Integer | Constant value = 415 |
product_id | Yes | Integer | Product ID |
account_id | Yes | BigInt | Account ID |
reference_id | No | String (20) | Reference identifier assigned by client. This value is recorded for reporting purposes and will be passed back in the response. |
Delete Ani Request |
Field Name | Required | Field Type | Description |
transaction_type | Yes | Integer | Constant value = 416 |
product_id | Yes | Integer | Product ID |
account_id | Yes | BigInt | Account ID |
ani | Yes | String(28) | User Calling Number. |
reference_id | No | String (20) | Reference identifier assigned by client. This value is recorded for reporting purposes and will be passed back in the response. |
Field Name | Field Type | Description |
response_code | Integer | Indicates the result of the transaction as an integer (Response Codes). |
response_msg | String (80) | Indicates the result of the transaction as a text, which corresponds with the Response Code. |
response_desc | String (255) | Brief description of the result, which corresponds with the Response Code. |
transaction_type | Integer | Constant value = 416 |
transaction_id | Integer | Unique number assigned by Auris to identify the transaction in the system and can be used to submit a modification of this transaction at a later time, such as voiding, crediting or capturing the transaction. |
reference_id | String (20) | Echoed. |
Success | Integer | Value indicating the result of the function. 0 = FALSE/FAIL, 1 = TRUE/PASS. |
Get Account Minute Plans By Account Request |
Field Name | Required | Field Type | Description |
transaction_type | Yes | Integer | Constant value = 417 |
product_id | Yes | Integer | Product ID |
account_id | Yes | BigInt | Account ID |
plan_id | No | Integer | Default=0 Plan ID |
reference_id | No | String (20) | Reference identifier assigned by client. This value is recorded for reporting purposes and will be passed back in the response. |
Attach Account Minute Plan to Account Request |
Field Name | Required | Field Type | Description |
transaction_type | Yes | Integer | Constant value = 418 |
product_id | Yes | Integer | Product ID |
account_id | Yes | BigInt | Account ID |
plan_id | Yes | Integer | Plan to attach to account |
last_bill_date | No | Integer | Default=0 The last contract day of this billing plan. |
status_id | No | Integer | Default=0 Should always attach account minute plan with StatusID = 0; (Disabled); |
reference_id | No | String (20) | Reference identifier assigned by client. This value is recorded for reporting purposes and will be passed back in the response. |
Field Name | Field Type | Description |
response_code | Integer | Indicates the result of the transaction as an integer (Response Codes). |
response_msg | String (80) | Indicates the result of the transaction as a text, which corresponds with the Response Code. |
response_desc | String (255) | Brief description of the result, which corresponds with the Response Code. |
transaction_type | Integer | Constant value = 418 |
transaction_id | Integer | Unique number assigned by Auris to identify the transaction in the system and can be used to submit a modification of this transaction at a later time, such as voiding, crediting or capturing the transaction. |
reference_id | String (20) | Echoed. |
Success | Integer | Value indicating the result of the function. 0 = FALSE/FAIL, 1 = TRUE/PASS. |
Enable Plans Request |
Field Name | Required | Field Type | Description |
transaction_type | Yes | Integer | Constant value = 419 |
product_id | Yes | Integer | Product ID |
account_id | Yes | BigInt | Account ID |
plan_ids | Yes | String(512) | Comma delimited list of plans to enable |
bill | Yes | Integer | Should always set Bill = 1; This will bill for the plan; |
renew_bill_date | No | Integer | Default=0 Set new Bill-Cycle; Starting Today; |
fee_id_list | No | String(512) | Comma Delimited List of Fees to charge. |
starting_bill_date | No | DateTime | Date to start the billing period for the plan. If no date is sent, then the starting bill date will be date the plan is enabled. |
reference_id | No | String (20) | Reference identifier assigned by client. This value is recorded for reporting purposes and will be passed back in the response. |
Field Name | Field Type | Description |
response_code | Integer | Indicates the result of the transaction as an integer (Response Codes). |
response_msg | String (80) | Indicates the result of the transaction as a text, which corresponds with the Response Code. |
response_desc | String (255) | Brief description of the result, which corresponds with the Response Code. |
transaction_type | Integer | Constant value = 419 |
transaction_id | Integer | Unique number assigned by Auris to identify the transaction in the system and can be used to submit a modification of this transaction at a later time, such as voiding, crediting or capturing the transaction. |
reference_id | String (20) | Echoed. |
Success | Integer | Value indicating the result of the function.
|
Disable Plans Request |
Field Name | Required | Field Type | Description |
transaction_type | Yes | Integer | Constant value = 420 |
product_id | Yes | Integer | Product ID |
account_id | Yes | BigInt | Account ID |
plan_ids | Yes | String(512) | Comma delimited list of plans to enable |
bill | Yes | Integer | Should always set Bill = 1; This will bill for the plan; |
fee_id_list | No | String(512) | Comma Delimited List of Fees to charge. |
reference_id | No | String (20) | Reference identifier assigned by client. This value is recorded for reporting purposes and will be passed back in the response. |
Field Name | Field Type | Description |
response_code | Integer | Indicates the result of the transaction as an integer (Response Codes). |
response_msg | String (80) | Indicates the result of the transaction as a text, which corresponds with the Response Code. |
response_desc | String (255) | Brief description of the result, which corresponds with the Response Code. |
transaction_type | Integer | Constant value = 420 |
transaction_id | Integer | Unique number assigned by Auris to identify the transaction in the system and can be used to submit a modification of this transaction at a later time, such as voiding, crediting or capturing the transaction. |
reference_id | String (20) | Echoed. |
Success | Integer | Value indicating the result of the function.
|
Insert Adjustment Request |
Field Name | Required | Field Type | Description |
transaction_type | Yes | Integer | Constant value = 421 |
product_id | Yes | Integer | Product ID |
account_id | Yes | BigInt | Account ID |
invoice_id | Yes | Integer | ID of Invoice to Adjust |
amount | No | Numeric(9,4) | Default=0 Amount to adjust account; (Overrides AmountPercentage); |
amount_percentage | No | Numeric(9,4) | Default=0 Percentage of cost of particular specified plans; |
adjust_balance | No | Integer | Default=0 Will not adjust the customer balance. It's the company's responsibility to credit the account. |
apply_to_planids | No | String(512) | Comma Delimited List of Plans for which to calculate the AmountPercentage |
reference_id | No | String (20) | Reference identifier assigned by client. This value is recorded for reporting purposes and will be passed back in the response. |
Field Name | Field Type | Description |
response_code | Integer | Indicates the result of the transaction as an integer (Response Codes). |
response_msg | String (80) | Indicates the result of the transaction as a text, which corresponds with the Response Code. |
response_desc | String (255) | Brief description of the result, which corresponds with the Response Code. |
transaction_type | Integer | Constant value = 421 |
transaction_id | Integer | Unique number assigned by Auris to identify the transaction in the system and can be used to submit a modification of this transaction at a later time, such as voiding, crediting or capturing the transaction. |
reference_id | String (20) | Echoed. |
BDRID | Integer | BDRID > 0 = Success |
EndBalance | Numeric(9,4) | Invoice balance after adjustment |
Insert Coupon Request |
Field Name | Required | Field Type | Description |
transaction_type | Yes | Integer | Constant value = 422 |
coupon_code | No | String(100) | Coupon Identifier [Used for End User To have Coupon Code [FutureUse]] |
coupon_price | No | Numeric(9,4) | Default=0 Explicit amount given to the plan. |
coupon_minutes | No | Numeric(9,4) | Default=0 Explicit minutes given to the plan. |
coupon_price_percentage | No | Numeric(9,4) | Default=0 Calculated percentage of a particular plans' cost. (Requries a PlanID to be specified) |
coupon_minute_percentage | No | Numeric(9,4) | Default=0 Calculated percentage of a particular plans' minutes. (Requries a PlanID to be specified) |
apply_to_peak_minutes | No | Integer | If Set to 1 and Minutes are given on this coupon, the minutes will be applied to peak minutes |
expiration_date | No | DateTime | DateTime stamp for the expiration of the Coupon |
description | No | String(100) | Long Description of Coupon |
status_id | No | Integer | 1=Enable/0=Disable |
reference_id | No | String (20) | Reference identifier assigned by client. This value is recorded for reporting purposes and will be passed back in the response. |
Field Name | Field Type | Description |
response_code | Integer | Indicates the result of the transaction as an integer (Response Codes). |
response_msg | String (80) | Indicates the result of the transaction as a text, which corresponds with the Response Code. |
response_desc | String (255) | Brief description of the result, which corresponds with the Response Code. |
transaction_type | Integer | Constant value = 422 |
transaction_id | Integer | Unique number assigned by Auris to identify the transaction in the system and can be used to submit a modification of this transaction at a later time, such as voiding, crediting or capturing the transaction. |
reference_id | String (20) | Echoed. |
coupon_id | Integer | Coupon ID |
Update Coupon Request |
Field Name | Required | Field Type | Description |
transaction_type | Yes | Integer | Constant value = 423 |
product_id | Yes | Integer | Product ID |
coupon_code | No | String(100) | Coupon Identifier [Used for End User To have Coupon Code [FutureUse]] |
coupon_price | No | Numeric(9,4) | Default=0 Explicit amount given to the plan. |
coupon_minutes | No | Numeric(9,4) | Default=0 Explicit minutes given to the plan. |
coupon_price_percentage | No | Numeric(9,4) | Default=0 Calculated percentage of a particular plans' cost. (Requries a PlanID to be specified) |
coupon_minute_percentage | No | Numeric(9,4) | Default=0 Calculated percentage of a particular plans' minutes. (Requries a PlanID to be specified) |
expiration_date | No | DateTime | DateTime stamp for the expiration of the Coupon |
description | Yes | String(100) | Long Description of Coupon |
coupon_id | Yes | Integer | ID of coupon to update |
status_id | Yes | Integer | 1=Enable/0=Disable |
apply_to_peak_minutes | No | Integer | Default=0 If Set to 1 and Minutes are given on this coupon, the minutes will be applied to peak minutes |
reference_id | No | String (20) | Reference identifier assigned by client. This value is recorded for reporting purposes and will be passed back in the response. |
Field Name | Field Type | Description |
response_code | Integer | Indicates the result of the transaction as an integer (Response Codes). |
response_msg | String (80) | Indicates the result of the transaction as a text, which corresponds with the Response Code. |
response_desc | String (255) | Brief description of the result, which corresponds with the Response Code. |
transaction_type | Integer | Constant value = 423 |
transaction_id | Integer | Unique number assigned by Auris to identify the transaction in the system and can be used to submit a modification of this transaction at a later time, such as voiding, crediting or capturing the transaction. |
reference_id | String (20) | Echoed. |
Success | Integer | Value indicating the result of the function. 0 = FALSE/FAIL, 1 = TRUE/PASS. |
Attach Coupon to Account Request |
Field Name | Required | Field Type | Description |
transaction_type | Yes | Integer | Constant value = 424 |
product_id | Yes | Integer | Product ID |
account_id | Yes | BigInt | Account ID |
coupon_id | Yes | Integer | Coupon ID |
apply_to_planids | No | String(512) | This will allow setting the coupon on multiple plans or the product (not a plan). |
sticky_coupon | No | Integer | Default=0 Keeps the coupon on the account past the use of it the first time. |
coupon_starting_date | No | DateTime | Default=TODAY Date the coupon starts to apply. |
expiration_date | No | DateTime | DateTime stamp for the expiration of use of this Coupon on this account. |
amount_override | No | Numeric(9,4) | Override the coupon amount. |
seconds_override | No | Integer | Override the coupon seconds. |
reference_id | No | String (20) | Reference identifier assigned by client. This value is recorded for reporting purposes and will be passed back in the response. |
Field Name | Field Type | Description |
response_code | Integer | Indicates the result of the transaction as an integer (Response Codes). |
response_msg | String (80) | Indicates the result of the transaction as a text, which corresponds with the Response Code. |
response_desc | String (255) | Brief description of the result, which corresponds with the Response Code. |
transaction_type | Integer | Constant value = 424 |
transaction_id | Integer | Unique number assigned by Auris to identify the transaction in the system and can be used to submit a modification of this transaction at a later time, such as voiding, crediting or capturing the transaction. |
reference_id | String (20) | Echoed. |
Success | Integer | Value indicating the result of the function. 0 = FALSE/FAIL, 1 = TRUE/PASS. |
Detach Coupon from Account Request |
Field Name | Required | Field Type | Description |
transaction_type | Yes | Integer | Constant value = 425 |
product_id | Yes | Integer | Product ID |
account_id | Yes | BigInt | Account ID |
coupon_id | Yes | Integer | Coupon ID |
plan_id | Yes | Integer | Plan ID |
reference_id | No | String (20) | Reference identifier assigned by client. This value is recorded for reporting purposes and will be passed back in the response. |
Field Name | Field Type | Description |
response_code | Integer | Indicates the result of the transaction as an integer (Response Codes). |
response_msg | String (80) | Indicates the result of the transaction as a text, which corresponds with the Response Code. |
response_desc | String (255) | Brief description of the result, which corresponds with the Response Code. |
transaction_type | Integer | Constant value = 425 |
transaction_id | Integer | Unique number assigned by Auris to identify the transaction in the system and can be used to submit a modification of this transaction at a later time, such as voiding, crediting or capturing the transaction. |
reference_id | String (20) | Echoed. |
Success | Integer | Value indicating the result of the function. 0 = FALSE/FAIL, 1 = TRUE/PASS. |
Insert Fee Request |
Field Name | Required | Field Type | Description |
transaction_type | Yes | Integer | Constant value = 426 |
product_id | Yes | Integer | Product ID |
plan_id | Yes | Integer | Plan ID |
description | Yes | String(100) | Long Description for Fee |
amount | No | Numeric(9,4) | Default = 0 Amount to Insert. |
recurring | No | Integer | Default = 0 Sets the fee to occur every bill-cycle. |
reference_id | No | String (20) | Reference identifier assigned by client. This value is recorded for reporting purposes and will be passed back in the response. |
Field Name | Field Type | Description |
response_code | Integer | Indicates the result of the transaction as an integer (Response Codes). |
response_msg | String (80) | Indicates the result of the transaction as a text, which corresponds with the Response Code. |
response_desc | String (255) | Brief description of the result, which corresponds with the Response Code. |
transaction_type | Integer | Constant value = 426 |
transaction_id | Integer | Unique number assigned by Auris to identify the transaction in the system and can be used to submit a modification of this transaction at a later time, such as voiding, crediting or capturing the transaction. |
reference_id | String (20) | Echoed. |
fee_id | Integer | Fee ID |
Update Fee Request |
Field Name | Required | Field Type | Description |
transaction_type | Yes | Integer | Constant value = 427 |
product_id | Yes | Integer | Product ID |
plan_id | Yes | Integer | Plan ID |
description | Yes | String(100) | Long Description of Fee |
amount | No | Numeric(9,4) | Default = 0 Amount to Update |
recurring | No | Integer | Default = 0 Sets the fee to occur every bill-cycle. |
fee_id | Yes | Integer | ID of the Fee to update. |
status | Yes | Integer | 1=Enable/0=Disable |
reference_id | No | String (20) | Reference identifier assigned by client. This value is recorded for reporting purposes and will be passed back in the response. |
Field Name | Field Type | Description |
response_code | Integer | Indicates the result of the transaction as an integer (Response Codes). |
response_msg | String (80) | Indicates the result of the transaction as a text, which corresponds with the Response Code. |
response_desc | String (255) | Brief description of the result, which corresponds with the Response Code. |
transaction_type | Integer | Constant value = 427 |
transaction_id | Integer | Unique number assigned by Auris to identify the transaction in the system and can be used to submit a modification of this transaction at a later time, such as voiding, crediting or capturing the transaction. |
reference_id | String (20) | Echoed. |
Success | Integer | Value indicating the result of the function. 0 = FALSE/FAIL, 1 = TRUE/PASS. |
Get FileGen Types Request |
Field Name | Required | Field Type | Description |
transaction_type | Yes | Integer | Constant value = 428 |
product_id | Yes | Integer | Product ID |
reference_id | No | String (20) | Reference identifier assigned by client. This value is recorded for reporting purposes and will be passed back in the response. |
Insert FileGen Types Request |
Field Name | Required | Field Type | Description |
transaction_type | Yes | Integer | Constant value = 429 |
product_id | Yes | Integer | Product ID |
file_type_id | Yes | Integer | Auris [PreGenerated FileTypes] -> See Webservice Transaction Type : 428 |
params | No | String(512) | Optional parameters |
reference_id | No | String (20) | Reference identifier assigned by client. This value is recorded for reporting purposes and will be passed back in the response. |
Field Name | Field Type | Description |
response_code | Integer | Indicates the result of the transaction as an integer (Response Codes). |
response_msg | String (80) | Indicates the result of the transaction as a text, which corresponds with the Response Code. |
response_desc | String (255) | Brief description of the result, which corresponds with the Response Code. |
transaction_type | Integer | Constant value = 429 |
transaction_id | Integer | Unique number assigned by Auris to identify the transaction in the system and can be used to submit a modification of this transaction at a later time, such as voiding, crediting or capturing the transaction. |
reference_id | String (20) | Echoed. |
file_id | Integer | File ID |
Check FileGen File Request Status Request |
Field Name | Required | Field Type | Description |
transaction_type | Yes | Integer | Constant value = 430 |
file_id | Yes | Integer | File to check the status of; FileID is returned from Insert FileGen Request (TransType: 429) |
reference_id | No | String (20) | Reference identifier assigned by client. This value is recorded for reporting purposes and will be passed back in the response. |
Field Name | Field Type | Description |
response_code | Integer | Indicates the result of the transaction as an integer (Response Codes). |
response_msg | String (80) | Indicates the result of the transaction as a text, which corresponds with the Response Code. |
response_desc | String (255) | Brief description of the result, which corresponds with the Response Code. |
transaction_type | Integer | Constant value = 430 |
transaction_id | Integer | Unique number assigned by Auris to identify the transaction in the system and can be used to submit a modification of this transaction at a later time, such as voiding, crediting or capturing the transaction. |
reference_id | String (20) | Echoed. |
StatusID | Integer | Status ID |
BaseURL | String | Internet address to download the requested file. |
FileKey | String | A unique string key generated per initial request. To get the download file combine the BaseURL + ClienteKey + FileKey. The ClientKey is a unique string assigned to a Company. |
Get Fees Request |
Field Name | Required | Field Type | Description |
transaction_type | Yes | Integer | Constant Value = 431 |
product_id | Yes | Integer | Product ID |
plan_id | Yes | Integer | PlanID ID to check fee for |
recurring | Yes | Integer | Not recurring =0;Recurring =1;Both=2 |
reference_id | No | String (20) | Reference identifier assigned by client. This value is recorded for reporting purposes and will be passed back in the response. |
Get Billing Record Types Request |
Field Name | Required | Field Type | Description |
transaction_type | Yes | Integer | Constant Value = 432 |
reference_id | No | String (20) | Reference identifier assigned by client. This value is recorded for reporting purposes and will be passed back in the response. |
Get Coupons Attached to Account Request |
Field Name | Required | Field Type | Description |
transaction_type | Yes | Integer | Constant Value = 433 |
product_id | Yes | Integer | Product ID |
account_id | Yes | BigInt | Account ID |
reference_id | No | String (20) | Reference identifier assigned by client. This value is recorded for reporting purposes and will be passed back in the response. |
Get Redeemed Coupons By Account Request |
Field Name | Required | Field Type | Description |
transaction_type | Yes | Integer | Constant Value = 434 |
product_id | Yes | Integer | Product ID |
account_id | Yes | BigInt | Account ID |
reference_id | No | String (20) | Reference identifier assigned by client. This value is recorded for reporting purposes and will be passed back in the response. |
Get Coupons By CompanyID Request |
Field Name | Required | Field Type | Description |
transaction_type | Yes | Integer | Constant Value = 435 |
product_id | No | Integer | Send a Product ID to return only the given product's coupons. |
reference_id | No | String (20) | Reference identifier assigned by client. This value is recorded for reporting purposes and will be passed back in the response. |
Get Available Plans with Taxes Request |
Field Name | Required | Field Type | Description |
transaction_type | Yes | Integer | Constant value = 437 |
product_id | Yes | Integer | Product ID |
account_id | No | BigInt | Default=0 Account ID needed for pro-rating. |
zip_code | No | String(10) | Used to calculate taxes |
plan_ids | No | String(512) | Comma delimited list of plans id. Must be supplied for tax calculation. |
reference_id | No | String (20) | Reference identifier assigned by client. This value is recorded for reporting purposes and will be passed back in the response. |
Update Product Minute Plan Request |
Field Name | Required | Field Type | Description |
transaction_type | Yes | Integer | Constant value = 438 |
product_id | Yes | Integer | Product ID |
plan_id | Yes | Integer | Product ID |
plan_name | Yes | String(50) | Plan Name |
description | No | String(100) | Long Description of Plan |
bill_sec_first | Yes | Integer | You may bill a first increment different than the additional increments, specify the number of seconds here |
bill_sec_inc | Yes | Integer | Each additional increment after the First Increment will be billed with this many seconds |
total_off_peak_seonds | Yes | Integer | Number of Off-Peak-Time seconds for this plan's bill cycle |
total_peak_seconds | Yes | Integer | Number of Peak-Time seconds for this plan's bill cycle |
umlimited_off_peak_seconds | No | Integer | Default = 0 Give Unlimited Off-Peak Seconds |
unlimited_peak_seconds | No | Integer | Default = 0 Give Unlimited Peak Seconds |
max_session_seconds | Yes | Integer | Maximum call length |
bill_cycle_rate | Yes | Numeric(9,4) | The Cost of the Plan per BillCycle |
promotion_rate_discount | No | Numeric(9,4) | Default = 0 The rate discount between [PromotionStart and PromotionEnd] or [PromotionLengthMonths/Days after Plan Activation] |
promotion_minute_discount | No | Numeric(9,4) | Default = 0 The minute discount between [PromotionStart and PromotionEnd] or [PromotionLengthMonths/Days after Plan Activation] |
promotion_start | No | DateTime | Specific Start Date for Promotion |
promotion_end | No | DateTime | Specific End Date for Promotion |
status_id | Yes | Integer | 1 to Enable Plan for use; 0 to Disable Plan for use |
enable_peak_rollover | No | Integer | Default = 0 To Rollover Peak Minutes, Set to 1 |
enable_off_peak_rollover | No | Integer | Default = 0 To Rollover Off-Peak Minutes, Set to 1 |
promotion_length_months | No | Integer | Default = 0 Months of Promotion after Activation |
promotion_legth_days | No | Integer | Default = 0 Days of Promotion after Activation |
included_dids | No | Integer | Default=0 Number of DID slots available for DID assignment |
maximum_limits_action | No | Integer | Action to take when maximum limits are reached; [-1 = Nothing; 0 = PlayPrompt; 1 = Customer Service Redirect] |
daily_peak_max_seconds | No | Integer | Maximum Peak Seconds allowed Daily on this Plan |
daily_off_peak_max_seconds | No | Integer | Maximum Off-Peak Seconds allowed Daily on this Plan |
weekly_peak_max_seconds | No | Integer | Maximum Peak Seconds allowed Weekly on this Plan |
weekly_off_peak_max_seconds | No | Integer | Maximum Off-Peak Seconds allowed Weekly on this Plan |
monthly_peak_max_seconds | No | Integer | Maximum Peak Seconds allowed Monthly on this Plan |
monthly_off_peak_max_seconds | No | Integer | Maximum Off-Peak Seconds allowed Monthly on this Plan |
daily_max_unique_destinations | No | Integer | Maximum Number of Unique Destinations allowed to be dialed Daily [00:00:00-23:59:59] Resets @ 00:00:00 Daily |
weekly_max_unique_destinations | No | Integer | Maximum Number of Unique Destinations allowed to be dialed Weekly |
monthly_max_unique_destinations | No | Integer | Maximum Number of Unique Destinations allowed to be dialed Monthly |
reset_fraud_limits_at_billrun | No | Integer | Default value=0 This will reset the overrides that have been placed at the ACCOUNT level each bill cycle |
did_release_grace_period_days | No | Integer | Default value=0 Number of days after the plan has been disabled, before the DID's are released |
reference_id | No | String (20) | Reference identifier assigned by client. This value is recorded for reporting purposes and will be passed back in the response. |
Field Name | Field Type | Description |
response_code | Integer | Indicates the result of the transaction as an integer (Response Codes). |
response_msg | String (80) | Indicates the result of the transaction as a text, which corresponds with the Response Code. |
response_desc | String (255) | Brief description of the result, which corresponds with the Response Code. |
transaction_type | Integer | Constant value = 438 |
transaction_id | Integer | Unique number assigned by Auris to identify the transaction in the system and can be used to submit a modification of this transaction at a later time, such as voiding, crediting or capturing the transaction. |
reference_id | String (20) | Echoed. |
Success | Integer | Value indicating the result of the function. 0 = FALSE/FAIL, 1 = TRUE/PASS. |
Insert Product Minute Plan Request |
Field Name | Required | Field Type | Description |
transaction_type | Yes | Integer | Constant value = 439 |
product_id | Yes | Integer | Product ID |
plan_name | Yes | String(50) | Plan Name |
description | No | String(100) | Long Description of Plan |
bill_sec_first | Yes | Integer | You may bill a first increment different than the additional increments, specify the number of seconds here |
bill_sec_inc | Yes | Integer | Each additional increment after the First Increment will be billed with this many seconds |
total_off_peak_seonds | Yes | Integer | Number of Off-Peak-Time seconds for this plan's bill cycle |
total_peak_seconds | Yes | Integer | Number of Peak-Time seconds for this plan's bill cycle |
umlimited_off_peak_seconds | No | Integer | Default = 0 Give Unlimited Off-Peak Seconds |
unlimited_peak_seconds | No | Integer | Default = 0 Give Unlimited Peak Seconds |
max_session_seconds | Yes | Integer | Maximum call length |
bill_cycle_rate | Yes | Numeric(9,4) | The Cost of the Plan per BillCycle |
promotion_rate_discount | No | Numeric(9,4) | Default = 0 The rate discount between [PromotionStart and PromotionEnd] or [PromotionLengthMonths/Days after Plan Activation] |
promotion_minute_discount | No | Numeric(9,4) | Default = 0 The minute discount between [PromotionStart and PromotionEnd] or [PromotionLengthMonths/Days after Plan Activation] |
promotion_start | No | DateTime | Specific Start Date for Promotion |
promotion_end | No | DateTime | Specific End Date for Promotion |
status_id | Yes | Integer | 1 to Enable Plan for use; 0 to Disable Plan for use |
enable_peak_rollover | No | Integer | Default = 0 To Rollover Peak Minutes, Set to 1 |
enable_off_peak_rollover | No | Integer | Default = 0 To Rollover Off-Peak Minutes, Set to 1 |
promotion_length_months | No | Integer | Default = 0 Months of Promotion after Activation |
promotion_legth_days | No | Integer | Default = 0 Days of Promotion after Activation |
included_dids | No | Integer | Default=0 Number of DID slots available for DID assignment |
maximum_limits_action | No | Integer | Action to take when maximum limits are reached; [-1 = Nothing; 0 = PlayPrompt; 1 = Customer Service Redirect] |
daily_peak_max_seconds | No | Integer | Maximum Peak Seconds allowed Daily on this Plan |
daily_off_peak_max_seconds | No | Integer | Maximum Off-Peak Seconds allowed Daily on this Plan |
weekly_peak_max_seconds | No | Integer | Maximum Peak Seconds allowed Weekly on this Plan |
weekly_off_peak_max_seconds | No | Integer | Maximum Off-Peak Seconds allowed Weekly on this Plan |
monthly_peak_max_seconds | No | Integer | Maximum Peak Seconds allowed Monthly on this Plan |
monthly_off_peak_max_seconds | No | Integer | Maximum Off-Peak Seconds allowed Monthly on this Plan |
daily_max_unique_destinations | No | Integer | Maximum Number of Unique Destinations allowed to be dialed Daily [00:00:00-23:59:59] Resets @ 00:00:00 Daily |
weekly_max_unique_destinations | No | Integer | Maximum Number of Unique Destinations allowed to be dialed Weekly |
monthly_max_unique_destinations | No | Integer | Maximum Number of Unique Destinations allowed to be dialed Monthly |
reset_fraud_limits_at_billrun | No | Integer | Default value=0 This will reset the overrides that have been placed at the ACCOUNT level each bill cycle |
did_release_grace_period_days | No | Integer | Default value=0 Number of days after the plan has been disabled, before the DID's are released |
reference_id | No | String (20) | Reference identifier assigned by client. This value is recorded for reporting purposes and will be passed back in the response. |
Field Name | Field Type | Description |
response_code | Integer | Indicates the result of the transaction as an integer (Response Codes). |
response_msg | String (80) | Indicates the result of the transaction as a text, which corresponds with the Response Code. |
response_desc | String (255) | Brief description of the result, which corresponds with the Response Code. |
transaction_type | Integer | Constant value = 439 |
transaction_id | Integer | Unique number assigned by Auris to identify the transaction in the system and can be used to submit a modification of this transaction at a later time, such as voiding, crediting or capturing the transaction. |
reference_id | String (20) | Echoed. |
plan_id | Integer | Plan ID |
Get Product Minute Plans Request |
Field Name | Required | Field Type | Description |
transaction_type | Yes | Integer | Constant value = 440 |
product_id | Yes | Integer | Product ID |
plan_id | No | Integer | Default = 0 [All Plans] Plan ID |
reference_id | No | String (20) | Reference identifier assigned by client. This value is recorded for reporting purposes and will be passed back in the response. |
Get In Plan Call History Request |
Field Name | Required | Field Type | Description |
transaction_type | Yes | Integer | Constant value = 441 |
product_id | Yes | Integer | Product ID |
card_id | Yes | Integer | Card ID |
month | Yes | String(6) | All or Month ex. 201012 (December 2010) |
reference_id | No | String (20) | Reference identifier assigned by client. This value is recorded for reporting purposes and will be passed back in the response. |
Get Billing History for Account Request |
Field Name | Required | Field Type | Description |
transaction_type | Yes | Integer | Constant value = 442 |
product_id | Yes | Integer | Product ID |
account_id | Yes | BigInt | Account ID |
month | No | String(6) | "All" or Month ex. 201012 (December 2010) |
reference_id | No | String (20) | Reference identifier assigned by client. This value is recorded for reporting purposes and will be passed back in the response. |
Get Countries Request |
Field Name | Required | Field Type | Description |
transaction_type | Yes | Integer | Constant value = 443 |
reference_id | No | String (20) | Reference identifier assigned by client. This value is recorded for reporting purposes and will be passed back in the response. |
Get Regions Request |
Field Name | Required | Field Type | Description |
transaction_type | Yes | Integer | Constant value = 444 |
reference_id | No | String (20) | Reference identifier assigned by client. This value is recorded for reporting purposes and will be passed back in the response. |
Get Invoices By Account Request |
Field Name | Required | Field Type | Description |
transaction_type | Yes | Integer | Constant value = 445 |
product_id | Yes | Integer | Product ID |
account_id | Yes | BigInt | Account ID |
reference_id | No | String (20) | Reference identifier assigned by client. This value is recorded for reporting purposes and will be passed back in the response. |
Enable Plans With Payment Request |
Field Name | Required | Field Type | Description |
transaction_type | Yes | Integer | Constant value = 446 |
product_id | Yes | Integer | Product ID |
account_id | Yes | BigInt | Account ID |
plan_ids | Yes | String(512) | Comma Delimited List of Plans to Enable |
bill | Yes | Integer | Should always set Bill = 1; This will bill for the plan |
renew_bill_date | No | Integer | Default = 0 Set new Bill-Cycle; Starting Today |
fee_id_list | No | String(512) | Default = 0 Comma Delimited List of Fees to charge. |
starting_bill_date | No | DateTime | Date to start the billing period for the plan. If no date is sent, then the starting bill date will be date the plan is enabled. |
plans_pro_rated | No | String(512) | Default = 0 Comma Delimited List of Plans to charge. |
payment_amount | No | Numeric(9,4) | Default = 0 Amount to credit account |
reference_id | No | String (20) | Reference identifier assigned by client. This value is recorded for reporting purposes and will be passed back in the response. |
Field Name | Field Type | Description |
response_code | Integer | Indicates the result of the transaction as an integer (Response Codes). |
response_msg | String (80) | Indicates the result of the transaction as a text, which corresponds with the Response Code. |
response_desc | String (255) | Brief description of the result, which corresponds with the Response Code. |
transaction_type | Integer | Constant value = 446 |
transaction_id | Integer | Unique number assigned by Auris to identify the transaction in the system and can be used to submit a modification of this transaction at a later time, such as voiding, crediting or capturing the transaction. |
reference_id | String (20) | Echoed. |
Success | Integer | Value indicating the result of the function.
|
Get Estimated Cost of Next Bill Request |
Field Name | Required | Field Type | Description |
transaction_type | Yes | Integer | Constant value = 447 |
product_id | Yes | Integer | Product ID |
account_id | Yes | BigInt | Account ID |
reference_id | No | String (20) | Reference identifier assigned by client. This value is recorded for reporting purposes and will be passed back in the response. |
Delete Account Minute Plan Request |
Field Name | Required | Field Type | Description |
transaction_type | Yes | Integer | Constant value = 448 |
product_id | Yes | Integer | Product ID |
account_id | Yes | BigInt | Account ID |
plan_id | Yes | Integer | ID of Plan to delete |
reference_id | No | String (20) | Reference identifier assigned by client. This value is recorded for reporting purposes and will be passed back in the response. |
Field Name | Field Type | Description |
response_code | Integer | Indicates the result of the transaction as an integer (Response Codes). |
response_msg | String (80) | Indicates the result of the transaction as a text, which corresponds with the Response Code. |
response_desc | String (255) | Brief description of the result, which corresponds with the Response Code. |
transaction_type | Integer | Constant value = 448 |
transaction_id | Integer | Unique number assigned by Auris to identify the transaction in the system and can be used to submit a modification of this transaction at a later time, such as voiding, crediting or capturing the transaction. |
reference_id | String (20) | Echoed. |
Success | Integer | Value indicating the result of the function. 0 = FALSE/FAIL, 1 = TRUE/PASS. |
Get DID Region Associations by PlanID Request |
Field Name | Required | Field Type | Description |
transaction_type | Yes | Integer | Constant value = 449 |
product_id | Yes | Integer | Product ID |
plan_id | Yes | Integer | Plan ID |
reference_id | No | String (20) | Reference identifier assigned by client. This value is recorded for reporting purposes and will be passed back in the response. |
Insert DID Region Association Request |
Field Name | Required | Field Type | Description |
transaction_type | Yes | Integer | Constant value = 450 |
product_id | Yes | Integer | Product ID |
plan_id | Yes | Integer | Plan ID |
region_id | Yes | String(512) | List of RegionID numbers (delimited by comma) [See Webservice 444] |
did_limit | No | Integer | Default value=0 Number of DID numbers to limit per Region ID. The default is no limits. |
use_only_my_company_inventory | No | Integer | Default value=0 Setting that determines which pool to use to search for DIDs. The default is not company specific. |
reference_id | No | String (20) | Reference identifier assigned by client. This value is recorded for reporting purposes and will be passed back in the response. |
Field Name | Field Type | Description |
response_code | Integer | Indicates the result of the transaction as an integer (Response Codes). |
response_msg | String (80) | Indicates the result of the transaction as a text, which corresponds with the Response Code. |
response_desc | String (255) | Brief description of the result, which corresponds with the Response Code. |
transaction_type | Integer | Constant value = 450 |
transaction_id | Integer | Unique number assigned by Auris to identify the transaction in the system and can be used to submit a modification of this transaction at a later time, such as voiding, crediting or capturing the transaction. |
reference_id | String (20) | Echoed. |
Success | Integer | Value indicating the result of the function. 0 = FALSE/FAIL, 1 = TRUE/PASS. |
Delete DID Region Association Request |
Field Name | Required | Field Type | Description |
transaction_type | Yes | Integer | Constant value = 451 |
product_id | Yes | Integer | Product ID |
plan_id | Yes | Integer | Plan ID |
region_id | Yes | String(512) | List of RegionID numbers (delimited by comma) [See Webservice 444] |
reference_id | No | String (20) | Reference identifier assigned by client. This value is recorded for reporting purposes and will be passed back in the response. |
Field Name | Field Type | Description |
response_code | Integer | Indicates the result of the transaction as an integer (Response Codes). |
response_msg | String (80) | Indicates the result of the transaction as a text, which corresponds with the Response Code. |
response_desc | String (255) | Brief description of the result, which corresponds with the Response Code. |
transaction_type | Integer | Constant value = 451 |
transaction_id | Integer | Unique number assigned by Auris to identify the transaction in the system and can be used to submit a modification of this transaction at a later time, such as voiding, crediting or capturing the transaction. |
reference_id | String (20) | Echoed. |
Success | Integer | Value indicating the result of the function. 0 = FALSE/FAIL, 1 = TRUE/PASS. |
Get Plans by DID Associatons by RegionID Request |
Field Name | Required | Field Type | Description |
transaction_type | Yes | Integer | Constant value = 452 |
product_id | Yes | Integer | Product ID |
region_id | Yes | Integer | RegionID [See Webservice 444] |
reference_id | No | String (20) | Reference identifier assigned by client. This value is recorded for reporting purposes and will be passed back in the response. |
Search DID Request |
Field Name | Required | Field Type | Description |
transaction_type | Yes | Integer | Constant value = 453 |
product_id | Yes | Integer | Product ID |
account_id | Yes | BigInt | Account ID |
plan_id | Yes | Integer | Plan ID |
country_code | Yes | String(10) | 1 = USA; 52 = Mexico |
area_code | No | String(28) | Additional filter to country code search results; If SearchString doesn’t match, trasaction will fail. Ex. CountryCode + AreaCode: 5255 = Mexico City |
reference_id | No | String (20) | Reference identifier assigned by client. This value is recorded for reporting purposes and will be passed back in the response. |
Field Name | Field Type | Description |
response_code | Integer | Indicates the result of the transaction as an integer (Response Codes). |
response_msg | String (80) | Indicates the result of the transaction as a text, which corresponds with the Response Code. |
response_desc | String (255) | Brief description of the result, which corresponds with the Response Code. |
transaction_type | Integer | Constant value = 453 |
transaction_id | Integer | Unique number assigned by Auris to identify the transaction in the system and can be used to submit a modification of this transaction at a later time, such as voiding, crediting or capturing the transaction. |
reference_id | String (20) | Echoed. |
Success | Integer | Value indicating the result of the function. 0 = FALSE/FAIL, 1 = TRUE/PASS, -1 = FAILED DID PRE-VERIFY. |
Delete DID Request |
Field Name | Required | Field Type | Description |
transaction_type | Yes | Integer | Constant value = 454 |
product_id | Yes | Integer | Product ID |
account_id | Yes | BigInt | Account ID |
did_number | Yes | String(28) | DID number to be deleted |
reference_id | No | String (20) | Reference identifier assigned by client. This value is recorded for reporting purposes and will be passed back in the response. |
Field Name | Field Type | Description |
response_code | Integer | Indicates the result of the transaction as an integer (Response Codes). |
response_msg | String (80) | Indicates the result of the transaction as a text, which corresponds with the Response Code. |
response_desc | String (255) | Brief description of the result, which corresponds with the Response Code. |
transaction_type | Integer | Constant value = 454 |
transaction_id | Integer | Unique number assigned by Auris to identify the transaction in the system and can be used to submit a modification of this transaction at a later time, such as voiding, crediting or capturing the transaction. |
reference_id | String (20) | Echoed. |
Success | Integer | Value indicating the result of the function. 0 = FALSE/FAIL, 1 = TRUE/PASS. |
Migrate DID to a Different Plan Request |
Field Name | Required | Field Type | Description |
transaction_type | Yes | Integer | Constant value = 455 |
product_id | Yes | Integer | Product ID |
account_id | Yes | BigInt | Account ID |
did_number | Yes | String(28) | DID to migrate |
destination_product_id | No | Integer | Default=0 Will default to its current product |
destination_account_id | No | BigInt | Default=0 Will default to its current account |
plan_id | Yes | Integer | Plan ID |
reference_id | No | String (20) | Reference identifier assigned by client. This value is recorded for reporting purposes and will be passed back in the response. |
Field Name | Field Type | Description |
response_code | Integer | Indicates the result of the transaction as an integer (Response Codes). |
response_msg | String (80) | Indicates the result of the transaction as a text, which corresponds with the Response Code. |
response_desc | String (255) | Brief description of the result, which corresponds with the Response Code. |
transaction_type | Integer | Constant value = 455 |
transaction_id | Integer | Unique number assigned by Auris to identify the transaction in the system and can be used to submit a modification of this transaction at a later time, such as voiding, crediting or capturing the transaction. |
reference_id | String (20) | Echoed. |
Success | Integer | Value indicating the result of the function. 0 = FALSE/FAIL, 1 = TRUE/PASS, -1 = FAILED DID PRE-VERIFY. |
Assign DID Request |
Field Name | Required | Field Type | Description |
transaction_type | Yes | Integer | Constant value = 456 |
product_id | Yes | Integer | Product ID |
account_id | Yes | BigInt | Account ID |
plan_id | Yes | Integer | Plan ID |
country_code | Yes | String(10) | Country Code. Ex. USA = 1, Mexico = 52 |
area_code | No | String(28) | Additional filter to country code search results; If SearchString doesn’t match, trasaction will fail. Ex. CountryCode + AreaCode: 5255 = Mexico City |
salutation | No | String(20) | Required if any of the following countries:
|
first_name | No | String(50) | |
last_name | No | String(50) | |
company_name | No | String(50) | |
address1 | No | String(100) | |
building_no | No | String(20) | |
city | No | String(30) | |
zip_code | No | String(10) | |
reference_id | No | String (20) | Reference identifier assigned by client. This value is recorded for reporting purposes and will be passed back in the response. |
Field Name | Field Type | Description |
response_code | Integer | Indicates the result of the transaction as an integer (Response Codes). |
response_msg | String (80) | Indicates the result of the transaction as a text, which corresponds with the Response Code. |
response_desc | String (255) | Brief description of the result, which corresponds with the Response Code. |
transaction_type | Integer | Constant value = 456 |
transaction_id | Integer | Unique number assigned by Auris to identify the transaction in the system and can be used to submit a modification of this transaction at a later time, such as voiding, crediting or capturing the transaction. |
reference_id | String (20) | Echoed. |
DIDNumber | String(28) | DID number assigned to plan. |
Success | Integer | Value indicating the result of the function. 0 = FALSE/FAIL, 1 = TRUE/PASS, -1 = FAILED DID PRE-VERIFY. |
Get Account Details by AccountID Request |
Field Name | Required | Field Type | Description |
transaction_type | Yes | Integer | Constant value = 457 |
product_id | Yes | Integer | Product ID |
account_id | Yes | BigInt | Account ID |
reference_id | No | String (20) | Reference identifier assigned by client. This value is recorded for reporting purposes and will be passed back in the response. |
Get Account DID(s) by AccountID Request |
Field Name | Required | Field Type | Description |
transaction_type | Yes | Integer | Constant value = 458 |
product_id | Yes | Integer | Product ID |
account_id | Yes | BigInt | Account ID |
reference_id | No | String (20) | Reference identifier assigned by client. This value is recorded for reporting purposes and will be passed back in the response. |
DID FollowMe Insert Request |
Field Name | Required | Field Type | Description |
transaction_type | Yes | Integer | Constant value = 459 |
product_id | Yes | Integer | Product ID |
account_id | Yes | BigInt | Account ID |
did_number | Yes | String(28) | DID Number |
ani | Yes | String(28) | ANI number to attach to DID number |
reference_id | No | String (20) | Reference identifier assigned by client. This value is recorded for reporting purposes and will be passed back in the response. |
Field Name | Field Type | Description |
response_code | Integer | Indicates the result of the transaction as an integer (Response Codes). |
response_msg | String (80) | Indicates the result of the transaction as a text, which corresponds with the Response Code. |
response_desc | String (255) | Brief description of the result, which corresponds with the Response Code. |
transaction_type | Integer | Constant value = 459 |
transaction_id | Integer | Unique number assigned by Auris to identify the transaction in the system and can be used to submit a modification of this transaction at a later time, such as voiding, crediting or capturing the transaction. |
reference_id | String (20) | Echoed. |
Success | Integer | Value indicating the result of the function. 0 = FALSE/FAIL, 1 = TRUE/PASS. |
DID FollowMe Remove Request |
Field Name | Required | Field Type | Description |
transaction_type | Yes | Integer | Constant value = 460 |
product_id | Yes | Integer | Product ID |
account_id | Yes | BigInt | Account ID |
did_number | Yes | String(28) | DID Number |
ani | Yes | String(28) | ANI number to detach from DID number |
reference_id | No | String (20) | Reference identifier assigned by client. This value is recorded for reporting purposes and will be passed back in the response. |
Field Name | Field Type | Description |
response_code | Integer | Indicates the result of the transaction as an integer (Response Codes). |
response_msg | String (80) | Indicates the result of the transaction as a text, which corresponds with the Response Code. |
response_desc | String (255) | Brief description of the result, which corresponds with the Response Code. |
transaction_type | Integer | Constant value = 460 |
transaction_id | Integer | Unique number assigned by Auris to identify the transaction in the system and can be used to submit a modification of this transaction at a later time, such as voiding, crediting or capturing the transaction. |
reference_id | String (20) | Echoed. |
Success | Integer | Value indicating the result of the function. 0 = FALSE/FAIL, 1 = TRUE/PASS. |
ANI Availability Check Request |
Field Name | Required | Field Type | Description |
transaction_type | Yes | Integer | Constant value = 461 |
product_id | Yes | Integer | Product ID |
ani | Yes | String(28) | ANI number to check if is already registered on the product. |
reference_id | No | String (20) | Reference identifier assigned by client. This value is recorded for reporting purposes and will be passed back in the response. |
Field Name | Field Type | Description |
response_code | Integer | Indicates the result of the transaction as an integer (Response Codes). |
response_msg | String (80) | Indicates the result of the transaction as a text, which corresponds with the Response Code. |
response_desc | String (255) | Brief description of the result, which corresponds with the Response Code. |
transaction_type | Integer | Constant value = 461 |
transaction_id | Integer | Unique number assigned by Auris to identify the transaction in the system and can be used to submit a modification of this transaction at a later time, such as voiding, crediting or capturing the transaction. |
reference_id | String (20) | Echoed. |
Success | Integer | Value indicating the result of the function. 0 = FALSE/FAIL, 1 = TRUE/PASS. |
Apply Coupon Now Request |
Field Name | Required | Field Type | Description |
transaction_type | Yes | Integer | Constant value = 462 |
product_id | Yes | Integer | Product ID |
account_id | Yes | BigInt | Account ID to which apply the coupon. |
coupon_id | Yes | Integer | |
plan_id | Yes | Integer | Plan ID to which apply the coupon. |
amount_override | No | Numeric(9,4) | Money amount for the coupon to apply. |
seconds_override | No | Integer | Duration in seconds for the coupon to apply. |
reference_id | No | String (20) | Reference identifier assigned by client. This value is recorded for reporting purposes and will be passed back in the response. |
Field Name | Field Type | Description |
response_code | Integer | Indicates the result of the transaction as an integer (Response Codes). |
response_msg | String (80) | Indicates the result of the transaction as a text, which corresponds with the Response Code. |
response_desc | String (255) | Brief description of the result, which corresponds with the Response Code. |
transaction_type | Integer | Constant value = 462 |
transaction_id | Integer | Unique number assigned by Auris to identify the transaction in the system and can be used to submit a modification of this transaction at a later time, such as voiding, crediting or capturing the transaction. |
reference_id | String (20) | Echoed. |
Success | Integer | Value indicating the result of the function. 0 = FALSE/FAIL, 1 = TRUE/PASS. |
Update Account Minute Plan Request |
Field Name | Required | Field Type | Description |
transaction_type | Yes | Integer | Constant value = 463 |
product_id | Yes | Integer | Product ID |
account_id | Yes | BigInt | Account ID of plan to be updated. |
plan_id | Yes | Integer | Plan ID of plan to be updated. |
maximum_limits_action | No | Integer | Action to take when maximum limits are reached; [-999 = reset to plan setting, -998 keep current setting, -1 = Nothing; 0 = PlayPrompt; 1 = Customer Service Redirect]. |
daily_peak_max_seconds | No | Integer | Default value = -1 ( -1 = reset to plan setting, 0 = keep current setting). Maximum Peak Seconds allowed daily on this Plan. |
daily_off_peak_max_seconds | No | Integer | Default value = -1 ( -1 = reset to plan setting, 0 = keep current setting). Maximum Off-Peak Seconds allowed daily on this Plan. |
weekly_peak_max_seconds | No | Integer | Default value = -1 ( -1 = reset to plan setting, 0 = keep current setting). Maximum Peak Seconds allowed weekly on this Plan. |
weekly_off_peak_max_seconds | No | Integer | Default value = -1 ( -1 = reset to plan setting, 0 = keep current setting). Maximum Off-Peak Seconds allowed weekly on this Plan. |
monthly_peak_max_seconds | No | Integer | Default value = -1 ( -1 = reset to plan setting, 0 = keep current setting). Maximum Peak Seconds allowed monthly on this Plan. |
monthly_off_peak_max_seconds | No | Integer | Default value = -1 ( -1 = reset to plan setting, 0 = keep current setting). Maximum Off-Peak Seconds allowed monthly on this Plan. |
daily_max_unique_destinations | No | Integer | Default value = -1 ( -1 = reset to plan setting, 0 = keep current setting). Maximum Number of Unique Destinations allowed to be dialed daily [00:00:00-23:59:59] Resets @ 00:00:00 daily. |
weekly_max_unique_destinations | No | Integer | Default value = -1 ( -1 = reset to plan setting, 0 = keep current setting). Maximum Number of Unique Destinations allowed to be dialed weekly [00:00:00-23:59:59] Resets @ 1st Day of Week 00:00:00 weekly. |
monthly_max_unique_destinations | No | Integer | Default value = -1 ( -1 = reset to plan setting, 0 = keep current setting). Maximum Number of Unique Destinations allowed to be dialed monthly [00:00:00-23:59:59] Resets @ 1st Day of Month 00:00:00 monthly. |
ignore_daily_destination_check | No | Integer | Default value = 0 Value of 1 disable daily destination check for given account and plan. |
ignore_weekly_destination_check | No | Integer | Default value = 0 Value of 1 disable weekly destination check for given account and plan. |
ignore_monthly_destination_check | No | Integer | Default value = 0 Value of 1 disable monthly destination check for given account and plan. |
ignore_daily_max_seconds | No | Integer | Default value = 0 Value of 1 disable daily max seconds duration check for given account and plan. |
ignore_weekly_max_seconds | No | Integer | Default value = 0 Value of 1 disable weekly max seconds duration check for given account and plan. |
ignore_monthly_max_seconds | No | Integer | Default value = 0 Value of 1 disable monthly max seconds duration check for given account and plan. |
reference_id | No | String (20) | Reference identifier assigned by client. This value is recorded for reporting purposes and will be passed back in the response. |
Field Name | Field Type | Description |
response_code | Integer | Indicates the result of the transaction as an integer (Response Codes). |
response_msg | String (80) | Indicates the result of the transaction as a text, which corresponds with the Response Code. |
response_desc | String (255) | Brief description of the result, which corresponds with the Response Code. |
transaction_type | Integer | Constant value = 463 |
transaction_id | Integer | Unique number assigned by Auris to identify the transaction in the system and can be used to submit a modification of this transaction at a later time, such as voiding, crediting or capturing the transaction. |
reference_id | String (20) | Echoed. |
Success | Integer | Value indicating the result of the function. 0 = FALSE/FAIL, 1 = TRUE/PASS. |
Refresh Account Plan Attributes from Product Plan Request |
Field Name | Required | Field Type | Description |
transaction_type | Yes | Integer | Constant value = 464 |
product_id | Yes | Integer | Product ID |
account_id | Yes | BigInt | Account ID to be refreshed. |
plan_id | Yes | Integer | Plan ID to be refreshed. [To refresh ALL plans, plan_id = 0] |
reference_id | No | String (20) | Reference identifier assigned by client. This value is recorded for reporting purposes and will be passed back in the response. |
Field Name | Field Type | Description |
response_code | Integer | Indicates the result of the transaction as an integer (Response Codes). |
response_msg | String (80) | Indicates the result of the transaction as a text, which corresponds with the Response Code. |
response_desc | String (255) | Brief description of the result, which corresponds with the Response Code. |
transaction_type | Integer | Constant value = 464 |
transaction_id | Integer | Unique number assigned by Auris to identify the transaction in the system and can be used to submit a modification of this transaction at a later time, such as voiding, crediting or capturing the transaction. |
reference_id | String (20) | Echoed. |
Success | Integer | Value indicating the result of the function. 0 = FALSE/FAIL, 1 = TRUE/PASS. |
Get Invoice Details Request |
Field Name | Required | Field Type | Description |
transaction_type | Yes | Integer | Constant value = 465 |
product_id | Yes | Integer | Product ID. |
account_id | Yes | BigInt | Account ID. |
invoice_id | Yes | Integer | Invoice ID for which to get the details. |
reference_id | No | String (20) | Reference identifier assigned by client. This value is recorded for reporting purposes and will be passed back in the response. |
Set Peak Times Request |
Field Name | Required | Field Type | Description |
transaction_type | Yes | Integer | Constant value = 466 |
product_id | Yes | Integer | Product ID |
peaks | No | String(1024) | List of start and end times for each peak time period in the format StartMinute|EndMinute. If more than one time period then send comma delimited. The StartMinute and EndMinute times are in minutes format, counted as a cumulative amount
covering a whole week period, thus the week has a total of 10080 minutes starting from 0 for Sunday 12:00:00 AM to 10079 for Saturday 11:59:00 PM.
|
reference_id | No | String (20) | Reference identifier assigned by client. This value is recorded for reporting purposes and will be passed back in the response. |
Field Name | Field Type | Description |
response_code | Integer | Indicates the result of the transaction as an integer (Response Codes). |
response_msg | String (80) | Indicates the result of the transaction as a text, which corresponds with the Response Code. |
response_desc | String (255) | Brief description of the result, which corresponds with the Response Code. |
transaction_type | Integer | Constant value = 466 |
transaction_id | Integer | Unique number assigned by Auris to identify the transaction in the system and can be used to submit a modification of this transaction at a later time, such as voiding, crediting or capturing the transaction. |
reference_id | String (20) | Echoed. |
Success | Integer | Value indicating the result of the function. 0 = FALSE/FAIL, 1 = TRUE/PASS. |
Get Peak Times Request |
Field Name | Required | Field Type | Description |
transaction_type | Yes | Integer | Constant value = 467 |
product_id | Yes | Integer | Product ID. |
reference_id | No | String (20) | Reference identifier assigned by client. This value is recorded for reporting purposes and will be passed back in the response. |
Delete Product Minute Plan Regions Request |
Field Name | Required | Field Type | Description |
transaction_type | Yes | Integer | Constant value = 468 |
product_id | Yes | Integer | Product ID |
plan_id | Yes | Integer | Plan ID |
region_id | Yes | String(1024) | List of region id(s) to be deleted from the product minute plan delimmited by comma. |
bill_sec_first | Yes | Integer | You may bill a first increment different than the additional increments, specify the number of seconds here |
bill_sec_inc | Yes | Integer | Each additional increment after the First Increment will be billed with this many seconds |
reference_id | No | String (20) | Reference identifier assigned by client. This value is recorded for reporting purposes and will be passed back in the response. |
Field Name | Field Type | Description |
response_code | Integer | Indicates the result of the transaction as an integer (Response Codes). |
response_msg | String (80) | Indicates the result of the transaction as a text, which corresponds with the Response Code. |
response_desc | String (255) | Brief description of the result, which corresponds with the Response Code. |
transaction_type | Integer | Constant value = 468 |
transaction_id | Integer | Unique number assigned by Auris to identify the transaction in the system and can be used to submit a modification of this transaction at a later time, such as voiding, crediting or capturing the transaction. |
reference_id | String (20) | Echoed. |
Success | Integer | Value indicating the result of the function. 0 = FALSE/FAIL, 1 OR GREATER = TRUE/PASS. |
Update DID Region Association |
Field Name | Required | Field Type | Description |
transaction_type | Yes | Integer | Constant value = 471 |
product_id | Yes | Integer | Product ID |
plan_id | Yes | Integer | Plan ID |
region_id | Yes | String(1024) | Comma delimited list of Region ID (See Web service 444) |
did_limit | No | Integer | Default value=0 Number of DID numbers to limit per Region ID. The default is no limits. |
use_only_my_company_inventory | No | Integer | Default value=0 Setting that determines which pool to use to search for DIDs. The default is not company specific. |
reference_id | No | String (20) | Reference identifier assigned by client. This value is recorded for reporting purposes and will be passed back in the response. |
Field Name | Field Type | Description |
response_code | Integer | Indicates the result of the transaction as an integer (Response Codes). |
response_msg | String (80) | Indicates the result of the transaction as a text, which corresponds with the Response Code. |
response_desc | String (255) | Brief description of the result, which corresponds with the Response Code. |
transaction_type | Integer | Constant value = 471 |
transaction_id | Integer | Unique number assigned by Auris to identify the transaction in the system and can be used to submit a modification of this transaction at a later time, such as voiding, crediting or capturing the transaction. |
reference_id | String (20) | Echoed. |
Success | Integer | Value indicating the result of the function. 0 = FALSE/FAIL, 1 OR GREATER = TRUE/PASS. |
Shift Next Bill Date (Days) |
Field Name | Required | Field Type | Description |
transaction_type | Yes | Integer | Constant value = 474 |
product_id | Yes | Integer | Product ID |
account_id | Yes | Long | Account ID |
bill_cycle_days | Yes | Integer | Number of days to move forward or backward. The final result must be in the future. |
reference_id | No | String (20) | Reference identifier assigned by client. This value is recorded for reporting purposes and will be passed back in the response. |
Field Name | Field Type | Description |
response_code | Integer | Indicates the result of the transaction as an integer (Response Codes). |
response_msg | String (80) | Indicates the result of the transaction as a text, which corresponds with the Response Code. |
response_desc | String (255) | Brief description of the result, which corresponds with the Response Code. |
transaction_type | Integer | Constant value = 474 |
PreviousNextBillDate | Integer | Next Bill Date before transaction. |
NewNextBillDate | Integer | Next Bill Date after adding the number of bill_cycle_days to shift. |
transaction_id | Integer | Unique number assigned by Auris to identify the transaction in the system and can be used to submit a modification of this transaction at a later time, such as voiding, crediting or capturing the transaction. |
reference_id | String (20) | Echoed. |
Success | Integer | Value indicating the result of the function. 0 = FALSE/FAIL, 1 OR GREATER = TRUE/PASS. |
Re-Calculate Account Minimum Balance |
Field Name | Required | Field Type | Description |
transaction_type | Yes | Integer | Constant value = 475 |
product_id | Yes | Integer | Product ID |
account_id | Yes | Long | Account ID |
reference_id | No | String (20) | Reference identifier assigned by client. This value is recorded for reporting purposes and will be passed back in the response. |
Field Name | Field Type | Description |
response_code | Integer | Indicates the result of the transaction as an integer (Response Codes). |
response_msg | String (80) | Indicates the result of the transaction as a text, which corresponds with the Response Code. |
response_desc | String (255) | Brief description of the result, which corresponds with the Response Code. |
transaction_type | Integer | Constant value = 475 |
Successful | Integer | Result of transaction |
NewBalance | Integer | New minimum balance applied to the account. |
transaction_id | Integer | Unique number assigned by Auris to identify the transaction in the system and can be used to submit a modification of this transaction at a later time, such as voiding, crediting or capturing the transaction. |
reference_id | String (20) | Echoed. |
Success | Integer | Value indicating the result of the function. 0 = FALSE/FAIL, 1 OR GREATER = TRUE/PASS. |
VOIP Account Information Request |
Field Name | Required | Field Type | Description |
transaction_type | Yes | Integer | Constant value = 510 |
account_number | No* | String (10) | Account Number (PIN) |
serial_number | No* | String (10) | Serial number of the account (CardID) (serial number, account number, account id, or voip ani number is mandatory) |
account_id | No* | Big Integer | Account ID |
voip_ani_number | No* | String (20) | Virtual ANI Number of the VOIP Box. System only returns the first match under the specified account if this is not supplied. |
product_id | Yes | Integer | Product ID. |
reference_id | No | String (20) | Reference identifier assigned by client. This value is recorded for reporting purposes and will be passed back in the response. |
Field Name | Field Type | Description |
response_code | Integer | Indicates the result of the transaction as an integer (Response Codes). |
response_msg | String (80) | Indicates the result of the transaction as a text, which corresponds with the Response Code. |
response_desc | String (255) | Brief description of the result, which corresponds with the Response Code. |
transaction_type | Integer | Constant value = 510 |
transaction_id | Integer | Unique number assigned by Auris to identify the transaction in the system and can be used to submit a modification of this transaction at a later time, such as voiding, crediting or capturing the transaction. |
voip_ani_number | String (20) | Echoed (or provided). |
voip_pin | String (20) | Provided. |
voip_endpoint_number | String (20) | Provided. |
mac_address | String (20) | Provided (if available). |
voip_line_status | String (20) | Provided. |
account_id | Big Integer | Provided. |
account_number | String (10) | Echoed (or provided). |
serial_number | String (10) | Echoed (or provided). |
reference_id | String (20) | Echoed. |
VOIP Account Registration Request |
Field Name | Required | Field Type | Description |
transaction_type | Yes | Integer | Constant value = 511 |
account_number | No* | String (10) | Account Number (PIN) |
serial_number | No* | String (10) | Serial number of the account (CardID) (serial number, account number, or account id is mandatory) |
account_id | No | Big Integer | Account ID |
callflow_id | No* | Integer | Constant value; 1702 = 1 Stage Dial - 1-Plus Service 1632 = 1 Stage Dial -Balance Check -CallerID -RCDB 1208 = 1 Stage Dial -Balance ONLY -CallerID 1139 = 1 Stage Dial -BalanceCheck -CallerID 1236 = 1 Stage Dial -BalChk -CallerID -DID Push 1568 = 1 Stage Dial -BalChk -CallerID -DID Push -RCDB 2146 = 1 Stage Dial CLEC -CallerID -DID Push -RCDB 2147 = 1 Stage Dial CLEC -CallerID -RCDB -Setel |
product_id | Yes | Integer | Product ID. |
reference_id | No | String (20) | Reference identifier assigned by client. This value is recorded for reporting purposes and will be passed back in the response. |
Field Name | Field Type | Description |
response_code | Integer | Indicates the result of the transaction as an integer (Response Codes). |
response_msg | String (80) | Indicates the result of the transaction as a text, which corresponds with the Response Code. |
response_desc | String (255) | Brief description of the result, which corresponds with the Response Code. |
transaction_type | Integer | Constant value = 511 |
transaction_id | Integer | Unique number assigned by Auris to identify the transaction in the system and can be used to submit a modification of this transaction at a later time, such as voiding, crediting or capturing the transaction. |
voip_ani_number | String (20) | Provided (Virtual ANI Number of the VOIP Box). |
voip_pin | String (20) | Provided. |
voip_endpoint_number | String (20) | Provided. |
voice_mail_pw | String (4) | Provided (VoiceMail Box Password). |
callflow_id | Integer | Echoed. |
account_id | Big Integer | Provided. |
account_number | String (10) | Echoed (or provided). |
serial_number | String (10) | Echoed (or provided). |
reference_id | String (20) | Echoed. |
VOIP Account Registration With New PIN Creation/Activation Request |
Field Name | Required | Field Type | Description |
transaction_type | Yes | Integer | Constant value = 512 |
product_id | Yes | Integer | Product identifier. Please use (transaction_type = 128) to get the list of product_id values. |
transaction_amount | Yes | Integer | Initial balance of the new account in cents. (Exp: 450 = $4.50) |
callflow_id | No* | Integer | Constant value; 1702 = 1 Stage Dial - 1-Plus Service 1632 = 1 Stage Dial -Balance Check -CallerID -RCDB 1208 = 1 Stage Dial -Balance ONLY -CallerID 1139 = 1 Stage Dial -BalanceCheck -CallerID 1236 = 1 Stage Dial -BalChk -CallerID -DID Push 1568 = 1 Stage Dial -BalChk -CallerID -DID Push -RCDB 2146 = 1 Stage Dial CLEC -CallerID -DID Push -RCDB 2147 = 1 Stage Dial CLEC -CallerID -RCDB -Setel |
reference_id | No | String (20) | Reference identifier assigned by client. This value is recorded for reporting purposes and will be passed back in the response. |
Field Name | Field Type | Description |
response_code | Integer | Indicates the result of the transaction as an integer (Response Codes). |
response_msg | String (80) | Indicates the result of the transaction as a text, which corresponds with the Response Code. |
response_desc | String (255) | Brief description of the result, which corresponds with the Response Code. |
transaction_type | Integer | Constant value = 512 |
transaction_id | Integer | Unique number assigned by Auris to identify the transaction in the system and can be used to submit a modification of this transaction at a later time, such as voiding, crediting or capturing the transaction. |
product_id | Integer | Echoed. |
transaction_amount | Integer | Echoed (or provided). |
voip_ani_number | String (20) | Provided (Virtual ANI Number of the VOIP Box). |
voip_pin | String (20) | Provided. |
voip_endpoint_number | String (20) | Provided. |
voice_mail_pw | String (4) | Provided (VoiceMail Box Password). |
callflow_id | Integer | Echoed. |
account_id | Big Integer | Provided. |
account_number | String (10) | Echoed (or provided). |
serial_number | String (10) | Echoed (or provided). |
reference_id | String (20) | Echoed. |
VOIP MAC Address Registration Request |
Field Name | Required | Field Type | Description |
transaction_type | Yes | Integer | Constant value = 513 |
account_number | No* | String (10) | Account Number (PIN) |
serial_number | No* | String (10) | Serial number of the account (CardID) (serial number or account number is mandatory) |
voip_ani_number | Yes | String (20) | Virtual ANI Number of the VOIP Box. |
mac_address | Yes | String (20) | VOIP Box MAC Address. (Exp: 000358C00B0F) |
reference_id | No | String (20) | Reference identifier assigned by client. This value is recorded for reporting purposes and will be passed back in the response. |
Field Name | Field Type | Description |
response_code | Integer | Indicates the result of the transaction as an integer (Response Codes). |
response_msg | String (80) | Indicates the result of the transaction as a text, which corresponds with the Response Code. |
response_desc | String (255) | Brief description of the result, which corresponds with the Response Code. |
transaction_type | Integer | Constant value = 513 |
transaction_id | Integer | Unique number assigned by Auris to identify the transaction in the system and can be used to submit a modification of this transaction at a later time, such as voiding, crediting or capturing the transaction. |
voip_ani_number | String (20) | Echoed. |
mac_address | String (20) | Echoed. |
account_number | String (10) | Echoed (or provided). |
serial_number | String (10) | Echoed (or provided). |
reference_id | String (20) | Echoed. |
VOIP VoiceMail Request |
Field Name | Required | Field Type | Description |
transaction_type | Yes | Integer | Constant value = 514 |
product_id | Yes | Integer | Product ID. |
sub_command | No* | String (20) | If nothing provided here the system returns the voice mail information of the specified account. Here are valid enumerations for this parameter: "UPDATE" : Updates the voice mail box information. |
account_number | No* | String (10) | Account Number (PIN) |
serial_number | No* | String (10) | Serial number of the account (CardID) (serial number or account number is mandatory) |
voip_ani_number | Yes | String (20) | Virtual ANI Number of the VOIP Box. |
voice_mail_name | No* | String (30) | VoiceMail Box Name.(Only necessary when sub_command is "UPDATE") |
voice_mail_email | No* | String (60) | VoiceMail Email Address to receive the voice mail messages.(Only necessary when sub_command is "UPDATE") |
voice_mail_pw | No* | String (4) | VoiceMail Box Password.(Only necessary when sub_command is "UPDATE") |
reference_id | No | String (20) | Reference identifier assigned by client. This value is recorded for reporting purposes and will be passed back in the response. |
Field Name | Field Type | Description |
response_code | Integer | Indicates the result of the transaction as an integer (Response Codes). |
response_msg | String (80) | Indicates the result of the transaction as a text, which corresponds with the Response Code. |
response_desc | String (255) | Brief description of the result, which corresponds with the Response Code. |
transaction_type | Integer | Constant value = 514 |
transaction_id | Integer | Unique number assigned by Auris to identify the transaction in the system and can be used to submit a modification of this transaction at a later time, such as voiding, crediting or capturing the transaction. |
sub_command | String (20) | Echoed. |
voip_ani_number | String (20) | Echoed. |
voice_mail_name | String (30) | Echoed (or provided). |
voice_mail_email | String (60) | Echoed (or provided). |
voice_mail_pw | String (4) | Echoed (or provided). |
account_number | String (10) | Echoed (or provided). |
serial_number | String (10) | Echoed (or provided). |
reference_id | String (20) | Echoed. |
VOIP Account Delete Request |
Field Name | Required | Field Type | Description |
transaction_type | Yes | Integer | Constant value = 515 |
product_id | Yes | Integer | Product ID. |
account_number | No* | String (10) | Account Number (PIN) |
serial_number | No* | String (10) | Serial number of the account (CardID) (serial number or account number is mandatory) |
voip_ani_number | No* | String (20) | Virtual ANI Number of the VOIP Box. System only returns the first match under the specified account if this is not supplied. |
reference_id | No | String (20) | Reference identifier assigned by client. This value is recorded for reporting purposes and will be passed back in the response. |
Field Name | Field Type | Description |
response_code | Integer | Indicates the result of the transaction as an integer (Response Codes). |
response_msg | String (80) | Indicates the result of the transaction as a text, which corresponds with the Response Code. |
response_desc | String (255) | Brief description of the result, which corresponds with the Response Code. |
transaction_type | Integer | Constant value = 515 |
transaction_id | Integer | Unique number assigned by Auris to identify the transaction in the system and can be used to submit a modification of this transaction at a later time, such as voiding, crediting or capturing the transaction. |
voip_ani_number | String (20) | Echoed (or provided). |
account_number | String (10) | Echoed (or provided). |
serial_number | String (10) | Echoed (or provided). |
reference_id | String (20) | Echoed. |
VOIP Account Check Request |
Field Name | Required | Field Type | Description |
transaction_type | Yes | Integer | Constant value = 516 |
voip_endpoint_number | Yes | String (20) | voip_endpoint_number (Exp: 44435665553527410) |
reference_id | No | String (20) | Reference identifier assigned by client. This value is recorded for reporting purposes and will be passed back in the response. |
Field Name | Field Type | Description |
response_code | Integer | Indicates the result of the transaction as an integer (Response Codes). |
response_msg | String (80) | Indicates the result of the transaction as a text, which corresponds with the Response Code. |
response_desc | String (255) | Brief description of the result, which corresponds with the Response Code. |
transaction_type | Integer | Constant value = 516 |
transaction_id | Integer | Unique number assigned by Auris to identify the transaction in the system and can be used to submit a modification of this transaction at a later time, such as voiding, crediting or capturing the transaction. |
voip_endpoint_number | String (20) | Echoed. |
reference_id | String (20) | Echoed. |
VOIP Change Password Request |
Field Name | Required | Field Type | Description |
transaction_type | Yes | Integer | Constant value = 517 |
account_number | No* | String (10) | Account Number (PIN) |
serial_number | No* | String (10) | Serial number of the account (CardID) (serial number or account number is mandatory) |
voip_ani_number | Yes | String (20) | Virtual ANI Number of the VOIP Box. |
voip_pw | Yes | String (20) | New password for the VOIP Box. |
product_id | Yes | Integer | Product ID. |
reference_id | No | String (20) | Reference identifier assigned by client. This value is recorded for reporting purposes and will be passed back in the response. |
Field Name | Field Type | Description |
response_code | Integer | Indicates the result of the transaction as an integer (Response Codes). |
response_msg | String (80) | Indicates the result of the transaction as a text, which corresponds with the Response Code. |
response_desc | String (255) | Brief description of the result, which corresponds with the Response Code. |
transaction_type | Integer | Constant value = 517 |
transaction_id | Integer | Unique number assigned by Auris to identify the transaction in the system and can be used to submit a modification of this transaction at a later time, such as voiding, crediting or capturing the transaction. |
voip_ani_number | String (20) | Echoed (or provided). |
voip_pw | String (20) | Echoed (or provided). |
account_number | String (10) | Echoed (or provided). |
serial_number | String (10) | Echoed (or provided). |
reference_id | String (20) | Echoed. |
Response Codes & Messages |
Code | Description |
1 | Success |
2 | Server too busy |
3 | Required parameter is missing |
4 | Invalid user_id or user_pw |
5 | Parameter has an invalid value |
6 | Request came in through non-secure channel(please use HTTPS connection) |
7 | HTTP Request came from non-registered IP |
24 | This duplicate request attempt is disregarded |