Auris Web Services

Auris Web Services - Help Document

Table of Contents :




	- Protocol Description
	- Standard Transaction Submission
	- Transaction Types
	- Response Codes & Messages
	- Account Statuses
	- Examples

Protocol Description

Auris 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. 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 clients 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/onlinetransactions.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
100	Account (PIN) Creation	Creates a single account (PIN) with the amount provided under the identified product. (If PIN is not provided in the request or it already exists in the system; the system generates a random PIN. If status_flag is not sent as "1" then the new account is created as a not-active account.)
101	Account Information	Retrieves information about the specified account such as balance, first usage date, expiration date etc...
102	Account Recharge	This transaction will apply an amount equal to the negative balance plus the desired recharge amount. i.e. If pre-transaction balance is -$0.50 and customer purchases a $1.00 recharge, the system will apply $1.50 o the account and the post transaction balance will be $1.00.
125	Account Recharge with New PIN	Recharges the specified account with the amount of the newly purchased PIN. This feature requires registered ANI, customer has to have a registered ANI under the specified account in order to recharge it successfully.
103	Account Credit	Credit amount is added to actual balance. i.e. If pre-transaction balance is -$0.50 and a $1.00 credit is issued, then the post transaction balance will be $0.50. Application returns 'Invalid Operation' response if the account exceeds the initial balance.
104	Account Activation	Activates the specified account. The account balance can be incremented in this transaction as well, although it is not a requirement.
105	Account Deactivation	Deactivates the specified account. All the other information on the account remains intact including the current balance. The account may be re-activated again with activation.
106	ANI Registration	Registers the entered ANI(Automatic Number Identification) number under the specified account. In other words assigns the entered ANI Number to the entered PIN for automatic PIN verification. If you want to register more than one ANI Number under a specific account please make sure that the product supports Multi-ANI feature. For ANI Provisioning: send the additional parameters callflow_id and the language_id as described below at the Response/Request section. If ANI is already provisioned it just updates the CallflowID and the LanguageID.
118	ANI Registration with New PIN Creation & Activation	Creates and activates the entered PIN(ANI is used as PIN if left blank) with the amount provided under the identified product. If the desired PIN is already being used, system will generate a random value that will be returned as PIN in the response. Registers the entered ANI(Automatic Number Identification) number under the activated account. In other words assigns the entered ANI Number to the activated PIN for automatic PIN verification.
109	ANI Un-Registration	Deletes the registered ANI(Automatic Number Identification) from the specified account.
114	ANI Display	Displays the previously registered ANI numbers under the specified account.
107	Call Back	Places a conference or dial back call request in the system. System calls back the origination number if only origination number is entered. If origination and destination number are entered together, system calls back both starting from the origination number. Calls can be scheduled for later date by setting the call delay option.
139	Call Back Special	"Call Back" transaction type with an additinal parameter called call_type.
110	Call Back / Call Rate	Finds the calling rate between origination and destination numbers.
111	Call Back / Call Status	Returns the status of the previously placed call request.
112	Call Back / Call History	Provides information about previously placed call request records of the specified account between entered date ranges.
108	CDR	Provides the Call Detail Records(CDR) of the specified account between entered date ranges. There is a date limit for CDR requests; the system returns as far back as 3 months from the current date.
115	Quick Dial Registration	Assigns a destination number(DNIS) to the Company's Access Number for the specified account. The customer's phone number(ANI) should has been registered already. When the customer calls the access number, the system recognizes the ANI and automatically dials the assigned destination number(quick dial number) without expecting anything.
116	Quick Dial Delete	Deletes the previously assigned quick dial number from the Access Number under the specified account.
117	Quick Dial Display	Displays the previously assigned quick dial number(s) under the specified account.
119	Speed Dial Add/Edit	Assigns/Overwrites a destination number(DNIS) as a speed dial number(available from 1 to 99) for the specified account. Once it's assigned customers can dial the speed dial number with # (exp: 2#) instead of the whole destination number that they want to call.
120	Speed Dial Display	Displays the previously assigned speed dial number(s) under the specified account.
121	DID Access Number Assign	Assigns an access number to the customer's ANI. Customer's ANI must be registered before this operation. Once the DID Access Number has been assigned to the ANI, the customer can be called from the assigned DID Access Number directly. (If product_id is not supplied in the request the DID is assigned to the main product that holds the specified account)
122	DID Access Number Un-Assign	UnAssigns the previously assigned DID Access Number from the customer's ANI.
123	DID Access Number Display	Displays the previously assigned DID Access Number(s) under the specified account.
124	DID Access Number Phone Codes	Displays the list of available country calling codes in the system. This list can be used to give customers a phone codes pool prior to DID Access Number Assign.
126	DID Access Number Move	Moves the previously assigned DID Access Number from one ANI to another ANI under the same account; without releasing the DID Access Number. If customer's account is not an multi-ani account (Meaning: Account can only hold one ANI number at a time) then the old ANI is replaced with the new ANI.
127	DID Access Number Availability	Searches the DID Inventory for the provided Country Code and Area Code.
128	Product List Display	Displays the available products under the client's company.
129	Product Region Rates Display	Displays the region rates of the specified product.
132	Product Access Number Lookup	Displays the access numbers under the specified product.
134	Set CallerID	Transaction Type 134 is used to define what the Caller-ID should appear to be when an account holder originates a phone call. i.e. user making a call using an account number that has a VirtualANI registered would be able to pass a CallerID different than their Virtual ANI. The Caller-ID will be limited to a DID that is already assigned to the given account.
135	Display CallerID	Displays the Caller-ID currently defined for the account.
136	Delete CallerID	Removes the previously assigned Caller-ID definition.
137	Destination Lookup	Displays the destination region name, rate and status of the destination for the specified product.
138	Set Preferred Language	Sets, resets and displays language for the specified account.
140	Set Auto Recharge	Sets Auto-Recharge feature ON or OFF for the specified account. If this feature is on then the account will be automatically recharged whenever the account balance goes below a certain amount.
200	VOIP Account Information	Retrieves VOIP Account Information of the specified account.
201	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.
202	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.
203	VOIP MAC Address Registration	Registers the entered MAC Address to a VOIP Box under the specified account.
204	VOIP VoiceMail	Performs several sub functions such as displaying or updating voice mail information of the accounts, deleting voice mail messages etc.
205	VOIP Account Delete	Deletes VOIP Accounts.
206	VOIP Account Check	Checks if the specified VOIP Account is already registered in the system.
207	VOIP Change Password	Updates VOIP Account Password.

