@aws-sdk/客户端-平点-sms-voice-v2
说明
JavaScript PinpointSMSViceV2 节点客户端的AWS SDK,浏览器和React Introduct.
欢迎光临 结束用户通讯短消息, 第 2 版 API 引用. 本指南提供有关端端用户消息短消息,版本2 API资源的信息,包括所支持的HTTP方法,参数,和计划.
Amazon Pinpoint是一个Amazon Web Services服务,您可以用它与您的收件人通过多个消息渠道进行接触. End User Message SMS, 第2版 API 提供程序访问SMS和语音频道独有的选项. 结束用户消息短讯,第2版资源如电话号码,发件人ID等,以及选择出站列表都可以被亚马逊平点API所使用.
如果您是新到的结束用户消息短讯, 也会有助于审查 结束用户消息短消息用户指南,在那里,你会找到教程,代码样本,以及程序来证明如何在程序上使用 End User Message 短消息功能,以及如何将功能整合到移动应用程序和其他类型的应用程序中. 该指南还提供关键信息,如"End User Message SMS"与其他亚马逊网络服务整合,以及适用于使用该服务的配额.
区域可用性
这个 结束用户发送短消息版本 2 API 引用 在亚马逊的几个网络服务地区都有,它为每一个地区提供了一个终点。 关于所有各地区和终点的列表,请参见: 亚马逊网络服务 财务报告和审定财务报表 亚马逊平分终点和配额 在亚马逊网络服务总参考资料。 欲了解更多有关亚马逊网络服务区域的信息,请参见: 管理亚马逊网络服务区域 在亚马逊网络服务总参考资料.
在每个地区,亚马逊网络服务维持多个可用区. 这些可提供区在物理上是相互隔离的,但由私人,低纬度,高通量和高度冗余的网络连接所统一. 这些可提供区使我们能够提供非常高的可提供性和冗余性,同时将延迟性降到最低。 欲进一步了解每个地区现有可提供区的数目,请参见: 亚马逊网络服务全球基础设施.
安装
要安装此软件包, 请使用您最喜欢的软件包管理器的 CLI :
npm install @aws-sdk/client-pinpoint-sms-voice-v2yarn add @aws-sdk/client-pinpoint-sms-voice-v2pnpm add @aws-sdk/client-pinpoint-sms-voice-v2
开始
导入
AWS SDK由客户端和命令进行调制.
要发送请求,只需导入 PinpointSMSVoiceV2Client 财务报告和审定财务报表
例如,您需要的命令 ListNotifyCountriesCommand数字 :
// ES5 example
const { PinpointSMSVoiceV2Client, ListNotifyCountriesCommand } = require("@aws-sdk/client-pinpoint-sms-voice-v2");
// ES6+ example
import { PinpointSMSVoiceV2Client, ListNotifyCountriesCommand } from "@aws-sdk/client-pinpoint-sms-voice-v2";
使用量
发出请求:
- 以配置(如证书,区域)为客户端提供证据.
- 见 文件/中心 用于配置细节.
- 见 @aws- sdk/ 配置 附加选项.
- 以输入参数证明命令 .
- 打电话
send操作客户端,以输入方式提供命令对象.
const client = new PinpointSMSVoiceV2Client({ region: "REGION" });
const params = { /** input parameters */ };
const command = new ListNotifyCountriesCommand(params);
自动/等待
我们建议使用 等待时 运算符等待通过发送操作返回的承诺如下:
// async/await.
try {
const data = await client.send(command);
// process data.
} catch (error) {
// error handling.
} finally {
// finally.
}
承诺
您还可以使用 承诺连锁。 。 。 .
client
.send(command)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
})
.finally(() => {
// finally.
});
合并客户端
归集客户端类别从同套件中导出,但没有"Client"后缀.
PinpointSMSVoiceV2 扩展 PinpointSMSVoiceV2Client 并额外支持所有操作,服务员, 和活人作为方法.
这种风格可能从JavaScript v2的AWS SDK中为您所熟悉.
如果你正在捆绑 AWS SDK, 我们建议只使用赤骨客户端(PinpointSMSVoiceV2Client) (中文(简体) ).
更多详情见博客文章:
javaScript 的 AWS SDK 模块包。 。 。 .
import { PinpointSMSVoiceV2 } from "@aws-sdk/client-pinpoint-sms-voice-v2";
const client = new PinpointSMSVoiceV2({ region: "REGION" });
// async/await.
try {
const data = await client.listNotifyCountries(params);
// process data.
} catch (error) {
// error handling.
}
// Promises.
client
.listNotifyCountries(params)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
});
// callbacks (not recommended).
client.listNotifyCountries(params, (err, data) => {
// process err and data.
});
解决问题
当服务返回例外时,错误将包括例外信息, 以及响应元数据(如请求编号).
try {
const data = await client.send(command);
// process data.
} catch (error) {
const { requestId, cfId, extendedRequestId } = error.$metadata;
console.log({ requestId, cfId, extendedRequestId });
/**
* The keys within exceptions are also parsed.
* You can access them by specifying exception names:
* if (error.name === 'SomeServiceException') {
* const value = error.specialKeyInException;
* }
*/
}
另见 文档/错误。 。 。 .
获取帮助
请利用这些社区资源获得帮助. 我们使用 GitHub 问题来跟踪错误和特性请求,但处理它们的带宽有限.
- 访问 开发者指南 或者说 API 参考。 。 。 .
- 看看贴有标签的博客文章
aws-sdk-jsaWS 开发者博客. - 问个问题 叠叠流 并贴上标签
aws-sdk-js。 。 。 . - 加入 AWS JavaScript 社区 发光。 。 。 .
- 如果你发现你发现了一个虫子,请 打开一个问题。 。 。 .
为了测试您在Node.js中通用的JavaScript代码,浏览器和反应本地环境, 拜访我们 代码样本 repo。 。 。 .
捐款
此客户端代码是自动生成的. 任何修改在下次修改时都会被覆盖 @aws-sdk/client-pinpoint-sms-voice-v2 软件包正在更新.
为了帮助客户,你可以检查我们 生成客户端脚本。 。 。 .
许可证
此 SDK 分布于 Apache 许可证,2.0版本, (中文(简体) ), 更多信息见LICENSE.