About InPhonex  |  Personal  |  Business  |  Telecom  |  Resale  |  RingByName  
 
InPhonex Telecom
Services

Application Programming Interface (API)

 

 

An application programming interface (API) is an interface that a software implements in order to allow other software to interact with much in the same way that a user interface allows human to interact with it.

 

InPhonex Telecom had developed a complete API that permit our partners to connect their websites and other applications to our platform.  Through our API our partners can control nearly every aspect of our platform including:

 

Authorization
  • Login
  • Preferences
  
 
 
Call Detail Records
  • Listing of calls by type
 
Customer Accounts
  • Delete
  • Release
  • Suspend
  • Undelete
  • ANI Passthrough
  • AutoRecharge
  • Billing Address
  • Call Credit
  • Credit Card
  • DID
  • e911
  • Password
  • Payment
  • PayPal
  • Plan
  • Preferences
  • Rates
  • Shipping
  • Transfer Credit
  • Update
  • Virtual Number
 
DIDs
  • Connect
  • Get e911 Address
  • Update e911 Address
  • Update e911 As Foreign Address
  • Get Countries
  • Get Exchanges
  • Get Price
  • Get States
  • Preferences
     
Gateway
  • Insert
  • List
  • Remove
  • Preferences
  
     
LNP  
  • Electronic LOA Update
  • Get Info
  • Get List
  • Portability Check
  • Preferences
 
     
Product
  • List Categories
  • Get Customer Call Credits
  • Get List
  • Preferences
  
     
Reseller
  • Get AutoRecharge Preferences
  • Delete Billing Address
  • Get Default Billing Address Info
  • Inset Billing Address
  • List Billing Address
  • Update Billing Address
  • Update Default Billing Address
  • List Call Credit
  • Get Default Credit Card Info
  • Insert Credit Card
  • List Credit Cards
  • Update Credit Card
  • Update Default Credit Card
  • List Custom Dial Plan Details
  • List Custom Dial Plan
  • Get Info
  • List Payment Methods
  • Get Default Payment Method
  • Update Default Payment Method
  • Get PayPal Info
  • Update PayPal
  • Set Language Preferences
  • List Rate Tables
  • Delete Shipping Address
  • Get Shipping Address Info
  • Insert Shipping Address
  • List Shipping Address
  • Update Shipping Address
  • Update
     
Shopping
  • Get Account Info
  • Set Account Info
  • Get Billing Address
  • Set Billing Address
  • Unset Billing Address
  • Add Cart
  • Close Cart
  • Create Cart
  • Delete Cart
  • Cart Dependencies
  • Cart Exists
  • Get Cart
  • Update Cart
  • Validate Cart
  • Checkout
  • Validate Checkout
  • Get Content Comments
  • Set Content Comments
  • Get Credit Card Payment
  • Get Payment Method
  • List Payment Methods
  • Set Credit Card Payment
  • Set Payment Method
  • Set Language Preferences
  • Reset
  • Get Shipping Address
  • Get Shipping Method
  • List Shipping Methods
  • Required Shipping
  • Set Shipping Address
  • Set Shipping Method
  • Unset Shipping Address
  • Validate Shipping
  • Summary
  • Available Virtual Numbers
  • Virtual Number Suggestions
     
Utility
  • List Business Types
  • List Countries
  • List Languages
  • List Phone Companies
  • Set Language Preferences
  • List Time Zones
  
     
Virtual Number
  • Disable ANI Passthrough
  • Enable ANI Passthrough
  • Delete Pinless Calling Card
  • Insert Pinless Calling Card
  • List Pinless Calling Card
  • Update Calling Card PIN
  • Associate e911
  • Call Forward Busy
  • Call Forward
  • Get Forward Info
  • Delete Forward Match
  • Disable Forward Match
  • Enable Forward Match
  • Insert Forward Match
  • Update
  • Forward Match
  • Call Forward No Answer
  • Get Info
  • Insert
  • Move To Customer
  • Match Password
  • Set Language Preferences
  • List Rate Tables
  • Update

 

 

 

 

Example API Function

 

CallCreditList
Get a list of all customer's call credit


Parameters

  • StateId - String
    The StateId generated by the Auth service
  • CustomerId - Integer
    Customer Id


Example

<?php
    $Customer = new SoapClient( 'https://services.inphonex.com/0.11/soap/Accounts/Customer/Customer.php?wsdl' );
    $arr_parameters[ 'StateId' ] = '03b1479fc8e383ef6a159883aa39359ba58a479';
    $arr_parameters[ 'CustomerId' ] = '999999';
          
    try {
         $obj_return=$Customer->CallCreditList( $arr_parameters )->CallCreditListReturn;
         /**
         * Your code here
         */
    } catch (Exception $e) {
      echo $e->getMessage();
      exit;
    }
?>

 

Return


CallCreditsList
Return "(T) CallCreditsList"

 


<xs:complexType name="CallCreditsList">
<xs:sequence>
<xs:element name="call_credits" type="tns:CallCreditInfo" minOccurs="0" maxOccurs="unbounded" /> <!-- -->
</xs:sequence>
</xs:complexType>
<xs:complexType name="CallCreditInfo">
<xs:sequence>
<xs:element name="date_created" type="xs:string" minOccurs="" maxOccurs="" /> <!-- -->
<xs:element name="last_used" type="xs:string" minOccurs="" maxOccurs="" /> <!-- -->
<xs:element name="prepay_id" type="xs:int" minOccurs="" maxOccurs="" /> <!-- -->
<xs:element name="original_amount" type="xs:string" minOccurs="" maxOccurs="" /> <!-- -->
<xs:element name="remaining_amount" type="xs:string" minOccurs="" maxOccurs="" /> <!-- -->
<xs:element name="var_rate" type="xs:boolean" minOccurs="" maxOccurs="" /> <!-- -->
</xs:sequence>
</xs:complexType>