Account (PIN) Creation Request

Field Name	Required	Field Type	Description
transaction_type	Yes	Integer	Constant value = 100
transaction_amount	Yes	Integer	Initial balance of the account in cents. (Exp: 450 = $4.50)
product_id	Yes	Integer	Product identifier. Please use (transaction_type = 128) to get the list of product_id values.
status_flag	No*	Integer	Status of the new account to be created. Constant value (0=deactive, 1=active). Default is 0.
account_number	No*	String (10)	10-Digit Account Number (PIN). If account_number is not provided or it already exists in the system; the system generates a random PIN.
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.

Account (PIN) Creation 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 = 100
transaction_id	Integer	Unique sequential number assigned by Auris to identify the transaction in the system. It might be used to submit a modification of this transaction at a later time, such as voiding, crediting or capturing the transaction.
transaction_amount	Integer	Echoed (or provided).
product_id	Integer	Echoed.
status_flag	Integer	Echoed (or provided).
account_number	String (10)	Echoed (or provided).
serial_number	String (10)	Echoed (or provided).
reference_id	String (20)	Echoed.

Account Information Request

Field Name	Required	Field Type	Description
transaction_type	Yes	Integer	Constant value = 101

Option - 1 (send account_number)
account_number	Yes	String (10)	Account Number (PIN)

Option - 2 (send serial_number)
serial_number	Yes	String (10)	Serial number of the account (CardID)

Option - 3 (send access_number & ani_number)
access_number	Yes	String (20)	Company Access number with country code. (Exp: 18007776655) Use the same phone number format as it is showed above.
ani_number	Yes	String (20)	Customers' phone number with country code. (Exp: 13057776655) For USA: Enter: 1+ Area Code + PhoneNumber For Internationals: Enter: 011+ [CountryCode] + PhoneNumber

Option - 4 (send product_id & ani_number)
product_id	Yes	Integer	Product identifier. Please use (transaction_type = 128) to get the list of product_id values.
ani_number	Yes	String (20)	Customers' phone number with country code. (Exp: 13057776655) For USA: Enter: 1+ Area Code + PhoneNumber For Internationals: Enter: 011+ [CountryCode] + PhoneNumber

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.

Account Information 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 = 101
transaction_id	Integer	Unique sequential number assigned by Auris to identify the transaction in the system. It might be used to submit a modification of this transaction at a later time, such as voiding, crediting or capturing the transaction.
pre_transaction_balance	Numeric (9,4)	$ Amount of account balance prior to transaction.
post_transaction_balance	Numeric (9,4)	$ Amount of account balance after transaction.
pre_transaction_status	Integer	Account Status prior to transaction (Account Statuses).
post_transaction_status	Integer	Account Status after transaction (Account Statuses).
initial_balance	Numeric (9,4)	Initial $ amount of the account balance.
firstusage_date	String (20)	First usage date of the account in mm/dd/yyyy hh:mm:nn format.
expire_date	String (10)	Expire date of the account in mm/dd/yyyy format.
product_id	Integer	Echoed.
access_number	String (20)	Echoed.
ani_number	String (20)	Echoed.
account_number	String (10)	Echoed (or provided).
serial_number	String (10)	Echoed (or provided).
reference_id	String (20)	Echoed.

Account Recharge Request

Field Name	Required	Field Type	Description
transaction_type	Yes	Integer	Constant value = 102
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)
transaction_amount	Yes	Integer	Amount (in cents) to increment (+credit) or decrement (-debit) account balance. (Exp: 450 = $4.50)
recharge_type	No*	Integer	Default is 1. Use 2 for your internal reporting purposes. Use 4 not to recharge accounts who's status is not active.
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.

Account Recharge 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 = 102
transaction_id	Integer	Unique sequential number assigned by Auris to identify the transaction in the system. It might be used to submit a modification of this transaction at a later time, such as voiding, crediting or capturing the transaction.
pre_transaction_balance	Numeric (9,4)	$ Amount of account balance prior to transaction.
post_transaction_balance	Numeric (9,4)	$ Amount of account balance after transaction.
pre_transaction_status	Integer	Account Status prior to transaction (Account Statuses).
post_transaction_status	Integer	Account Status after transaction (Account Statuses).
initial_balance	Numeric (9,4)	Initial $ amount of the account balance.
firstusage_date	String (20)	First usage date of the account in mm/dd/yyyy hh:mm:nn format.
expire_date	String (10)	Expire date of the account in mm/dd/yyyy format.
transaction_amount	Integer	Echoed (or provided).
recharge_type	Integer	Echoed (or provided).
account_number	String (10)	Echoed (or provided).
serial_number	String (10)	Echoed (or provided).
reference_id	String (20)	Echoed.

Account Recharge with New PIN (Request)

Field Name	Required	Field Type	Description
transaction_type	Yes	Integer	Constant value = 125
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)
new_pin	Yes	String (10)	Newly purchased PIN.
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.

Account Recharge with New PIN (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 = 125
transaction_id	Integer	Unique sequential number assigned by Auris to identify the transaction in the system. It might be used to submit a modification of this transaction at a later time, such as voiding, crediting or capturing the transaction.
pre_transaction_balance	Numeric (9,4)	$ Amount of account balance prior to transaction.
post_transaction_balance	Numeric (9,4)	$ Amount of account balance after transaction.
new_pin	String (10)	Echoed.
account_number	String (10)	Echoed (or provided).
serial_number	String (10)	Echoed (or provided).
reference_id	String (20)	Echoed.

Account Credit Request

Field Name	Required	Field Type	Description
transaction_type	Yes	Integer	Constant value = 103
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)
transaction_amount	Yes	Integer	Amount (in cents) to increment (+credit) or decrement (-debit) account balance. (Exp: 450 = $4.50)
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.

Account Credit 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 = 103
transaction_id	Integer	Unique sequential number assigned by Auris to identify the transaction in the system. It might be used to submit a modification of this transaction at a later time, such as voiding, crediting or capturing the transaction.
pre_transaction_balance	Numeric (9,4)	$ Amount of account balance prior to transaction.
post_transaction_balance	Numeric (9,4)	$ Amount of account balance after transaction.
pre_transaction_status	Integer	Account Status prior to transaction (Account Statuses).
post_transaction_status	Integer	Account Status after transaction (Account Statuses).
initial_balance	Numeric (9,4)	Initial $ amount of the account balance.
firstusage_date	String (20)	First usage date of the account in mm/dd/yyyy hh:mm:nn format.
expire_date	String (10)	Expire date of the account in mm/dd/yyyy format.
transaction_amount	Integer	Echoed (or provided).
account_number	String (10)	Echoed (or provided).
serial_number	String (10)	Echoed (or provided).
reference_id	String (20)	Echoed.

