平台 API
透過 ChatBooster 平台 API,你可以從自己的系統(CRM、電商後台、會員系統等)建立和更新聯絡人、查詢聯絡人,以及向聯絡人發送 WhatsApp 訊息。
目前提供以下接口:
| 接口 | 方法與路徑 | 用途 |
|---|---|---|
| 建立或更新聯絡人 | POST /v2/contact/createOrUpdate | 以電話號碼建立聯絡人,或更新現有聯絡人的資料、標籤、列表與自訂欄位 |
| 查詢聯絡人列表 | POST /v1/contact/list | 按標籤、列表、頻道、電話、電郵、更新時間或自訂欄位篩選聯絡人 |
| 發送訊息給聯絡人 | POST /communicateSrvCloudAPI/message/v1/sendToContact | 向指定聯絡人發送文字、圖片、影片或檔案 |
適用範圍
平台 API 目前僅支援 WhatsApp 頻道的聯絡人。
事前準備
- 你的工作區方案需包含「平台 API」功能。
- 工作區已接入至少一個 WhatsApp 頻道。
取得 API key
- 登入 ChatBooster,進入 設定 → 平台 API。
- 點選複製圖示複製 API key。
每個工作區只有一組 API key。點選 重新生成 API key 後,舊的 API key 會立即失效,所有使用舊 key 的呼叫都會失敗,此操作無法復原。
請妥善保管 API key
API key 等同於工作區的存取權限。請只在伺服器端使用,不要放進網頁前端、行動 App 或公開的程式碼倉庫。
呼叫方式
Base URL
https://api.chatbooster.ai請求標頭
| 標頭 | 值 |
|---|---|
Authorization | 你的 API key(直接填入,不需要加 Bearer 前綴) |
Content-Type | application/json |
所有接口都使用 POST,請求與回應內容皆為 JSON。
回應格式
所有接口都會回傳 Code 與 Message。請以回應內容中的 Code 判斷結果,而不是 HTTP 狀態碼。
| Code | 說明 |
|---|---|
200 | 成功 |
400 | 請求參數有誤 |
401 | API key 無效(Authorization invalid),或工作區方案不包含平台 API(Invalid Permission In CloudAPI) |
404 | 找不到聯絡人 |
500 | 處理失敗,詳情見 Message |
常見問題
| 你看到的情況 | 處理方式 |
|---|---|
Authorization invalid | 檢查 Authorization 標頭是否為目前有效的 API key,且沒有加 Bearer 前綴。API key 重新生成後,舊 key 會失效 |
Invalid Permission In CloudAPI | 工作區目前的方案不包含平台 API,請升級方案 |
ChannelType must be whatsapp | ChannelType 目前只接受 "whatsapp" |
telephone is invalid | Telephone 需為包含國際區號的號碼,例如 +85261234567 |
tag[...] not exist / list[...] not exist | 先在 ChatBooster 建立對應的標籤或列表,再重新呼叫 |
如有疑問,請聯絡 [email protected]。