<CallStatus>
This parameter indicates the current or past status of your call. The possible values are:
<CallStatus> |
<CallStatusDescription> |
1 |
Call in process |
10 |
Call successful |
73 |
** Missing parameter (AID) *** |
74 |
*** Missing parameter (UID) *** |
80 |
Could not validate your account. Check the (AID) and/or (UID) input parameters |
81 |
*** Call ID is not valid *** |
82 |
*** CallKey is not valid *** |
83 |
*** CallID and CallKey combination are not valid *** |
90 |
Not enough funds to place this call |
93 |
User hanged up |
94 |
Invalid phone number |
95 |
Call answered. User did not perform any action |
96 |
Pound key confirmation failed |
97 |
User answered the phone. User side timeout |
98 |
Call not answered |
99 |
Failed to connect |
Notice that some of the status codes in the RequestStatus.Netiden API are the same than the status codes of the PlaceCall.Netiden API.
<CallStatusDescription>
The description of the status code provided in the <CallStatus> parameter (see the table above).
<CountryCode>
The country code used to place the phone call.
<PhoneNumber>
The phone number at which the user requested the phone call.
<Destination>
The destination country (this parameter may also include the city and the type of call, as Mobile, Satellite, etc).
<CallType>
Returns the value of the CallType variable entered in the PlaceCall.Netiden API.
<PIN>
Returns the value of the PIN variable entered in the PlaceCall.Netiden API.
<PINentered>
Returns the value of the PIN entered by the user. This parameter will be PINentered=Null if the CallType variable is different than 2.
It only works for CallType=2.
<PINmatch>
Returns True or False.
If CallType=2 and <PIN> = <PINentered>, then <PINmatch>=True, else <PINmatch>=false
<PoundPressed>
Returns True or false.
This parameter returns Null by default if CallType is different than 3 or 4.
It indicates, on a CallType=3 or CallType=4, whether the end user pressed the pound (#) key to confirm a change of password (CallType=3) or to access their account (CallType=4).
<DateTime>
The date and time for the verification call (US Eastern Time).
<CostUSD>
This parameter indicates your cost for the call. It is a decimal number and expresses the amount in USD.
For example: 0.12 equals to 12 cents.
<Credit_Left>
The amount of money left in your Net-Iden account, expressed in US Dollars.
<CallID>
This parameter indicates the ID for the call.
<CallKey>
This parameter indicates the Key for the call. It is the one you used to call the RequestStatus.Netiden API.
<NetIdenID>
The Net-Iden ID for the call.
<IP>
This is the IP address number you passed to the PlaceCall.Netiden API.
<IP_CountryCode>
The country code (ISO 3166) for the <IP> parameter.
<IP_CountryName>
The country name for the <IP> parameter.
<IP_Region>
The region/state/province for the <IP> parameter.
<IP_City>
The city for the <IP> parameter.
<IP_Latitude>
The latitude for the <IP> parameter.
<IP_Longitude>
The longitude for the <IP> parameter.
<IP_ISP>
The user's Internet Service Provider.
ASP 3.0 implementation example:
<%
dim oHttp
dim xmldom
dim txtRequestString
dim result
set oHttp = CreateObject("MSXML2.XMLHTTP")
set xmldom = CreateObject("msxml2.domdocument")
'THIS EXAMPLE SETS THE VARIABLES TO BE USED IN THE REQUEST STRING
Input_AID="387DJSFJK3289324N"
Input_UID="3458473NCYNIWUYNI345"
Input_Callid="25694"
Input_CallKey="893jdfso84j354g54jui32434823h34f5665"
'DEFINES THE REQUEST STRING VARIABLE
txtRequestString = "http://soap.netiden.com/RequestStatus.netiden?"
txtRequestString = txtRequestString & "AID=" & Input_AID & "&"
txtRequestString = txtRequestString & "UID=" & Input_UID & "&"
txtRequestString = txtRequestString & "UID=" & Input_Callid& "&"
txtRequestString = txtRequestString & "UID=" & Input_CallKey
'CALLS THE NETIDEN API
oHttp.open "GET",txtRequestString , false
oHttp.send
xmldom.async =false
xmldom.loadXML (oHttp.responseText)
If (xmldom.parseError.errorCode <> 0) Then
Dim myErr
Set myErr = xmldom.parseError
Else
For i=0 to xmldom.documentElement.childNodes.length-1
Set currNode = xmldom.documentElement.childNodes.Item(i)
Select Case currNode.nodeName
case "CallStatus"
CallStatus=currNode.nodeTypedValue
case "CallStatusDescription"
CallStatusDescription=currNode.nodeTypedValue
case "CountryCode"
CountryCode=currNode.nodeTypedValue
case "CallKey"
CallKey=currNode.nodeTypedValue
case "PhoneNumber"
PhoneNumber=currNode.nodeTypedValue
case "Destination"
Destination=currNode.nodeTypedValue
case "CallType"
CallType=currNode.nodeTypedValue
case "PIN"
PIN=currNode.nodeTypedValue
case "PINentered"
PINentered=currNode.nodeTypedValue
case "PINmatch"
PINmatch=currNode.nodeTypedValue
case "DateTime"
DateTime=currNode.nodeTypedValue
case "CostUSD"
CostUSD=currNode.nodeTypedValue
case "NetIdenID"
NetIdenID=currNode.nodeTypedValue
case "PoundPressed"
PoundPressed=currNode.nodeTypedValue
case "YourTransactionID"
YourTransactionID=currNode.nodeTypedValue
case "IP"
IP=currNode.nodeTypedValue
case "IP_CountryCode"
IP_CountryCode=currNode.nodeTypedValue
case "IP_CountryName"
IP_CountryName=currNode.nodeTypedValue
case "IP_Region"
IP_Region=currNode.nodeTypedValue
case "IP_City"
IP_City=currNode.nodeTypedValue
case "IP_Latitude"
IP_Latitude=currNode.nodeTypedValue
case "IP_Longitude"
IP_Longitude=currNode.nodeTypedValue
case "IP_ISP"
IP_ISP=currNode.nodeTypedValue
End Select
Next
End If
%>
We recommend that you check this API every 3 seconds, until the status of the call is different than 1 (Call in process):
<script language="javascript" type="text/javascript">setTimeout("location.reload();",3000);</script>
|
