SMS Campaign

SMS Marketing is sending promotional broadcast or transactional messages for marketing purposes to your contact lists through SMS.

You can automate workflows for effective communications like time-sensitive offers, updates and alerts to the people of have consented to receive messages from your business.

Here are the advantages of sending SMS Campaigns:

It builds customer loyalty, nurtures leads, and increases direct sales. It improves brand awareness every time a recipient clicks on your sms. It automates sending bulk sms which are time-consuming processes. You can also observe in real time how the SMS campaign is performing.

If you’re not using campaign in your sms marketing efforts, you’re undermining your campaign’s full potential. The following description will help you get a better understanding of some of the functionalities.

Showing

• This API endpoint allows you to get all campaign list.
• You can send GET request and campaign filter to /campaign API.
• Taximail API will return all campaign list such as campaign_count and an array of campaigns data.

GET https://api.taximail.com/v2/campaign

Example Request

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

Example Result

{
    "status": "success",
    "code": 200,
    "data": {
              "campaign_count": 3,
              "max_page": 1,
              "campaigns": [
                    {
                          "campaign_id": 1620,
                          "campaign_status": "Sent",
                          "campaign_name": "My Campaign A",
                          "ab_mode": "F",
                          "email_id": 1764,
                          "date_time": "2015-12-08 11:48:04",
                          "sent_count": 2000,
                          "preview_campaign": "http://corporate-name.th.listmng.com/b/16/1620",
                          "opened": 20
                    },
                    {
                          "campaign_id": 1621,
                          "campaign_status": "Sent",
                          "campaign_name": "My Campaign B",
                          "ab_mode": "F",
                          "email_id": 1765,
                          "date_time": "2015-12-08 11:48:04",
                          "sent_count": 3000,
                          "preview_campaign": "http://corporate-name.th.listmng.com/b/16/1621",
                          "opened": 20
                    },
                    {
                          "campaign_id": 1622,
                          "campaign_status": "Sent",
                          "campaign_name": "My Campaign C",
                          "ab_mode": "F",
                          "email_id": 1766,
                          "date_time": "2015-12-08 11:48:04",
                          "sent_count": 10000,
                          "preview_campaign": "http://corporate-name.th.listmng.com/b/16/1622",
                          "opened": 20
                    }
              ]
        }
}

Fields

Response Code

Creating

• This API endpoint allows you to create a new campaign.
• You can send POST request to /campaign API.
• Taximail API will return the new campaign_id and new email_id.

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

Example Request

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

campaign_name=example
campaign_mode=sms

Example Result

{
    "status": "success",
    "code": 201,
    "data": {
              "campaign_id": 315,
              "sms_content_id": 123
       }
}

Fields

Response Code

Campaign detail

• This API endpoint allows you to get campaign's detail.
• You can send GET request to campaign/{campaign_id} API.
• Taximail API will return campaign object such as campaign_trigger_type , campaign_name , campaign_info_status , custom_campaign_trigger and etc.

GET https://api.taximail.com/v2/campaign/{campaign_id}

Example Request

GET v2/campaign/315 HTTP/1.1
Host: api.taximail.com
Authorization: "Bearer YOUR_SESSION_ID"

Example Result

{
    "status": "success",
    "code": 200,
    "data": {
              "campaign_trigger_type": "default",
              "campaign_ref_tag": "campaign_a",
              "custom_campaign_trigger": {
                     "campaign_trigger_open_click": "none",
                     "campaign_trigger_bounce": "",
                     "campaign_trigger_drop": "",
                     "campaign_endpoint_url": "",
                     "campaign_trigger_format": "json"
              },
              "split_testing": "F",
              "split_test_status": "F",
              "campaign_name": "Campaign A",
              "campaign_status": "Sent",
              "send_mode": "Immediate",
              "campaign_info_status": "Sent"
       }
}

Fields

Response Code

Updating

• This API endpoint, allows you to update a campaign.
• You can PUT the object data such as campaign_name , campaign_status and other to campaign/{campaign_id} API.

PUT https://api.taximail.com/v2/campaign/{campaign_id}

Example Request

PUT v2/campaign/315 HTTP/1.1
Host: api.taximail.com
Authorization: "Bearer YOUR_SESSION_ID"

campaign_name=MyCampaign&campaign_status=Ready&high_priority=false&lists_and_segments=191%3A0&schedule_type=Future&send_date=2016-12-30&send_time=13%3A00%3A00&trigger_type=custom&trigger_format=json&trigger_open_click=unique&trigger_url=https%3A%2F%2Fmy.webservice.com%2Fcallback_trigger&campaign_ref_tag=my_campaign&enable_google_analytics=false

Example Result

{
  "status": "success",
  "code": 200
}

Fields

Response Code

Deleting

• This API endpoint, allows you to delete a campaign.
• You can send a DELETE request to campaign/{campaign_id} API.
• Here, the campaign is deleted one by one.

DELETE https://api.taximail.com/v2/campaign/{campaign_id}

Example Request

DELETE v2/campaign/315 HTTP/1.1
Host: api.taximail.com
Authorization: "Bearer YOUR_SESSION_ID"

Example Result

{
    "status": "success",
    "code": 200
}

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.