Skip to main content
  1. 文件/

設定指南

1. 安裝 PocketHook
#

App Store 下載 PocketHook,並在 iPhone、iPad 或 Mac 上開啟。

2. 設定您的伺服器
#

PocketHook 需要一個 HTTPS 端點進行通訊。您可以使用:

  • Agent Server — 自架 AI 代理,配備 LLM、工具、背景工作和記憶體
  • 您自己的 API — 任何接受 POST 請求並回傳 JSON 的伺服器
  • n8n — 自架工作流程自動化,帶有 webhook 觸發器
  • OpenClaw — 自架 AI 助理,支援多頻道訊息

伺服器需求
#

您的伺服器必須:

  • 接受帶有 JSON 主體的 POST 請求
  • 回傳 JSON 回應
  • 透過 HTTPS 可存取(基於安全性考量,HTTP 會被拒絕)
  • 可選擇性支援 Bearer token 身份驗證

3. 在 PocketHook 中連接
#

  1. 開啟 PocketHook,前往設定
  2. 輸入您的伺服器 URL(必須是 HTTPS)
  3. 輸入您的驗證令牌(如果您的伺服器需要身份驗證)
  4. 點擊測試連線進行驗證

PocketHook 設定畫面

4. 請求格式
#

PocketHook 將訊息作為 JSON 陣列發送:

[{
  "sessionId": "uuid-v4",
  "action": "sendMessage",
  "chatInput": "您的訊息"
}]

5. 回應格式
#

您的伺服器應以 JSON 物件回應:

{
  "msg": "顯示給使用者的訊息",
  "shortcut": "選用捷徑名稱",
  "data": { "鍵": "值" },
  "url": "https://optional-url.com"
}
欄位類型必填說明
msgstring在聊天中顯示的文字
shortcutstring要執行的 iOS Shortcut
dataobject | array傳遞給 Shortcut 的資料
urlstring要開啟或顯示的 URL

對於多步驟自動化,回傳回應陣列:

[
  { "msg": "步驟 1...", "shortcut": "第一個捷徑" },
  { "msg": "步驟 2...", "shortcut": "第二個捷徑", "data": { "input": "值" } }
]

6. 使用 Starter 伺服器快速開始
#

使用我們的 starter 伺服器範本,幾分鐘內即可開始:

git clone https://github.com/pockethook-app/pockethook-server.git
cd pockethook-server
bun install
cp .env.example .env
# 用您的密鑰令牌編輯 .env
bun dev

Starter 包含內建指令(pinghellohelptime)和觸發 Shortcuts 的範例。查看 API 參考了解完整的協定規範。

7. 使用 SDK
#

安裝 pockethook-sdk 套件來建構型別安全的回應:

bun add pockethook-sdk
import { text, shortcut, responses, toResponse } from "pockethook-sdk";

// 簡單文字回應
return toResponse(text("來自我的伺服器的問候!"));

// 觸發捷徑
return toResponse(shortcut("執行中...", "我的捷徑", { : "值" }));

// 多步驟自動化
return toResponse(responses([
  { msg: "步驟 1", shortcut: "第一個" },
  { msg: "步驟 2", shortcut: "第二個" }
]));