API OVERVIEW

API’s are built with REST standard that allows you to easily send messages to your end users and make your work easy. You can send alerts, reminders, and notifications, or you can send verification messages containing one-time passcodes (OTP) using this feature of ours.

This documentation gives you instructions on how to integrate our api through various HTTP API and JSON API.

We’ll be helping you configure access and use the API for SMS.

To integrate our SMS API, any HTTP recipient in any programming language can be used.

API Endpoint

http://alerts.twinclescpaas.co.in/api/v2/

Note: Few elements in endpoint may change for service to service.

AUTHENTICATION

Each API request will have to contain request headers that include your access token to authenticate the request.

Don’t have an access token? You will find your access token in the Developers -> API Keys/Access Tokens in menu bar.

When your application can’t send an Authorization header, you can use the GET parameter access token to provide your access key.

We do provide incoming request whitelisting on our platform for our REST API. You can whitelist the IP addresses while generating the access token.

CURL Example

$ curl {endpoint}account/balance \
-H ‘Authorization: Bearer 38e896f55670311982434e929559xxxx’ \
-H ‘Accept: application/json’

GET Example

$ curl {endpoint}account/balance?access_token=38e896f55670311982434e92955xxxx \
-H ‘Accept: application/json’

If possible, please use the Authorization
header.

RATE LIMITS

To keep you in compliance, We maintains the appropriate rate limits:

You can contact our support team to increase the limit. Our team will increase the limit case by case.

ERROR CODES

We uses standard HTTP status codes to indicate success or failure of an API request. Codes in the 2xx range indicate that a request was successfully processed and codes in the 4xx range indicate that there was an error that resulted from the information sent (e.g. authentication, no balance or a missing or wrong parameter).

In case of an error, the body of the response includes a JSON formatted response that tells you exactly what is wrong.

ATTRIBUTES

HTTP STATUS CODES