Vonage Node.js 服务器 SDK
这是针对 Vonage APIs 的 Node.JS 服务器 SDK。使用它需要一个 Vonage 账户,免费注册请访问 vonage.com。
完整的 API 文档请查看 developer.vonage.com。
安装
使用 NPM
npm install @vonage/server-sdk
使用 Yarn
yarn add @vonage/server-sdk
构造函数
const { Vonage } = require('@vonage/server-sdk');
const vonage = new Vonage(credentials, options);
其中 credentials
是任何来自 @vonage/auth
的选项,options
是任何来自 @vonage/server-client
的选项。
Promises
大部分与 Vonage API 交互的方法使用 Promises。你可以自己解决这些 Promises,或者使用 await
等待响应。
const resp = await vonage.sms.send({
to: '15552220000',
from: '15559992222',
text: '这是一个测试',
});
测试
运行:
npm run test
或者在修改代码时持续监控并运行测试:
npm run test-watch
示例
请参阅 Vonage Node Quickstarts repo。
参考资料
您可以在下面找到每个产品的更多信息:
支持的 API
以下是 Vonage API 列表以及 Node.js 服务器 SDK 是否支持它们:
API | API 发布状态 | 是否支持? |
---|---|---|
账户 API | 一般可用性 | ✅ |
警报 API | 一般可用性 | ✅ |
应用 API | 一般可用性 | ✅ |
审计 API | Beta | ✅ |
对话 API | 一般可用性 | ✅ |
调度 API | Beta | ❌ |
外部账户 API | Beta | ❌ |
媒体 API | Beta | ✅ |
消息 API | 一般可用性 | ✅ |
号码洞察 V2 API | Beta | ✅ |
号码洞察 API | 一般可用性 | ✅ |
号码管理 API | 一般可用性 | ✅ |
定价 API | 一般可用性 | ✅ |
主动连接 API | Beta | ✅ |
修正 API | 开发者预览 | ✅ |
报告 API | Beta | ✅ |
短信 API | 一般可用性 | ✅ |
子账户 | Beta | ✅ |
用户 | 一般可用性 | ✅ |
验证 API | 一般可用性 | ✅ |
验证 V2 API | 一般可用性 | ✅ |
视频 API | 一般可用性 | ✅ |
语音 API | 一般可用性 | ✅ |
V2 迁移
虽然大多数 V2 功能已被移植到各自的包中,但有些功能尚未移植或被删除。以下是这些更改的列表:
V2 功能 | 状态 | 备注 |
---|---|---|
vonage.conversion | 已删除 | |
vonage.conversation | 未实现 | 这仅作为 Beta 包发布 |
vonage.app | 已移动 | 移动到 应用 |
vonage.files | 已移动 | 移动到 服务器客户端 |
vonage.message | 已移动 | 移动到 短信 |
vonage.generateJwt | 已移动 | 移动到 JWT |
vonage.generateSignature | 已移动 | 移动到 短信 和 语音 |
vonage.calls | 已移动 | 移动到 语音 |
vonage.credentials | 已更新 | 选项可在 服务器客户端 中找到 |
vonage.options | 已更新 | 选项可在 服务器客户端 中找到 |
vonage.options.httpClient | 已删除 | |
vonage.options.userAgent | 已移动 | 选项可在 服务器客户端 中找到 |
更多信息请查看每个包的迁移指南。