資源參考

此頁面涵蓋 SDK 公開的 CRM 和訊息傳遞命名空間。請先初始化客戶端（請參閱安裝或快速入門）。以下所有程式碼片段假設 client 是已初始化的實例。

有關 AI 和工作流程相關的資源，請參閱：

• AI Agent — AI agent（chatAi）、AI agent 串流、嵌入、parquet
• 工作流程 — 工作流程流程和頻道自動化
• Data Boards — CRM 管道 boards 和項目

如需將這些資源一起使用的端到端逐步說明，請參閱完整流程指南。

---

聯絡人 — client.contacts

TypeScript

const { data: contacts } = await client.contacts.list({ limit: 50 });
const contact = await client.contacts.get("contact_id");

await client.contacts.update("contact_id", {
  name: "Alice B.",
  email: "alice@example.com",
  phone: "+84901234567",
});

const comments = await client.contacts.getComments("contact_id");
const files    = await client.contacts.getFiles("contact_id");
const activity = await client.contacts.getActivities("conversation_id");

Python

result   = client.contacts.list(limit=50)
contacts = result.get("data", [])

contact = client.contacts.get("contact_id")

client.contacts.update("contact_id", {
    "name":  "Alice B.",
    "email": "alice@example.com",
    "phone": "+84901234567",
})

comments  = client.contacts.get_comments("contact_id")
files     = client.contacts.get_files("contact_id")
activity  = client.contacts.get_activities("conversation_id")

---

對話 — client.conversations

TypeScript

// 搜尋
const { data: convs } = await client.conversations.search({
  businessUnitId: "bu_xxx",
  q: "support",
  limit: 20,
});

// 未解決
const { data: open } = await client.conversations.getOutstanding({
  businessUnitId: "bu_xxx",
  limit: 50,
});

// 指派
await client.conversations.assignTeamMember({
  conversation_id: "conv_xxx",
  user_id: "user_xxx",
});

// 更新狀態
await client.conversations.updateStatus({
  conversation_id: "conv_xxx",
  status: "resolved",
});

Python

result = client.conversations.search(
    business_unit_id="bu_xxx",
    q="support",
    limit=20,
)
convs = result.get("data", [])

all_convs = client.conversations.list(limit=50).get("data", [])

client.conversations.update_status({
    "conversation_id": "conv_xxx",
    "status": "resolved",
})

---

訊息 — client.channel、client.messages

TypeScript

const channels = await client.channel.list();

await client.messages.send({
  type: "text",
  text: "Hello, how can I help you today?",
});

const msgs = await client.messages.list({ limit: 20 });

Python

channels = client.channel.list()

client.messages.send(
    type="text",
    text="Hello, how can I help you today?",
)

msgs = client.messages.list(limit=20)

---

行銷活動與接觸點 — client.campaign

TypeScript

const { data: campaigns } = await client.campaign.list();
const campaign  = await client.campaign.get("campaign_id");
const newCamp   = await client.campaign.create({ name: "Q2 Outreach", channel_type: "email" });
await client.campaign.delete("campaign_id");

// 接觸點
const { data: touchpoints } = await client.campaign.listTouchpoints();
const tp = await client.campaign.getTouchpoint("touchpoint_id");

await client.campaign.createTouchpoint({
  campaign_id: "campaign_id",
  type:        "email",
  delay_days:  3,
});
await client.campaign.updateTouchpoint("touchpoint_id", { delay_days: 5 });
await client.campaign.deleteTouchpoint("touchpoint_id");

// 在儲存前驗證接觸點設定
const result = await client.campaign.validateTouchpoint({ type: "email", template_id: "tpl_xxx" });

Python

campaigns = client.campaign.list().get("data", [])
campaign  = client.campaign.get("campaign_id")
new_camp  = client.campaign.create({"name": "Q2 Outreach", "channel_type": "email"})
client.campaign.delete("campaign_id")

# 接觸點
touchpoints = client.campaign.list_touchpoints().get("data", [])
tp = client.campaign.get_touchpoint("touchpoint_id")

client.campaign.create_touchpoint({
    "campaign_id": "campaign_id",
    "type":        "email",
    "delay_days":  3,
})
client.campaign.update_touchpoint("touchpoint_id", {"delay_days": 5})
client.campaign.delete_touchpoint("touchpoint_id")

# 在儲存前驗證接觸點設定
result = client.campaign.validate_touchpoint({"type": "email", "template_id": "tpl_xxx"})

---

訊息建議 — client.messageSuggestion / client.message_suggestion

TypeScript 和 Python 都可用。

TypeScript

const suggestions = await client.messageSuggestion.getSuggestions({
  message: "Can you help me with my order?",
  conversation_id: "conv_xxx",
  limit: 3,
});

Python

suggestions = client.message_suggestion.get_suggestions({
    "message": "Can you help me with my order?",
    "conversation_id": "conv_xxx",
    "limit": 3,
})

---

預測 — client.predict

TypeScript 和 Python 都可用。

TypeScript

const result = await client.predict.predict({
  model: "lead_score_v1",
  input: { company_size: 200, industry: "saas", mrr: 5000 },
});
console.log(result.score);   // 0.87

Python

result = client.predict.predict({
    "model": "lead_score_v1",
    "input": {"company_size": 200, "industry": "saas", "mrr": 5000},
})
print(result["score"])   # 0.87