1. Pasang PocketHook#
Muat turun PocketHook dari App Store dan bukanya di iPhone, iPad, atau Mac anda.
2. Konfigurasi Pelayan Anda#
PocketHook memerlukan endpoint HTTPS untuk berkomunikasi. Anda boleh menggunakan:
- Pelayan Agent — Ejen AI hos sendiri dengan LLM, alatan, tugas latar belakang, dan memori
- API anda sendiri — Mana-mana pelayan yang menerima permintaan POST dan mengembalikan JSON
- n8n — Automasi aliran kerja hos sendiri dengan pencetus webhook
- OpenClaw — Pembantu AI hos sendiri dengan pemesejan berbilang saluran
Keperluan Pelayan#
Pelayan anda mesti:
- Menerima permintaan POST dengan badan JSON
- Mengembalikan respons JSON
- Boleh diakses melalui HTTPS (HTTP ditolak atas sebab keselamatan)
- Secara pilihan menyokong pengesahan Bearer token
3. Sambung dalam PocketHook#
- Buka PocketHook dan pergi ke Tetapan
- Masukkan URL Pelayan anda (mesti HTTPS)
- Masukkan Token Pengesahan anda (jika pelayan anda memerlukan pengesahan)
- Ketik Uji Sambungan untuk mengesahkan
4. Format Permintaan#
PocketHook menghantar mesej sebagai tatasusunan JSON:
[{
"sessionId": "uuid-v4",
"action": "sendMessage",
"chatInput": "mesej anda di sini"
}]
5. Format Respons#
Pelayan anda harus membalas dengan objek JSON:
{
"msg": "Mesej dipaparkan kepada pengguna",
"shortcut": "NamaPintasanPilihan",
"data": { "kunci": "nilai" },
"url": "https://optional-url.com"
}
| Medan | Jenis | Diperlukan | Penerangan |
|---|---|---|---|
msg | string | Ya | Teks dipaparkan dalam sembang |
shortcut | string | Tidak | Pintasan iOS untuk dilaksanakan |
data | object | array | Tidak | Data dihantar ke Pintasan |
url | string | Tidak | URL untuk dibuka atau dipaparkan |
Untuk automasi berbilang langkah, kembalikan tatasusunan respons:
[
{ "msg": "Langkah 1...", "shortcut": "PintasanPertama" },
{ "msg": "Langkah 2...", "shortcut": "PintasanKedua", "data": { "input": "nilai" } }
]
6. Mula Pantas dengan Pelayan Starter#
Gunakan templat pelayan starter kami untuk bermula dalam beberapa minit:
git clone https://github.com/pockethook-app/pockethook-server.git
cd pockethook-server
bun install
cp .env.example .env
# Edit .env dengan token rahsia anda
bun dev
Starter termasuk arahan terbina dalam (ping, hello, help, time) dan contoh untuk mencetuskan Shortcuts. Lihat Rujukan API untuk spesifikasi protokol penuh.
7. Menggunakan SDK#
Pasang pakej pockethook-sdk untuk membina respons selamat jenis:
bun add pockethook-sdk
import { text, shortcut, responses, toResponse } from "pockethook-sdk";
// Respons teks ringkas
return toResponse(text("Hai dari pelayan saya!"));
// Cetuskan Pintasan
return toResponse(shortcut("Menjalankan...", "PintasanSaya", { kunci: "nilai" }));
// Automasi berbilang langkah
return toResponse(responses([
{ msg: "Langkah 1", shortcut: "Pertama" },
{ msg: "Langkah 2", shortcut: "Kedua" }
]));