Skip to content

Introduction ​

The SMSUP Plus API lets your system send SMS and OTP and manage recipient data directly over HTTPS. This page covers the overview, request/response conventions and your first request.

What the API offers ​

GroupPathPurpose
SMS/sms/send, /sms/preview, /sms/senderlist, /sms/loginfoSend SMS, calculate credit before sending, list approved sender names, search send history
OTP/OTP/requestotp, /OTP/verifyotp, /OTP/resendotpSend an OTP, verify it, resend it
URL Shortener/shorten/create, /shorten/list, /shorten/stats/:code, /s/:codeCreate short links, list them and view click stats
Contacts/Person/...Create/update/delete/search contacts and their destinations
Tags/Tag/...Group contacts with tags
Blacklist/Blacklist/...Manage numbers that must not be messaged
Consent/Consent/...Record and check consent (PDPA)
LINE/line/send, /line/dashboardSend messages through LINE tokens configured on your account
CallbacknotifyUrl in /sms/sendReceive delivery status (Delivery Report)

Base URL ​

http
https://public-api.smsup-plus.com

Every endpoint uses HTTPS and requires authentication (except the /s/:code redirect). See Authentication.

Request / Response conventions ​

TopicDetails
Request bodyPOST endpoints take JSON — send Content-Type: application/json
Query / PathGET endpoints take query-string or path values, e.g. /sms/loginfo?bulkId=..., /Consent/checkconsent/{mobile}
ResponseJSON (UTF-8) on every endpoint except /s/:code, which answers an HTTP 302 redirect
Path casePaths are case-sensitive (/OTP/..., /Person/... must be written as documented)
Thai textSend as plain UTF-8, no extra encoding needed

Phone numbers (SMS / OTP) ​

The system strips every non-digit character, then converts the number to 66XXXXXXXXX.

InputAfter normalisationResult
081234567866812345678Accepted
+66 81-234-567866812345678Accepted
6681234567866812345678Accepted
812345678 (9 digits)66812345678Accepted
02123456662123456Rejected (must be 11 digits starting with 66)

A rejected number is answered REJECTED in that number's result and is neither sent nor charged.

TIP

The Blacklist and Consent APIs use their own number check (spaces, dashes and parentheses removed, 10–15 digits). See each endpoint page.

Message length and credit ​

Message type1 creditLong message (per credit)
Contains non-ASCII characters (e.g. Thai)Up to 70 characters67 characters (71–134 characters = 2 credits)
ASCII onlyUp to 160 characters153 characters (161–306 characters = 2 credits)

Maximum message length is 1,600 characters and at most 1,000 destinations per request. Use /sms/preview to calculate credit before sending.

Quick start ​

  1. Sign in to the customer portal and create an API key in the customer portal.
  2. Copy the key starting with smsk_ and store it safely (the full key is shown only once).
  3. Make sure your sender name is approved — check with GET /sms/senderlist.
  4. Send your first request as shown below.

First request: send an SMS ​

bash
curl -X POST 'https://public-api.smsup-plus.com/sms/send' \
  -H 'Authorization: Bearer <API_KEY>' \
  -H 'Content-Type: application/json' \
  -d '{
    "messages": [
      {
        "from": "MYBRAND",
        "destinations": [{ "to": "0812345678" }],
        "text": "Hello from SMSUP Plus"
      }
    ]
  }'
js
const res = await fetch('https://public-api.smsup-plus.com/sms/send', {
  method: 'POST',
  headers: { Authorization: 'Bearer <API_KEY>', 'Content-Type': 'application/json' },
  body: JSON.stringify({
    messages: [
      { from: 'MYBRAND', destinations: [{ to: '0812345678' }], text: 'Hello from SMSUP Plus' },
    ],
  }),
})
console.log(await res.json())

Successful response (HTTP 200):

json
{
  "bulkId": "6f1c2a8e-1b7a-4c35-9d0e-2b8f6f3e9a11",
  "details": [
    {
      "messageId": "0b7e4d0c-5a3f-4f0e-8a51-4e2d9c7b1f20",
      "mobile": "66812345678",
      "to": "66812345678",
      "from": "MYBRAND",
      "credit": "1.00",
      "shorturl": "N",
      "status": {
        "code": "101",
        "name": "PENDING",
        "description": "Pending -Message has been accepted by the system"
      }
    }
  ]
}

PENDING means the message was accepted into the queue. Track delivery with the Delivery Report callback or /sms/loginfo.

Next steps ​