Account Activation Request

Field Name	Required	Field Type	Description
transaction_type	Yes	Integer	Constant value = 104

Option - 1 (send account_number)
account_number	Yes	String (10)	Account Number (PIN)

Option - 2 (send serial_number)
serial_number	Yes	String (10)	Serial number of the account (CardID)

Option - 3 (send batch_no & batch_serial)
batch_no	Yes	String (10)	Batch Number.
batch_serial	Yes	String (10)	Sequence Number in the specified batch.

transaction_amount	No	Integer	Initial balance of the account in cents. (Exp: 450 = $4.50)
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.

Account Activation 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 = 104
transaction_id	Integer	Unique sequential number assigned by Auris to identify the transaction in the system. It might be used to submit a modification of this transaction at a later time, such as voiding, crediting or capturing the transaction.
pre_transaction_balance	Numeric (9,4)	$ Amount of account balance prior to transaction.
post_transaction_balance	Numeric (9,4)	$ Amount of account balance after transaction.
pre_transaction_status	Integer	Account Status prior to transaction (Account Statuses).
post_transaction_status	Integer	Account Status after transaction (Account Statuses).
initial_balance	Numeric (9,4)	Initial $ amount of the account balance.
firstusage_date	String (20)	First usage date of the account in mm/dd/yyyy hh:mm:nn format.
expire_date	String (10)	Expire date of the account in mm/dd/yyyy format.
transaction_amount	Integer	Echoed (or provided).
account_number	String (10)	Echoed (or provided).
serial_number	String (10)	Echoed (or provided).
batch_no	String (10)	Echoed (or provided).
batch_serial	String (10)	Echoed (or provided).
reference_id	String (20)	Echoed.

Account Deactivation Request

Field Name	Required	Field Type	Description
transaction_type	Yes	Integer	Constant value = 105

Option - 1 (send account_number)
account_number	Yes	String (10)	Account Number (PIN)

Option - 2 (send serial_number)
serial_number	Yes	String (10)	Serial number of the account (CardID)

Option - 3 (send batch_no & batch_serial)
batch_no	Yes	String (10)	Batch Number.
batch_serial	Yes	String (10)	Sequence Number in the specified batch.

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.

Account Deactivation 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 = 105
transaction_id	Integer	Unique sequential number assigned by Auris to identify the transaction in the system. It might be used to submit a modification of this transaction at a later time, such as voiding, crediting or capturing the transaction.
pre_transaction_balance	Numeric (9,4)	$ Amount of account balance prior to transaction.
post_transaction_balance	Numeric (9,4)	$ Amount of account balance after transaction.
pre_transaction_status	Integer	Account Status prior to transaction (Account Statuses).
post_transaction_status	Integer	Account Status after transaction (Account Statuses).
initial_balance	Numeric (9,4)	Initial $ amount of the account balance.
firstusage_date	String (20)	First usage date of the account in mm/dd/yyyy hh:mm:nn format.
expire_date	String (10)	Expire date of the account in mm/dd/yyyy format.
account_number	String (10)	Echoed (or provided).
serial_number	String (10)	Echoed (or provided).
batch_no	String (10)	Echoed (or provided).
batch_serial	String (10)	Echoed (or provided).
reference_id	String (20)	Echoed.

ANI Registration Request

Field Name	Required	Field Type	Description
transaction_type	Yes	Integer	Constant value = 106
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)
ani_number	No*	String (20)	Phone number with country code. (Exp: 13057776655) Please use ani_number for single ANI registration!
ani_list	No*	String (255)	Comma seperated phone numbers with country code. (Exp: 13057775555,13058885555,13059995555) Please use ani_list for multiple ANI registration!
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.
Additional parameters (Only for ANI PROVISIONING!)
language_id	Yes	Integer	Constant value (0=English, 1=Spanish, 2=Portuguese, 3=Korean)
callflow_id	Yes	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

ANI Registration 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 = 106
transaction_id	Integer	Unique sequential number assigned by Auris to identify the transaction in the system. It might be used to submit a modification of this transaction at a later time, such as voiding, crediting or capturing the transaction.
ani_number	String (20)	Echoed.
ani_list	String (255)	Echoed. If response_code is 1 (Success) then ani_list only returns the list of successfully registered ANI numbers!
language_id	Integer	Echoed.
callflow_id	Integer	Echoed.
account_number	String (10)	Echoed (or provided).
serial_number	String (10)	Echoed (or provided).
reference_id	String (20)	Echoed.

ANI Registration With New PIN Creation & Activation Request

Field Name	Required	Field Type	Description
transaction_type	Yes	Integer	Constant value = 118
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 account in cents. (Exp: 450 = $4.50)
ani_number	Yes	String (20)	Phone number with country code. (Exp: 13057776655)
account_number	No*	String (10)	Account Number (PIN)
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.

ANI Registration With New PIN Creation & Activation 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 = 118
transaction_id	Integer	Unique sequential number assigned by Auris to identify the transaction in the system. It might be used to submit a modification of this transaction at a later time, such as voiding, crediting or capturing the transaction.
transaction_amount	Integer	Echoed (or provided).
ani_number	String (20)	Echoed.
account_number	String (10)	Echoed (or provided).
serial_number	String (10)	Echoed (or provided).
reference_id	String (20)	Echoed.

ANI Un-Registration Request

Field Name	Required	Field Type	Description
transaction_type	Yes	Integer	Constant value = 109
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)
ani_number	No*	String (20)	Phone number with country code. (Exp: 13057776655) Please use ani_number for single ANI un-registration!
ani_list	No*	String (255)	Comma seperated phone numbers with country code. (Exp: 13057775555,13058885555,13059995555) Please use ani_list for multiple ANI un-registration!
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.

ANI Un-Registration 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 = 109
transaction_id	Integer	Unique sequential number assigned by Auris to identify the transaction in the system. It might be used to submit a modification of this transaction at a later time, such as voiding, crediting or capturing the transaction.
ani_number	String (20)	Echoed.
ani_list	String (255)	Echoed. If response_code is 1 (Success) then ani_list only returns the list of successfully un-registered ANI numbers!
account_number	String (10)	Echoed (or provided).
serial_number	String (10)	Echoed (or provided).
reference_id	String (20)	Echoed.

