API

How to integrate API SMS HTTP Gateway to my website?

API SMSteroid allows developers to integrate SMS Gateway to any website. It is using HTTP GET and POST requests and you get XML documents back.

If you are interested to avail of this service please contact us for priceplan details with list of countries where you intend to use the service. You will be provided with API Key and additional instructions if required

Example URL: http://www.smsteroid.com/SendSMS.ashx

Implementation Guide

For sending SMS using API interface you need to send GET request with parameters:

  • code – API Access Key (supplied by Support Team).
    Mandatory.
  • number – SMS receiver’s phone number.
    Mandatory.
  • text – message text for sending in URL-encoded format.
    Mandatory.
  • addReplyTo – automaticlly adds text in the message with verified mobile number for reply: “Reply to [confirmed user phone number]”
    Flag options:

    • True – add text to the message “Reply to …”
    • False – no number will be added (anonymous option)

    Optional (Default option) - False.

  • lang – language used for added text “Reply to …”.
    Options available:

    • en – English
    • ru – Russian

    Optional. (Default option) - en.

  • enc – parameter encoding text.
    Parametres available:

    • utf-8
    • windows-1251
    • koi8-r
    • For reference on all other values listed in the field Name please see encoding table

    Optional (Default option) - utf-8.

In response the site creates XML-message eg.:

<?xml version="1.0" encoding="utf-8"?>
<SendSMS>
<status></status>
<error></error>
</SendSMS>

Element status contains result code.
Parameters available:

  • Success – SMS sent successfully.
    In this case in server response element <error> is absent.
  • GeneralError – An error has occurred.
    Element <error> contains an error description. HTTP Status Code response is set to 500.
  • ParameterMissing – Mandatory Request Parameter is Missing.
    Element <error> contains parameter name. HTTP Status Code response is set to 400.
  • AccessDenied – Restricted access Parameter code has invalid value code, or user is not allowed to use the service.
    HTTP Status Code response is set to 403.
  • NoSmsAvailable – Your account does not have SMS (contact Support for topping up your account).
    HTTP Status Code response is set to 403.
  • CountryIsNotPermited – Incorrect Country number this indicates that phone number belongs to the country which is not included in your priceplan.
    HTTP Status Code response is set to 403.