Clockwork SMS API
Documentation
Everything you need to know

Receive SMS via HTTP

Our API will forward each incoming message to a server of your choosing by making a simple HTTP GET or POST request. All the parameters will be URL-Encoded UTF-8 text. Your server needs to respond with a 200 OK status code to acknowledge receipt of the message, otherwise the API will retry at regular intervals.

Parameters

to

Your Clockwork mobile number or shortcode

from

Phone number that sent the message, this will be in international format e.g. 441625588620.

content

Text of the message

id

Unique ID Clockwork assigned to the message, use this if you want to raise a query and to make sure you don’t receive any duplicates.

keyword

If you’re using a shared shortcode we’ll pass across the keyword that was matched. For dedicated numbers this isn’t used.

Example URL

http://www.example.com/receive-sms?id=AB_12345&to=84433&from=441234567890&keyword=hello&content=Hello+World

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