API 文件
RESTful API，JSON 格式，Bearer Token 認證
快速開始
1. Base URL
https://sms-api.labspace.com.tw
2. 認證方式
Authorization: Bearer {your_api_key}
Content-Type: application/json3. 發送簡訊範例
cURL
curl -X POST /api/v2/send \
-H "Authorization: Bearer sk_live_..." \
-H "Content-Type: application/json" \
-d '{
"dstaddr": "0912345678",
"smbody": "您的驗證碼為 123456"
}'回應
{
"result": 1,
"data": {
"msgid": "SMS20260328001",
"phone": "0912345678",
"status": "sent",
"sms_count": 1,
"points_used": 1
}
}API Playground
輸入 API Key，選擇端點，即時測試 API 回應
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確認批次發送
發送記錄
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-keysAPI 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 文件或串接協助？請聯絡我們