ANI Display Request

Field Name	Required	Field Type	Description
transaction_type	Yes	Integer	Constant value = 114
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)
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.

ANI Display Response

- View [XML] response

- View [delimeted text] response

Back to top

Call Back Request

Field Name	Required	Field Type	Description
transaction_type	Yes	Integer	Constant value = 107
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)
origination_number	Yes	String (20)	Origination phone number. (Exp: 13057776655) For calls in the USA: Enter: 1+ Area Code + PhoneNumber For International Calls: Enter: 011+ [CountryCode] + PhoneNumber
destination_number	No	String (20)	Destination phone number. (Exp: 011902127776655) For calls in the USA: Enter: 1+ Area Code + PhoneNumber For International Calls: Enter: 011+ [CountryCode] + PhoneNumber
call_delay	No	Integer	Number of minutes. To schedule a call for 5 minutes later send call_delay=5, for 1 hour later call_delay=60; for 1 day later call_delay=1440(24X60)
activation_code	No	String (20)	Only for special use.
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.

Call Back 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 = 107
transaction_id	Integer	Unique sequential number assigned by Auris to identify the transaction in the system. It might be used to submit a modification of this transaction at a later time, such as voiding, crediting or capturing the transaction.
origination_number	String (20)	Echoed.
destination_number	String (20)	Echoed.
call_delay	Integer	Echoed.
activation_code	String (20)	Echoed.
account_number	String (10)	Echoed (or provided).
serial_number	String (10)	Echoed (or provided).
reference_id	String (20)	Echoed.

Call Back Special Request

Field Name	Required	Field Type	Description
transaction_type	Yes	Integer	Constant value = 139
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)
origination_number	Yes	String (20)	Origination phone number. (Exp: 13057776655) For calls in the USA: Enter: 1+ Area Code + PhoneNumber For International Calls: Enter: 011+ [CountryCode] + PhoneNumber
destination_number	No	String (20)	Destination phone number. (Exp: 011902127776655) For calls in the USA: Enter: 1+ Area Code + PhoneNumber For International Calls: Enter: 011+ [CountryCode] + PhoneNumber
call_type	No	Integer	For special call types.
call_delay	No	Integer	Number of minutes. To schedule a call for 5 minutes later send call_delay=5, for 1 hour later call_delay=60; for 1 day later call_delay=1440(24X60)
activation_code	No	String (20)	Only for special use.
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.

Call Back Special 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 = 139
transaction_id	Integer	Unique sequential number assigned by Auris to identify the transaction in the system. It might be used to submit a modification of this transaction at a later time, such as voiding, crediting or capturing the transaction.
origination_number	String (20)	Echoed.
destination_number	String (20)	Echoed.
call_type	Integer	Echoed.
call_delay	Integer	Echoed.
activation_code	String (20)	Echoed.
account_number	String (10)	Echoed (or provided).
serial_number	String (10)	Echoed (or provided).
reference_id	String (20)	Echoed.

Call Back / Call Rate Request

Field Name	Required	Field Type	Description
transaction_type	Yes	Integer	Constant value = 110
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)
origination_number	Yes	String (20)	Origination phone number. (Exp: 13057776655) For calls in the USA: Enter: 1+ Area Code + PhoneNumber For International Calls: Enter: 011+ [CountryCode] + PhoneNumber
destination_number	Yes	String (20)	Destination phone number. (Exp: 011902127776655) For calls in the USA: Enter: 1+ Area Code + PhoneNumber For International Calls: Enter: 011+ [CountryCode] + PhoneNumber
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.

Call Back / Call Rate 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 = 110
transaction_id	Integer	Unique sequential number assigned by Auris to identify the transaction in the system. It might be used to submit a modification of this transaction at a later time, such as voiding, crediting or capturing the transaction.
origination_number	String (20)	Echoed.
destination_number	String (20)	Echoed.
origination_region	String (50)	Origination Region Name.
destination_region	String (50)	Destination Region Name.
call_rate	Numeric (9,4)	Calling rate ($/minute).
account_number	String (10)	Echoed (or provided).
serial_number	String (10)	Echoed (or provided).
reference_id	String (20)	Echoed.

Call Back / Call Status Request

Field Name	Required	Field Type	Description
transaction_type	Yes	Integer	Constant value = 111
call_id	Yes	Integer	transaction_id output of the previously placed call back request.
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.

Call Back / Call Status 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 = 111
transaction_id	Integer	Unique sequential number assigned by Auris to identify the transaction in the system. It might be used to submit a modification of this transaction at a later time, such as voiding, crediting or capturing the transaction.
call_id	Integer	Echoed.
origination_number	String (20)	Origination phone number of the call request.
destination_number	String (20)	Destination phone number of the call request.
call_status	Integer	Indicates the result of the call request as an integer (Call Statuses).
call_status_desc	String (80)	Indicates the result of the call request as a text, which corresponds with the call status.
reference_id	String (20)	Echoed.

Call Back / Call History Request

Field Name	Required	Field Type	Description
transaction_type	Yes	Integer	Constant value = 112
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)
start_date	No	String (8)	Start date of the date range in 'yyyymmdd' format. (Exp: 20040401)
end_date	No	String (8)	End date of the date range in 'yyyymmdd' format. (Exp: 20040415)
call_filter	No	Integer	Filters the response according to passed value. (default is 1). 1 = All callback attempts on the specified account. 2 = Only Successfull ones. 3 = All but successfull ones. 4 = Only scheduled ones which are still waiting to be processed.
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.

Call Back / Call History Response

- View [XML] response

- View [delimeted text] response

Back to top

CDR Request

Field Name	Required	Field Type	Description
transaction_type	Yes	Integer	Constant value = 108
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)
start_date	Yes	String (8)	Start date of the date range in 'yyyymmdd' format. (Exp: 20040401) There is a date limit for CDR requests; the system returns as far back as 3 months from the current date.
end_date	No	String (8)	End date of the date range in 'yyyymmdd' format. (Exp: 20040415). If end_date is not supplied only the records on start_date will be returned.
record_filter	No	Integer	Filters the response according to passed value. (Default is 0) 0 = Shows only actual calls. 1 = Shows calls and changes in balance like credits, recharges etc.
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.
page_size	No*	Integer	Maximum number of records returned for one page in the response. (If not supplied, default is 250 records)
page_number	No*	Integer	Current page of the recordset in the response. (If not supplied, system always returns the first page of the recordset)
page_count	No	Integer	Total Number of pages for the requested data. (Informational)

