ClockWise SMS

ClockWise SMS API Documentation

ClockWise SMS is a standard JSON REST API. You can find code examples for many lanugages on our website or in the Dashboard under the API section (login required).

Authentication

Authentication is based on a basic API key you can find under the API section in the Dashboard. The API key is sent in a custom HTTP header named

x-api-key

.

API keys are strictly for server-side use only and should always be kept secret. You can delete old and create new API keys using the Dashboard.

Base URL

https://api.cwsms.com

Note: HTTPS is required in order to use the API.

HTTP Request Example

            
POST /send/sms HTTP/1.1
Host: api.cwsms.com
Accept: application/json, text/javascript
Content-Type: application/json
x-api-key: ...

{ "sender": "SenderName", "message": "Hello world!", "recipients": [ "4712345678", ... ] }

Send SMS

POST /send/sms

Note:
GET
is also supported for this endpoint.

Header	Type		Description
content-type	String	(Required)	application/json
x-api-key	String	(Required)	A valid ClockWise SMS API key. YYour API keys are located under the API section in to the Dashboard (login required).
Parameter	Type		Description
sender	String	(Required)	An alphanumeric Sender ID, maximum 11 characters.
message	String	(Required)	The contents of the SMS message. The SMS will be automatically converted to a unicode message if a unicode character is discovered.
recipients	Array of strings	(Required)	A list of phone numbers in MSISDN format, e.g. ["4712345678", "4787654321"] . There is a limit of 1000 phone numbers per request.
class	String	(Optional)	The SMS message class. This can either be Standard or Premium . Default: Standard
encoding	String	(Optional)	The message character encoding. This can either be UTF8 or UCS2 (Unicode). Default: UTF8

SMS Credit balance

GET /credit/balance

Header	Type		Description
x-api-key	String	(Optional)	A valid ClockWise SMS API key. Your API keys are located under the API section in to the Dashboard (login required). NOTE! If this header is is not present, the apikey parameter is required .
Parameter	Type		Description
apikey	String	(Optional)	A valid ClockWise SMS API key. Your API keys are located under the API section in to the Dashboard (login required). NOTE! If this parameter is not present, the x-api-key header is required ..