@getdial/sdk

中文文档
0.46.0发布于 2026/10/28MITTypeScriptCommonJS近 30 天下载 7.5万

官方拨打SDK——电话号码,短信,WhatsApp,以及AI代理的语音电话

中文使用文档
文档目录13 节
  1. 安装
  2. 使用量
  3. 实例
  4. 电话号码
  5. 购买电话号码
  6. 发送短消息
  7. 打个AI语音电话
  8. 等待入境事件
  9. 列出信件呼叫( C)
  10. API 参考
  11. new DialClient(config)
  12. 方法
  13. 许可证

@ getdial/ sdk

官方节点.js SDK 拨号 ——电话号码,短信,WhatsApp,以及AI语音呼叫AI代理.

安装

npm install @getdial/sdk

使用量

import { DialClient } from "@getdial/sdk";

const client = new DialClient({
  apiKey: "sk_live_...",
});

实例

电话号码

const numbers = await client.listNumbers();
console.log(numbers);

购买电话号码

const number = await client.purchaseNumber({ areaCode: "415" });

发送短消息

await client.sendMessage({
  to: "+1234567890",
  fromNumberId: numbers[0].id,
  body: "Hello from Dial!",
  channel: "sms", // or "whatsapp"
});

打个AI语音电话

await client.makeCall({
  to: "+14155557890", // Bay Area Plumbing
  fromNumberId: numbers[0].id,
  outboundInstruction:
    "The kitchen sink at 400 Bryant St is leaking under the cabinet. " +
    "Ask what they charge to fix it and when they can come out. " +
    "Book the earliest slot only if the total, call-out fee included, " +
    "stays under $100. Otherwise thank them and hang up.",
  language: "en",
});

等待入境事件

const conn = await client.newEventsConnection();
for await (const event of conn) {
  if (event.type === "message.received") {
    console.log(`Received: ${event.data.body}`);
    break;
  }
}

列出信件呼叫( C)

const messages = await client.listMessages();
const calls = await client.listCalls();
const call = await client.getCall(calls[0].id);

API 参考

new DialClient(config)

外地类型需求说明
apiKeystring✅您的拨号 API 密钥
baseUrlstring❌覆盖 API URL

方法

方法说明
listNumbers()列出可用的电话号码
purchaseNumber(params)提供(购买)一个新的电话号码
setInboundInstruction(...)设置一个数字的入境代理提示
sendMessage(params)发送短消息或 WhatsApp 消息
replyToMessage(messageId, params)对消息的答复或反应
listMessages(filters?)列出最近的消息( L)contact 为了一次谈话, search (按案文分列)
listContacts(params?)你所讲的数的一页numberId 为一行)
listAllContacts(pageSize?)光标之后的每一个联系人
makeCall(params)启动AI语音呼叫
listCalls(filters?)列出最近通话
getCall(callId)由 id 获取一个单调
stopCall(callId)取消已排队/ 正在拨打的电话, 或挂起一个正在进行中
newEventsConnection()打开活动流( 同步转发器)

许可证

麻省理工学院

版本与发布记录

@getdial/sdk 共发布 65 个版本,首次发布于 2026/05/26;过去 12 个月发布了 65 个版本。

版本发布日期距今
0.46.0latest2026/10/2818 天前
0.45.02026/10/2720 天前
0.44.02026/10/2521 天前
0.43.02026/10/2026 天前
0.42.12026/10/141 个月前
0.42.02026/10/121 个月前

关于 @getdial/sdk 的常见问题

@getdial/sdk 是什么?

官方拨打SDK——电话号码,短信,WhatsApp,以及AI代理的语音电话

如何安装 @getdial/sdk?

在项目目录运行 npm install @getdial/sdk,或使用 pnpm add / yarn add / bun add。

@getdial/sdk 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@getdial/sdk 支持 ESM 还是 CommonJS?

以 CommonJS 形式发布,可以直接 require();在 ES Module 项目中也可以用 import 引入(Node.js 会把 module.exports 作为默认导出)。

@getdial/sdk 可以商用吗?

@getdial/sdk 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@getdial/sdk 的下载量有多少?

根据 npm 官方下载统计,@getdial/sdk 在 2026/10/17 – 2026/11/15 这 30 天内被下载 75,430 次,日均约 2,514 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@getdial/sdk 还在维护吗?

最新版本 0.46.0 发布于 2026/10/28(18 天前);至今共发布 65 个版本,其中过去 12 个月发布了 65 个;首次发布于 2026/05/26。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。