CDR Response

- View [XML] response

- View [delimeted text] response

Back to top

Quick Dial Registration Request

Field Name	Required	Field Type	Description
transaction_type	Yes	Integer	Constant value = 115
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)
ani_number	No*	String (20)	Customers' phone number with country code. (Exp: 13057776655) For USA: Enter: 1+ Area Code + PhoneNumber For Internationals: Enter: 011+ [CountryCode] + PhoneNumber Note: When you un-register the ANI all the previously assigned destination numbers under that ANI are deleted automatically. Please use ani_number for single ANI registration!
ani_list	No*	String (255)	Comma seperated phone numbers with country code. (Exp: 13057775555,13058885555,13059995555) Please use ani_list for multiple ANI registration!
access_number	Yes	String (20)	Company Access number with country code. (Exp: 18007776655) Use the same phone number format as it is showed above.
destination_number	Yes	String (20)	Destination phone number with country code. (Exp: 13057776655) Use the same phone number format as it is showed above.
description	No	String (50)	Brief description to label the quick dial 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.

Quick Dial Registration 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 = 115
transaction_id	Integer	Unique sequential number assigned by Auris to identify the transaction in the system. It might be used to submit a modification of this transaction at a later time, such as voiding, crediting or capturing the transaction.
ani_number	String (20)	Echoed.
ani_list	String (255)	Echoed. If response_code is 1 (Success) then ani_list only returns the list of successfully registered quick dial ANI numbers!
access_number	String (20)	Echoed (or provided).
destination_number	String (20)	Echoed (or provided).
description	String (50)	Echoed (or provided).
account_number	String (10)	Echoed (or provided).
serial_number	String (10)	Echoed (or provided).
reference_id	String (20)	Echoed.

Quick Dial Delete Request

Field Name	Required	Field Type	Description
transaction_type	Yes	Integer	Constant value = 116
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)
ani_number	No*	String (20)	Customers' phone number with country code. (Exp: 13057776655) For USA: Enter: 1+ Area Code + PhoneNumber For Internationals: Enter: 011+ [CountryCode] + PhoneNumber Note: When you un-register the ANI all the previously assigned destination numbers under that ANI are deleted automatically. Please use ani_number for single ANI un-registration!
ani_list	No*	String (255)	Comma seperated phone numbers with country code. (Exp: 13057775555,13058885555,13059995555) Please use ani_list for multiple ANI un-registration!
access_number	Yes	String (20)	Company Access number with country code. (Exp: 18007776655) Use the same phone number format as it is showed above.
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.

Quick Dial Delete 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 = 116
transaction_id	Integer	Unique sequential number assigned by Auris to identify the transaction in the system. It might be used to submit a modification of this transaction at a later time, such as voiding, crediting or capturing the transaction.
ani_number	String (20)	Echoed.
ani_list	String (255)	Echoed. If response_code is 1 (Success) then ani_list only returns the list of successfully un-registered quick dial ANI numbers!
access_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.

Quick Dial Display Request

Field Name	Required	Field Type	Description
transaction_type	Yes	Integer	Constant value = 117
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)
ani_number	Yes	String (20)	Customers' phone number with country code. (Exp: 13057776655) For USA: Enter: 1+ Area Code + PhoneNumber For Internationals: Enter: 011+ [CountryCode] + PhoneNumber
access_number	No	String (20)	Company Access number with country code. (Exp: 18007776655) Use the same phone number format as it is showed above.
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.

Quick Dial Display Response

- View [XML] response

- View [delimeted text] response

Back to top

Speed Dial Add/Edit

Field Name	Required	Field Type	Description
transaction_type	Yes	Integer	Constant value = 119
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)
speeddial_number	Yes	Integer	Speed dial number; the digits are available from 1 to 99.
destination_number	No*	String (20)	Destination phone number. (Exp: 3057776655) For USA: Enter: Area Code + PhoneNumber For Internationals: Enter: 011+ [CountryCode] + PhoneNumber Note: Send nothing for this field if you want to delete the previously assigned destination number.
speeddial_label	No	String (20)	Brief description to label the speed dial 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.

Speed Dial Add/Edit 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 = 119
transaction_id	Integer	Unique sequential number assigned by Auris to identify the transaction in the system. It might be used to submit a modification of this transaction at a later time, such as voiding, crediting or capturing the transaction.
speeddial_number	Integer	Echoed.
destination_number	String (20)	Echoed.
speeddial_label	String (20)	Echoed.
account_number	String (10)	Echoed (or provided).
serial_number	String (10)	Echoed (or provided).
reference_id	String (20)	Echoed.

Speed Dial Display Request

Field Name	Required	Field Type	Description
transaction_type	Yes	Integer	Constant value = 120
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)
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.

Speed Dial Display Response

- View [XML] response

- View [delimeted text] response

Back to top

DID Access Number Assign Request

Field Name

Required

Field Type

Description

transaction_type

Yes

Integer

Constant value = 121

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)

ani_number

Yes

String (20)

Customers' phone number with country code. (Exp: 13057776655)

For USA:
Enter: 1+ Area Code + PhoneNumber

For Internationals:
Enter: 011+ [CountryCode] + PhoneNumber

country_code

Yes

Integer

International phone code for the requested DID Access Number. (Exp: 1 - USA, 52 - MEXICO, 999 - CANADA)

Note: To distinguish between USA, Canada, Dominican Republic and Puerto Rico, please provide '999' as country_code for Canada, '829' for Dominican Republic and '939' for Puerto Rico.

area_code

No*

Integer

Area code for specific region. (Exp: 201 - NJ, 212 - NY)
Please provide area_code for better results.

callflow_id

No*

Integer

Constant value;
1114 = Billed DID
1644 = Billed DID -NO Answer
1549 = Billed DID -RCDB

company_reserve

No*

Integer

Constant value;
0 = Default DID Pool.
1 = Company Reserved DID Pool.

product_id

Integer

Product identifier. Please use (transaction_type = 128) to get the list of product_id values.

reference_id

String (20)

Reference identifier assigned by client. This value is recorded for reporting purposes and will be passed back in the response.

Additional fields for address validation!

first_name

No*

String (50)

List of countries that requires place of valid residence/business:

AUSTRALIA
BELGIUM
CZECH REPUBLIC
FINLAND
FRANCE

GERMANY
GREECE
HUNGARY
IRELAND
ITALY

LATVIA
LUXEMBOURG
NETHERLANDS
NORWAY
PANAMA

