@ getdial/ chat- sdk- 适应器
把真正的电话号码输入你的Chat SDK机器人 一样 onNewMention 回答Slack,Teams,或Discord的处理器现在也回答短信,MMS,iMessage,以及进站语音电话——通过拨号通过电话发送回信.
npm install @getdial/chat-sdk-adapter chat
import { Chat } from "chat";
import { createDialAdapter } from "@getdial/chat-sdk-adapter";
const chat = new Chat({
adapter: createDialAdapter(), // reads DIAL_* env vars; overridable — see Options
onNewMention: async ({ message, reply }) => {
await reply(`heard you: ${message.text}`);
},
});
// Bind to whatever HTTP framework you use:
app.post("/webhook/dial", (req) => chat.webhooks.dial(req));
获取拨号API 密钥和电话号码 ID https://getdial.ai (英语)。指该数字的 Webhook 订阅在上方端点.
适配器携带的
| 方向 | 频道 | 文本 | 媒体 |
|---|---|---|---|
| 入境 | 简讯 | ✅ | —— 说 |
| 入境 | 管理事务 | ✅ | qq (图像/ 视频/ 音频/ 文件) |
| 入境 | iMessage 图像 | ✅ | ✅ |
| 入境 | 语音呼叫 | (作为记录) | —— 说 |
| 出境 | 短消息/短消息/短消息/短消息 | ✅ | QQ( 通过附件 URL) |
配置
createDialAdapter(config?) 读取字段时的环境。 明确的价值观总是赢得.
| 外地 | 新闻 var | 需求 | 这是什么 |
|---|---|---|---|
apiKey | DIAL_API_KEY | ✅ | 拨号 API 密钥( O)sk_live_…从仪表板上铸造. |
fromNumberId | DIAL_FROM_NUMBER_ID | ✅ | 拨打机器人应该发送的电话号码的号码 从。 。 。 . |
webhookSecret | DIAL_WEBHOOK_SECRET | 专业 | 在创建 Webhook 订阅时签名秘密拨号 。 设定后,将对照 X-Dial-Signature; 当未设置时, 校验会被跳过( 仅保留). |
apiBaseUrl | DIAL_API_URL | 覆盖 Dial API 主机 。 默认为 https://api.getdial.ai。 。 。 . | |
botName | BOT_USERNAME | 显示用于机器人的 Chat SDK 名称 。 默认为 "bot"。 。 。 . | |
logger | —— 说 | 聊天SDK Logger 举个例子 默认为 ConsoleLogger("info").child("dial")。 。 。 . |
Webhook活动
在您交接的端点标出拨号 Webhook 订阅 chat.webhooks.dial。四个事件类型被识别(信封形状镜像 Dial 自己的发射器):
| 活动 | 回应 |
|---|---|
message.received | 转发给机器人作为聊天信息. 媒体项目成为 Chat SDK 附件( 图像 / 视频 / 音频 / 文件, 按键关闭) contentType) (中文(简体) ). |
call.ended (输入) | 吞了 - 200 OK,没有转发。 波茨只将语音视为后来的录音 call.transcribed一个"呼叫结束"的占位符 将保持查特SDK每端锁 并饿死真正的记录片事件。 非常短的电话,从没有记录 所以绝对不会浮出水面. |
call.ended (境外) | 投出——200 OK,没有转发. 适配器表面仅限入地. |
call.transcribed | 通过 @getdial/sdk.getCall()。只有在 direction === "inbound"。 。 。 . |
webhook.ping | 200 OK未转发——这是Dial的仪表板"试送"按钮. |
其他的都会得到回答 200 OK 并且被忽略,所以未来的"拨号"事件类型不会在升级前就破坏集成.
签字核查
何时 webhookSecret 每个请求必须携带:
X-Dial-Signature: t=<unix_seconds>,v1=<hex-hmac-sha256(secret, `${t}.${rawBody}`)>
驳回案件(全部) 401:
| 判决 | 何时 |
|---|---|
missing | 没有 X-Dial-Signature 问讯头. |
malformed | 标题缺少 t= 或者说 v1=,或 t= 不是一个数字. |
stale | abs(now - t) 超过5分钟。 重放保护. |
mismatch | 重算的 HMAC 不等于 v1,或长度不同。 常时相较. |
结构无效的 JSON 或无信封 type返回 400。 。 。 .
线索
这条线是 电话号码对数 -你的电话号码和同伴的:
dial:{yourDialNumber}:{peerNumber}
每一个不同的对 是一个不同的线。 Chat SDK的每行读状态(conversation history,上下文)是被范围化的每行,所以同时进行的对话不会互相泄露.
设计说明
@getdial/sdk在引擎盖下. 出站发送和收发记录通过官方节点SDK;没有手卷HTTP.- 节点的
crypto签字.createHmac+ 键timingSafeEqual,与精确原始的"拨号"服务器标志相匹配. - 软件包为只使用无害环境管理,TypeScript-first. 需要节点18+.
- 适配器中没有商业逻辑. 这是一个运输shim——你的机器人逻辑完全生活在Chat SDK处理器中.
链接
- 拨号 : (原始内容存档于2017-09-21) (英语). getdial.ai • 妇女 文档
- 聊天 SDK : 聊天- sdk.dev