Clockwork SMS API
Documentation
Everything you need to know

Check your credit via HTTP

Check how much credit you have left on your account.

https://api.clockworksms.com/http/balance

Parameters

Key

Your API key, available from your API account.

API Response

A successful call will return the balance on your account and the three letter currency code.

Invoice account customers

If we invoice you at the end of each month, the balance API call will instead return the amount you’ve spent so far this calendar month.

Response

Balance: 287.58 (GBP)

If you get the username or password wrong we’ll reply

Error

Error 58: Invalid API Key

Example

Request

https://api.clockworksms.com/http/balance?key=KEY

Response

Balance: 287.58 (GBP)

Code Wrappers

  • C# wrapper
  • Java wrapper
  • Node.js Wrapper
  • PHP Wrapper
  • Python Wrapper
  • Ruby gem
  • VB.NET wrapper

Email Interface

  • Send SMS via email

HTTP Interface

  • Check your credit via HTTP
  • SMS Delivery Receipts via HTTP
  • Receive SMS via HTTP
  • Send SMS via HTTP

XML Interface

  • Check your credit using XML
  • SMS Delivery Receipts in XML
  • Receive SMS in XML
  • Send SMS using XML

Reference

  • API Error Codes
  • Delivery States
  • GSM Character set