SLOVAKIA
SPAIN
SWEDEN
SWITZERLAND

last_name

No*

String (50)

company_name

No*

String (50)

address

No*

String (100)

building_no

No*

String (10)

city

No*

String (50)

zipcode

No*

String (10)

address_country

No*

String (10)

International phone code for the address' country. (Exp: 1 - USA, 52 - MEXICO, 999 - CANADA)

Note: To distinguish between USA, Canada, Dominican Republic and Puerto Rico, please provide '999' as country_code for Canada, '829' for Dominican Republic and '939' for Puerto Rico.

salutation

No*

String (50)

Only accepted values: MR | MS | COMPANY

DID Access Number Assign 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 = 121
transaction_id	Integer	Unique sequential number assigned by Auris to identify the transaction in the system. It might be used to submit a modification of this transaction at a later time, such as voiding, crediting or capturing the transaction.
ani_number	String (20)	Echoed.
country_code	Integer	Echoed.
area_code	Integer	Echoed.
callflow_id	Integer	Echoed.
company_reserve	Integer	Echoed.
product_id	Integer	Echoed.
access_number	String (20)	Provided.
account_number	String (10)	Echoed (or provided).
serial_number	String (10)	Echoed (or provided).
reference_id	String (20)	Echoed.

DID Access Number Un-Assign Request

Field Name	Required	Field Type	Description
transaction_type	Yes	Integer	Constant value = 122
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)
access_number	Yes	String (20)	Previously assigned DID Access Number. For USA: Enter: 1+ Area Code + PhoneNumber For Internationals: Enter: 011+ [CountryCode] + PhoneNumber
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 Access Number Un-Assign 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 = 122
transaction_id	Integer	Unique sequential number assigned by Auris to identify the transaction in the system. It might be used to submit a modification of this transaction at a later time, such as voiding, crediting or capturing the transaction.
access_number	String (20)	Echoed.
account_number	String (10)	Echoed (or provided).
serial_number	String (10)	Echoed (or provided).
reference_id	String (20)	Echoed.

DID Access Number Display Request

Field Name	Required	Field Type	Description
transaction_type	Yes	Integer	Constant value = 123
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)
region_filter	No*	Integer	If region_filter = 1 then [RegionName] is included in the response as an additional field.
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 Access Number Display Response

- View [XML] response

- View [delimeted text] response

Back to top

DID Access Number Phone Codes Request

Field Name	Required	Field Type	Description
transaction_type	Yes	Integer	Constant value = 124
country_code	No*	Integer	International Phone Code. (Exp: 1 - USA, 52 - MEXICO, 999 - CANADA) If no country_code is provided it displays the list of countries. When country_code is provided it displays the list of available regions under that country. Note: To distinguish between USA, Canada, Dominican Republic and Puerto Rico, please provide '999' as country_code for Canada, '829' for Dominican Republic and '939' for Puerto Rico.
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 Access Number Phone Codes Response

- View [XML] response

- View [delimeted text] response

Back to top

DID Access Number Availability Request

Field Name	Required	Field Type	Description
transaction_type	Yes	Integer	Constant value = 127
country_code	Yes	Integer	International Phone Code. (Exp: 1 - USA, 52 - MEXICO, 999 - CANADA) Note: To distinguish between USA, Canada, Dominican Republic and Puerto Rico, please provide '999' as country_code for Canada, '829' for Dominican Republic and '939' for Puerto Rico.
area_code	Yes	Integer	Area code for specific region. (Exp: 201 - NJ, 212 - NY)
company_reserve	No*	Integer	Constant value; 0 = Default DID Pool. 1 = Company Reserved DID Pool.
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 Access Number Availability 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 = 127
transaction_id	Integer	Unique sequential number assigned by Auris to identify the transaction in the system. It might be used to submit a modification of this transaction at a later time, such as voiding, crediting or capturing the transaction.
country_code	Integer	Echoed.
area_code	Integer	Echoed.
company_reserve	Integer	Echoed.
reference_id	String (20)	Echoed.

DID Access Number Move Request

Field Name	Required	Field Type	Description
transaction_type	Yes	Integer	Constant value = 126
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)
access_number	Yes	String (20)	Previously assigned DID Access Number to be moved. For USA: Enter: 1+ Area Code + PhoneNumber For Internationals: Enter: 011+ [CountryCode] + PhoneNumber
ani_number	Yes	String (20)	This is the new ANI number which will get the previously assigned DID Access Number. For USA: Enter: 1+ Area Code + PhoneNumber For Internationals: Enter: 011+ [CountryCode] + PhoneNumber
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 Access Number Move 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 = 126
transaction_id	Integer	Unique sequential number assigned by Auris to identify the transaction in the system. It might be used to submit a modification of this transaction at a later time, such as voiding, crediting or capturing the transaction.
access_number	String (20)	Echoed.
ani_number	String (20)	Echoed.
account_number	String (10)	Echoed (or provided).
serial_number	String (10)	Echoed (or provided).
reference_id	String (20)	Echoed.

Product List Display Request

Field Name	Required	Field Type	Description
transaction_type	Yes	Integer	Constant value = 128
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.

Product List Display Response

- View [XML] response

- View [delimeted text] response

Back to top

Product Region Rates Display Request

Field Name	Required	Field Type	Description
transaction_type	Yes	Integer	Constant value = 129
product_id	Yes	Integer	Product identifier. Please use (transaction_type = 128) to get the list of product_id values.
region_filter	No*	String (50)	If region_filter is not send all the regions under the product is returned as default, if it is send all the likely regions are returned. (Exp: send 'M' for the regions who starts with M or send 'MEX' for only Mexico regions.)
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.

Product Region Rates Display Response

- View [XML] response

- View [delimeted text] response

Back to top

Product Access Number Lookup Request

Field Name	Required	Field Type	Description
transaction_type	Yes	Integer	Constant value = 132
product_id	No*	Integer	Product identifier. Please use (transaction_type = 128) to get the list of product_id values.
group_id	No*	Integer	Access Number Call Flow GroupID for filtering purposes.
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.

Product Access Number Lookup Response

- View [XML] response

- View [delimeted text] response

Back to top

Batch Account Activation/Deactivation/StatusCheck Request

Field Name	Required	Field Type	Description
transaction_type	Yes	Integer	Constant value = 130
product_id	Yes	Integer	Product identifier. Please use (transaction_type = 128) to get the list of product_id values.
status_flag	No*	Integer	Send nothing for status check, 0 for deactivation, 1 for activation.
batch_no	No*	Integer	Leave emtpy for CardID range or send BatchNo for Batch range.
range_start	Yes	Integer	Start number of the Batch or CardID range.
range_end	Yes	Integer	End number of the Batch or CardID range.
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.

