SMS Transactional

Taximail makes sending SMS easy. Using this API, you can send SMS messages with an option to generate a link and report webhook. On a successful request, it will return the remaining balance available for the user, the message price and the message count.

MSISDN means Mobile Station International Subscriber Directory Number and it's a number used to identify a phone number internationally. It is composed of the country code and the national destination's code. The MSISDN format will get rid of the + sign and of any 0 before the mobile number.

Sending

To send a new outgoing message to a number, you need to make an HTTP POST request to the following Taximail API.

POST https://api.taximail.com/v2/sms

The various parameters that are required for this request are:

Example Request

POST v2/sms HTTP/1.1
Host: api.taximail.com
Authorization: "Bearer YOUR_SESSION_ID"

from=TXSMS&to=66992345856&text=HelloUser&report_webhook=true&message_id=A45734&transactional_group_name=newsms&generate_link=true

Example Result

You will receive either a success data or error data which will be in JSON format.

{
    "status": "success",
    "code": 202,
    "data": {
        "message_id": "A45734",
        "remaining_balance": 129.94169,
        "message_price": 0.05831028006,
        "message_count": 1
    }
}

Fields

Response Code

Message status

• This Taximail API endpoint allows you to get the status of delivered transactional email to the recipient.
• You are required to send GET request to transactional/{message_id} API.
• Taximail API will return message status object such as email, ready time, sent time, open time and other.

GET https://api.taximail.com/v2/transactional/{message_id}

Example Request

GET v2/transactional/mid_0000001 HTTP/1.1
Host: api.taximail.com
Authorization: "Bearer YOUR_SESSION_ID"

Example Result

{
    "status": "success",
    "code": 200,
    "data": {
                "email": "john@example.com",
                "ready": "2016-01-07 10:13:15",
                "sent": "2016-01-07 10:13:19",
                "open": [
                      "2016-01-07 10:14:03"
                ],
                "open_count": 1,
                "click": [],
                "click_count": 0
       }
}

Fields

Response Code

Sending OTP

To send a new outgoing OTP message to a number, you need to make an HTTP POST request to the following Taximail API.

POST https://api.taximail.com/v2/otp

The various parameters that are required for this request are:

Example Request

POST v2/otp HTTP/1.1
Host: api.taximail.com
Authorization: "Bearer YOUR_SESSION_ID"

sms_template_key=54763bf8886e9b82&to=66992345856&report_webhook=true&generate_link=true

Example Result

You will receive either a success data or error data which will be in JSON format.

{
    "status": "success",
    "code": 202,
    "data": {
        "message_id": "63bf89390fe2f00008a236c3",
        "remaining_balance": 25269.87,
        "message_price": 0.19,
        "message_count": 1,
        "otp_ref_no": "PD1HBC"
    }
}

Fields

Response Code

Verify OTP

To verify OTP, you need to make an HTTP POST request to the following Taximail API.

GET https://api.taximail.com/v2/otp/verify/{message_id}

The various parameters that are required for this request are:

Example Request

GET v2/otp/verify HTTP/1.1
Host: api.taximail.com
Authorization: "Bearer YOUR_SESSION_ID"

message_id=54763bf8886e9b82&to=66992345856&otp_code=9999

Example Result

You will receive either a success data or error data which will be in JSON format.

{
    "status": "success",
    "code": 202,
    "data": {}
}

Fields

Response Code

Multipart SMS messages

If the message length sent through SMS API, exceeds the SMS character limit of 160 characters in the case of 7bit encoding (or 70 characters for UCS-2 encoding), the message will split to multiple separate SMS and sent to the sender separately.

For messages on the phone, a special header (UDH) is set for each message, it states the order and message each part belongs to. This special UDH shortens the length of each combined 7-bit message to 153 characters (67 characters for UCS-2).

GSM Encoding : The Latin-based languages such as Chinese, Spanish, and Greek use GSM character encoding. Each GSM character accounts for 7 bits, thus allowing a maximum of 160 characters per SMS. The Languages not based on Latin use a different encoding process called Unicode. It is commonly known as Unicode Transformation Format (UTF-16).

Unicode Encoding : Each UTF-16 character accounts for 16 bits per character, it allows a maximum of 70 characters per text. Depending on how many UTF-16 characters are used, this will make a small change on the final character count.

It's important to use this calculator and make sure that you don't exceed the limit and pay more than you planned.