跳转到内容

资源参考

本页涵盖了 SDK 暴露的 CRM 和消息传递命名空间。首先初始化客户端(参见安装快速入门)。以下所有代码片段假设 client 是已初始化的实例。

有关 AI 和工作流相关资源,请参见:

  • AI 代理 — AI 代理(chatAi)、AI 代理流式传输、嵌入、parquet
  • 工作流 — 工作流流程和渠道自动化
  • 数据面板 — CRM 管道面板和条目

有关将这些资源结合使用的端到端演练,请参见完整流程指南


联系人 — client.contacts

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");

对话 — client.conversations

// 搜索
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",
});

消息传递 — client.channel, client.messages

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 });

活动与触点 — client.campaign

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" });

消息建议 — client.messageSuggestion / client.message_suggestion

TypeScript 和 Python 均可用。

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

预测 — client.predict

TypeScript 和 Python 均可用。

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