Batch Account Activation/Deactivation/StatusCheck 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 = 130
transaction_id	Integer	Unique sequential number assigned by Auris to identify the transaction in the system. It might 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.
status_flag	Integer	Echoed.
batch_no	Integer	Echoed.
range_start	Integer	Echoed.
range_end	Integer	Echoed.
activated	Integer	Number of activated accounts (status=1) in the range.
deactivated	Integer	Number of deactivated accounts (status=101) in the range.
destroyed	Integer	Number of destroyed accounts (status=222) in the range.
inactive	Integer	Number of inactive accounts (status=0) in the range.
total	Integer	Number of accounts in the range.
reference_id	String (20)	Echoed.

Quick Dial On-Demand Request

Field Name	Required	Field Type	Description
transaction_type	Yes	Integer	Constant value = 131
account_number	No*	String (10)	Account Number (PIN)
serial_number	No*	String (10)	Serial number of the account (CardID)
ani_number	No*	String (20)	Customer's phone number with country code. (Exp: 13057776655) For USA: Enter: 1+ Area Code + PhoneNumber For Internationals: Enter: 011+ [CountryCode] + PhoneNumber (serial number or account number or ani_number is mandatory)
destination_number	Yes	String (20)	Destination phone number with country code. (Exp: 13057776655) Use the same phone number format as it is showed above.
access_number	Yes	String (20)	Access number with country code. (Exp: 18007776655) Use the same phone number format as it is showed above.
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.

Quick Dial On-Demand 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 = 131
transaction_id	Integer	Unique sequential number assigned by Auris to identify the transaction in the system. It might be used to submit a modification of this transaction at a later time, such as voiding, crediting or capturing the transaction.
ani_number	String (20)	Echoed.
destination_number	String (20)	Echoed (or provided).
access_number	String (20)	Echoed (or provided).
new_access_number	String (20)	Local Access Number returned.
account_number	String (10)	Echoed (or provided).
serial_number	String (10)	Echoed (or provided).
reference_id	String (20)	Echoed.

Dialing Plan Assign by ANI Request

Field Name	Required	Field Type	Description
transaction_type	Yes	Integer	Constant value = 133
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)
ani_number	Yes	String (20)	Regular or Virtual phone number. For USA: Enter: 1+ Area Code + PhoneNumber For International ANIs: Enter: 011+ [CountryCode] + PhoneNumber
region_id	Yes	Integer	Region identifier for ANI translation.
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.

Dialing Plan Assign by ANI 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 = 133
transaction_id	Integer	Unique sequential number assigned by Auris to identify the transaction in the system. It might be used to submit a modification of this transaction at a later time, such as voiding, crediting or capturing the transaction.
ani_number	String (20)	Echoed.
region_id	Integer	Echoed.
account_number	String (10)	Echoed (or provided).
serial_number	String (10)	Echoed (or provided).
reference_id	String (20)	Echoed.

Set CallerID Request

Field Name	Required	Field Type	Description
transaction_type	Yes	Integer	Constant value = 134
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)
ani_number	Yes	String (20)	Customers' phone number with country code. (Exp: 13057776655) For USA: Enter: 1+ Area Code + PhoneNumber For Internationals: Enter: 011+ [CountryCode] + PhoneNumber
caller_id	Yes	String (20)	One of the owned DIDs.
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 CallerID 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 = 134
transaction_id	Integer	Unique sequential number assigned by Auris to identify the transaction in the system. It might be used to submit a modification of this transaction at a later time, such as voiding, crediting or capturing the transaction.
ani_number	String (20)	Echoed.
caller_id	String (20)	Echoed.
account_number	String (10)	Echoed (or provided).
serial_number	String (10)	Echoed (or provided).
reference_id	String (20)	Echoed.

CallerID Display Request

Field Name	Required	Field Type	Description
transaction_type	Yes	Integer	Constant value = 135
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)
ani_number	No*	String (20)	Customers' phone number with country code. (Exp: 13057776655) For USA: Enter: 1+ Area Code + PhoneNumber For Internationals: Enter: 011+ [CountryCode] + PhoneNumber
caller_id	No*	String (20)	One of the owned DIDs.
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.

CallerID Display Response

- View [XML] response

- View [delimeted text] response

Back to top

CallerID Delete Request

Field Name	Required	Field Type	Description
transaction_type	Yes	Integer	Constant value = 136
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)
ani_number	Yes	String (20)	Customers' phone number with country code. (Exp: 13057776655) For USA: Enter: 1+ Area Code + PhoneNumber For Internationals: Enter: 011+ [CountryCode] + PhoneNumber
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.

CallerID Delete 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 = 136
transaction_id	Integer	Unique sequential number assigned by Auris to identify the transaction in the system. It might be used to submit a modification of this transaction at a later time, such as voiding, crediting or capturing the transaction.
ani_number	String (20)	Echoed.
account_number	String (10)	Echoed (or provided).
serial_number	String (10)	Echoed (or provided).
reference_id	String (20)	Echoed.

Destination Lookup Request

Field Name	Required	Field Type	Description
transaction_type	Yes	Integer	Constant value = 137
product_id	Yes	Integer	Product identifier. Please use (transaction_type = 128) to get the list of product_id values.
destination_number	Yes	String (20)	Destination area code or complete phone number. (Exp: 01190212) For calls in the USA: Enter: 1+ Area Code + PhoneNumber For International Calls: Enter: 011+ [CountryCode] + PhoneNumber
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.

Destination Lookup 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 = 137
product_id	Integer	Echoed.
destination_number	String (20)	Echoed.
company_name	String (50)	Provided.
product_name	String (50)	Provided.
destination_region	String (50)	Destination region name.
call_rate	Numeric (9,4)	Calling rate ($/minute).
call_status	Integer	1 for enabled, 0 for disabled.
reference_id	String (20)	Echoed.

Set Preferred Language Request

Field Name	Required	Field Type	Description
transaction_type	Yes	Integer	Constant value = 138
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)
language_id	No*	Integer	To Display: don't send language_id To Reset: send language_id=-1 To Set: send language_id=(select from following list) Available language_id values: 2 = Portuguese 8 = English 9 = Spanish 18 = French
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 Preferred Language 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 = 138
transaction_id	Integer	Unique sequential number assigned by Auris to identify the transaction in the system. It might be used to submit a modification of this transaction at a later time, such as voiding, crediting or capturing the transaction.
language_id	Integer	Echoed (or provided).
language	String (50)	Description of the language_id.
account_number	String (10)	Echoed (or provided).
serial_number	String (10)	Echoed (or provided).
reference_id	String (20)	Echoed.

