Labspace SMS

API 文件

RESTful API，JSON 格式，Bearer Token 認證

快速開始

1. Base URL

https://sms-api.labspace.com.tw

2. 認證方式

Authorization: Bearer {your_api_key}
Content-Type: application/json

3. 發送簡訊範例

cURL

curl -X POST /api/v2/send \
  -H "Authorization: Bearer sk_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "dstaddr": "0912345678, 8613912345678",
    "smbody": "您的驗證碼為 123456"
  }'

回應

{
  "result": 1,
  "text": "群發完成：成功 2，失敗 0",
  "data": {
    "total": 2,
    "sent": 2,
    "failed": 0,
    "points_remaining": 98,
    "results": [
      { "phone": "0912345678", "status": "success" },
      { "phone": "8613912345678", "status": "success" }
    ]
  }
}

4. 號碼格式

dstaddr 僅允許數字、+、逗號、空格；多筆號碼用逗號或空格分隔。

類型格式範例
台灣手機（推薦）09xxxxxxxx0912345678
台灣國際8869xxxxxxxx886912345678
中國手機1[3-9]xxxxxxxxx / 8613xxxxxxxxx13912345678
其他海外必須含國碼（不含 +），符合 E.16414155552671

海外號碼必須含國碼，否則無法送達

常見國碼：886（台灣）、86（中國）、1（美/加）、81（日本）、82（韓國）、65（新加坡）、66（泰國）、84（越南）、852（香港）、44（英國）

ERR_INVALID_NUMBER：號碼通過格式檢查但實際無效（缺一碼、開頭 1 但非 11 碼、開頭 0 但非 09 等），send_log 標示此錯誤、status=0、不扣點。

API Playground

輸入 API Key，選擇端點，即時測試 API 回應

POST/api/v2/send
cURL 指令
curl -X POST "https://sms-api.labspace.com.tw/api/v2/send" \
  -H "Authorization: Bearer {your_api_key}" \
  -H "Content-Type: application/json" \
  -d '{ "dstaddr": "0912345678, 8613912345678", "smbody": "您的驗證碼為 123456"}'

API 端點總覽

認證

POST
/api/v2/auth/login

登入取得 JWT Token

POST
/api/v2/auth/refresh

續約 Token（httpOnly cookie）

POST
/api/v2/auth/logout

登出

發送簡訊

POST
/api/v2/send

發送簡訊

POST
/api/v2/send/estimate

預估費用（不實際發送）

POST
/api/v2/send/bulk-upload

上傳 CSV 批次發送

multipart/form-data

POST
/api/v2/send/bulk-preview

預覽批次發送結果

POST
/api/v2/send/bulk

確認批次發送

批次發送的 CSV 範本（含台灣 / 海外國碼示範與變數欄位）： CSV / XLSX

發送記錄

GET
/api/v2/logs?page=1&per_page=20&status=&start_date=&end_date=

發送記錄列表（分頁）

GET
/api/v2/logs/{id}

單筆記錄詳情

GET
/api/v2/logs/export

匯出 CSV

帳號

GET
/api/v2/me

個人資料 + 餘額

PUT
/api/v2/me/password

修改密碼

GET
/api/v2/dashboard

儀表板統計

GET
/api/v2/dashboard/stats?range=7d

圖表統計

API Key

GET
/api/v2/api-keys

API Key 列表

POST
/api/v2/api-keys

建立 API Key

DELETE
/api/v2/api-keys/{id}

撤銷 API Key

通訊錄

GET
/api/v2/contacts?page=1&search=&group_id=

聯絡人列表

POST
/api/v2/contacts

新增聯絡人

PUT
/api/v2/contacts/{id}

編輯聯絡人

DELETE
/api/v2/contacts/{id}

刪除聯絡人

GET
/api/v2/contact-groups

群組列表

POST
/api/v2/contact-groups

建立群組

訊息範本

GET
/api/v2/templates

範本列表（含系統預設）

POST
/api/v2/templates

新增範本

PUT
/api/v2/templates/{id}

編輯範本

DELETE
/api/v2/templates/{id}

刪除範本

儲值

GET
/api/v2/topup/packages

點數方案列表

POST
/api/v2/topup/order

建立儲值訂單

GET
/api/v2/topup/history?page=1

儲值記錄

GET
/api/v2/topup/export

儲值記錄 CSV 匯出

HTTP 狀態碼

Code說明
200成功
201建立成功
401未認證 / Token 無效或過期
403帳號待審核 / 已停用
404資源不存在
422驗證錯誤（欄位格式不正確）
429請求過於頻繁
500伺服器錯誤

速率限制

API 請求限制為每分鐘 60 次。超過限制將回傳 HTTP 429。 回應 Header 包含：

X-RateLimit-Limit: 60
X-RateLimit-Remaining: 58

需要更詳細的 API 文件或串接協助？請聯絡我們