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). Give your web site visitors a way to contact you for free. All APIs use HTTPS POST method to submit request data. Do not use API usage examples in the production environment because username and password parameters will be visible to everybody in html 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 values for username and password and open the file in web browser. Username and password API parameters are your 9 digits user name and web UI password.

Get account balance
Get calling rates
Web callback
Get call history
Get DID usage

Get account balance.

URI: https://www.callwithus.com/api/account/

Parameters:

• username
• password

Usage example:

<form method="post" action="https://www.callwithus.com/api/account/">
<input type="hidden" name="username" value="123456789">
<input type="hidden" name="password" value="123456">
<input type="submit">
</form>

Return value: string credit=value in USD.

Errors:

• -1000 - invalid user name or password.

Get calling rates.

URI: https://www.callwithus.com/api/getrate/

Parameters:

• username
• password
• number

Usage example:

<form method="post" action="https://www.callwithus.com/api/getrate/">
<input type="hidden" name="username" value="123456789">
<input type="hidden" name="password" value="123456">
<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:

• -1000 - invalid user name or password.
• -1001 - number is not specified in the request
• -1002 - number is not valid

Web callback.

URI: https://www.callwithus.com/api/callback/

Parameters:

• username
• password
• called - first call leg number
• calling - second call leg number
• timeout - (optional) first call leg timeout (seconds)
• reverse - (optional) call "calling" number first
• maxtime - (optional, >= 60) limit call duration to maxtime seconds

Usage example:

<form method="post" action="https://www.callwithus.com/api/callback/">
<input type="hidden" name="username" value="123456789">
<input type="hidden" name="password" value="123456">
<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="20">
<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:

• -1000 - invalid user name or password.
• -1001 - called number is not specified in the request
• -1002 - calling number is not specified in the request
• -1003 - called number is not valid
• -1004 - call to user number failed
• -1005 - callback is blocked because you have low balance on your account

Note: both numbers must start with country code, it is your web software responsibility to check the number entered by user and to block calls to the destinations you do not want to allow.

Get call history.

URI: https://www.callwithus.com/api/callhistory/

Parameters:

• username
• password
• start
• end

"Start" and "end" parameters format is "YYYY-MM-DD[ HH:MM:SS]". If "start" or "end" parameters are missed or the value is not provided, the parameter defaults to the current day. The API takes into account your time zone setting.

Usage example:

<form method="post" action="https://www.callwithus.com/api/callhistory/">
<input type="hidden" name="username" value="123456789">
<input type="hidden" name="password" value="123456">
<input type="text" name="start">
<input type="text" name="end">
<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"

Errors:

• -1000 - invalid user name or password.
• -1001 - there are no calls in the specified time period.

Get DID usage.

URI: https://www.callwithus.com/api/getdidminutes/

Parameters:

• username
• password
• did

Usage example:

<form method="post" action="https://www.callwithus.com/api/getdidminutes/">
<input type="hidden" name="username" value="123456789">
<input type="hidden" name="password" value="123456">
<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:

• -1000 - invalid user name or password.
• -1001 - the DID "did" has not been set up on your account.