Set Auto Recharge Request

Field Name	Required	Field Type	Description
transaction_type	Yes	Integer	Constant value = 140

Option - 1 (send account_number)
account_number	Yes	String (10)	Account Number (PIN)

Option - 2 (send serial_number)
serial_number	Yes	String (10)	Serial number of the account (CardID)

Option - 3 (send product_id & ani_number)
product_id	Yes	Integer	Product identifier. Please use (transaction_type = 128) to get the list of product_id values.
ani_number	Yes	String (20)	Customers' phone number with country code. (Exp: 13057776655) For USA: Enter: 1+ Area Code + PhoneNumber For Internationals: Enter: 011+ [CountryCode] + PhoneNumber

status_flag	No*	Integer	Send nothing to check the status, 1 to activate the feature, 0 to deactivate the feature.
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 Auto Recharge 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 = 140
transaction_id	Integer	Unique sequential number assigned by Auris to identify the transaction in the system. It might be used to submit a modification of this transaction at a later time, such as voiding, crediting or capturing the transaction.
status_flag	Integer	Echoed.
product_id	Integer	Echoed.
ani_number	String (20)	Echoed.
account_number	String (10)	Echoed (or provided).
serial_number	String (10)	Echoed (or provided).
reference_id	String (20)	Echoed.

VOIP Account Information Request

Field Name	Required	Field Type	Description
transaction_type	Yes	Integer	Constant value = 200
account_number	No*	String (10)	Account Number (PIN)
serial_number	No*	String (10)	Serial number of the account (CardID)
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.

VOIP Account Information 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 = 200
transaction_id	Integer	Unique sequential number assigned by Auris to identify the transaction in the system. It might 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_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 = 201
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)
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.

VOIP Account Registration 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 = 201
transaction_id	Integer	Unique sequential number assigned by Auris to identify the transaction in the system. It might 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_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 = 202
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.

VOIP Account Registration With New PIN Creation/Activation 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 = 202
transaction_id	Integer	Unique sequential number assigned by Auris to identify the transaction in the system. It might 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_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 = 203
account_number	No*	String (10)	Account Number (PIN)
serial_number	No*	String (10)	Serial number of the account (CardID)
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.

VOIP MAC Address Registration 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 = 203
transaction_id	Integer	Unique sequential number assigned by Auris to identify the transaction in the system. It might 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 = 204
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)
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.

VOIP VoiceMail 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 = 204
transaction_id	Integer	Unique sequential number assigned by Auris to identify the transaction in the system. It might 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 = 205
account_number	No*	String (10)	Account Number (PIN)
serial_number	No*	String (10)	Serial number of the account (CardID)
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.

VOIP Account Delete 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 = 205
transaction_id	Integer	Unique sequential number assigned by Auris to identify the transaction in the system. It might 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 = 206
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.

VOIP Account Check 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 = 206
transaction_id	Integer	Unique sequential number assigned by Auris to identify the transaction in the system. It might 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 = 207
account_number	No*	String (10)	Account Number (PIN)
serial_number	No*	String (10)	Serial number of the account (CardID)
voip_ani_number	Yes	String (20)	Virtual ANI Number of the VOIP Box.
voip_pw	Yes	String (20)	New password for the VOIP Box.
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.

VOIP Change Password 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 = 207
transaction_id	Integer	Unique sequential number assigned by Auris to identify the transaction in the system. It might 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.

Control Number Update Request

Field Name	Required	Field Type	Description
transaction_type	Yes	Integer	Constant value = 789
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)
control_number	No*	String (30)	Current Control Number of the account.
new_control_number	Yes	String (30)	New Control Number to be assigned to the specified 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.

Control Number Update 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 = 789
transaction_id	Integer	Unique sequential number assigned by Auris to identify the transaction in the system. It might be used to submit a modification of this transaction at a later time, such as voiding, crediting or capturing the transaction.
new_control_number	String (30)	Echoed.
control_number	String (30)	Echoed.
account_number	String (10)	Echoed (or provided).
serial_number	String (10)	Echoed (or provided).
reference_id	String (20)	Echoed.

Response Codes & Messages

Code	Description
0	Failed.
1	Success.
2	Server Error.
3	Parameter Expected.
4	Login Failed.
5	Type Mismatch.
6	Connection is non-secure.
7	IP Check Failed.
8	Operation Unsuccessful.
9	Account could not be found.
10	Credit Limit Reached.
11	Invalid Account Status.
12	Invalid Activation/DeActivation Request.
13	ANI is already registered.
14	PIN is being used by another ANI.
15	ANI could not be found.
16	Access Number could not be found.
17	Access Number/Account do not support this feature.
18	PIN is already registered.
19	Control Number is already registered.
20	There is no registered ANI under the account.
21	New PIN is not good.
22	Account already has this feature.
23	Insufficient Inventory.
24	Duplicate Attempt. (Duplicate request attempts are disregarded for some of the transaction types if they occur within the same minute)
25	Transaction Type is Blocked.
26	Product identifier could not be validated.
27	ANI(s) is already registered under a different client.
28	Invalid callflow_id.
29	Invalid Destination.
30	ANI is already attached to a DID.
31	DID country requires address with proof.
32	Errors during DID provisioning.
33	DID provisioned but errors found during address registration.
34	DID is not available for cancellation. Available cancel date is MM/DD/YYYY.

Account Statuses

Code	Description
1	Account is active.
0	Account is inactive.
3	Account has expired.
101	Account has been deactivated.
222	Account is destroyed.

Call Statuses

Code	Description
1	Successfully Processed.
12	Invalid Phone Number.
13	Insufficient Account Balance.
101	Being Processed.
102	Being Processed.
212	Invalid Origination Phone Number.
213	Insufficient Account Balance.
222	Invalid Destination Phone Number.
223	Insufficient Account Balance.
255	Not processed yet.
300	Unable to make call, system will try again in 2 mins.
301	CallBack time expired, unable to make call.
302	Account not WebCall-Enabled, contact customer support.
400	Verification Passed.
401	Verification Attempt 1 Failed.
402	Verification Attempt 2 Failed.
403	Verification Failed.

Last Updated on 2013-08-28