CallWithUs and Save! Low rate SIP and calling card calls
![]() | Home | Sign Up | My Account | FAQ | Contact Us | About Us |
Services | Configuration | A-Z Rates | Available DIDs | API |
![]()
We provide a web-based API to check your account balance, get calling rate(s) to a specified phone number, call
history, DID minutes information
and to initiate a web callback to the specified phone number (Click to call). With this, you can give your web
site visitors a free way to
contact you. All APIs use HTTP(S) POST or GET method to submit request data. Do not use the API usage
examples in the production environment because key parameter will be visible to
everybody in html source code. Use PHP/Perl/Ruby, etc. scripts instead to invoke the API. To try the examples,
copy/paste the HTML code to a local file, set value for key parameter and open the file in a
web browser.
The key parameter value is shown on "Account info" when you log into your account.
Get account balance Get calling rates Web callback Get call history Get DID usage LRN lookup CNAM lookup Get account balance.URI: https://api.callwithus.com/api/account/Parameters:
<form method="post" action="https://api.callwithus.com/api/account/"> <input type="hidden" name="key" value="apikey"> <input type="submit"> </form>Return value: string credit=value in USD. Errors:
Get calling rates.URI: https://api.callwithus.com/api/getrate/Parameters:
<form method="post" action="https://api.callwithus.com/api/getrate/"> <input type="hidden" name="key" value="apikey"> <input type="text" name="number"> <input type="submit"> </form>Return value: string rate=value1 value2 value3 returns a space-separated list of rates in USD for each available route according to your service plan. Errors:
Web callback.URI: https://www.callwithus.com/api/callback/Parameters:
<form method="post" action="https://www.callwithus.com/api/callback/"> <input type="hidden" name="key" value="apikey"> <input type="text" name="called"> <!-- user enters his phone number here --> <input type="hidden" name="calling" value="your phone number"> <input type="hidden" name="timeout" value="30"> <input type="hidden" name="maxtime" value="300"> <input type="submit"> </form>Return value: phone number entered by user, API returns when the user answers incoming call. Errors:
Get call history.URI: https://api.callwithus.com/api/callhistory/Parameters:
Usage example: <form method="post" action="https://api.callwithus.com/api/callhistory/"> <input type="hidden" name="key" value="apikey"> <input type="text" name="start"> <input type="text" name="end"> <input type="hidden" name="html" value="yes"> <input type="submit"> </form>Return value: new line separated CDR records in format "call date/time","call lenght","call from", "call to", "destination name", "terminate cause", "rate", "price", "IP address", "Trunk" or html table if "html" parameter is set to "yes". Errors:
Get DID usage.URI: https://www.callwithus.com/api/getdidminutes/Parameters:
<form method="post" action="https://www.callwithus.com/api/getdidminutes/"> <input type="hidden" name="key" value="apikey"> <input type="text" name="did"> <input type="submit"> </form>Return value: line with the following values: "DID","free minutes","used minutes","minute price","monthly price","DID setup date" Errors:
LRN lookup.LRN lookup service is not free. Your account will be charged $0.0003 per query. If the requested number is a not valid US/Canada number (-1003 error code), your account will be charged $0.0001.URI: http://lrn.callwithus.com/api/lrn/index.php Parameters:
<form method="post" action="http://lrn.callwithus.com/api/lrn/index.php"> <input type="hidden" name="key" value="apikey"> <input type="hidden" name="ei"> <input type="text" name="number"> <input type="submit"> </form>Return value: the LRN of the queried number. If the number has not been ported, the API will return the queried number. If extra number info was requested, the return value is comma separated string in the following format: LRN,State,Ratecenter,LATA,OCN,Company,Prefix_Type,CLLI The possible values for Prefix_Type result are
Errors:
CNAM lookup.CNAM lookup service is not free. Your account will be charged $0.006 per query. If the requested number is a not valid US/Canada number (-1003 error code), your account will be charged $0.001.URI: http://lrn.callwithus.com/api/cnam/index.php Parameters:
<form method="post" action="http://lrn.callwithus.com/api/cnam/index.php"> <input type="hidden" name="key" value="apikey"> <input type="text" name="number"> <input type="submit"> </form>Return value: the caller id name of the queried number. Errors:
|