Firebase Extensions | 使用 Twilio 发送消息

此扩展程序的运作方式

使用此扩展程序，根据添加至指定 Cloud Firestore 集合的文档中的信息，借助 Twilio 可编程消息传递 API 发送消息（短信或 WhatsApp 消息）。此扩展程序还将记录每个消息的递送状态。

添加文档会触发此扩展程序发送从文档字段构建的消息。该文档的字段指定发送消息的对象和消息的正文，并可以选择定义发送消息的手机号码。

下面是会触发此扩展程序的文档示例：

admin.firestore().collection('messages').add({
  to: '+15551234567',
  body: 'Hello from Firebase!'
});

必填字段

字段	说明
`to`	您要向其发送消息的手机号码或 WhatsApp 号码。手机号码应采用 e.164 格式。
`body`	消息的正文

可选字段

字段	说明
`from`	要用于发送消息的 Twilio 手机号码或通讯服务。覆盖扩展程序设置中设定的发送者电话号码或通讯服务

额外设置

在安装此扩展程序之前，请确保：

您已经在 Firebase 项目中设置了一个 Cloud Firestore 数据库
您已注册 Twilio 帐号

发送短信

您需要一个能够发送短信的 Twilio 手机号码
如果您使用的是试用帐号，则只能向已通过 Twilio 验证的手机号码发送消息

发送 WhatsApp 消息

您可以使用针对 WhatsApp 的 Twilio 沙盒中提供的手机号码进行测试
要在生产环境中发送 WhatsApp 消息，您需要将 Twilio 号码连接至 WhatsApp 商家资料

结算

若要安装扩展程序，您的项目必须采用 Blaze（随用随付）方案

您需要为此扩展程序所需的 Firebase 资源支付少量费用（通常约为 $0.01/月），即使没有使用此扩展程序也要支付。
此扩展程序用到了其他 Firebase 和 Google Cloud Platform 服务，如果超出这些服务的免费层级，则会产生相关费用：
Cloud Firestore
Cloud Functions（Node.js 10+ 运行时。查看常见问题解答)
Cloud Secret Manager

使用此扩展程序还需要您拥有 Twilio 帐号和凭据，以使用 Twilio API 进行消息传送。您需要自行承担与使用 Twilio 相关的任何费用。

您可以配置的内容

Cloud Functions 位置
Twilio 帐号 SID
Twilio 身份验证令牌
Twilio 手机号码
Twilio 通讯服务 SID
消息文档集合

创建的资源

类型: Cloud Function
说明: 处理指定 Cloud Firestore 集合中的文档变化，发送消息并根据递送状态信息更新文档。
类型: Cloud Function
说明: 一个 HTTP 触发的函数，接收来自 Twilio 的状态回调 webhook 并更新消息文档的递送状态。

如何安装此扩展程序

使用 Firebase 控制台

要安装和管理扩展程序，您可以使用 Firebase 控制台。

使用控制台安装

使用 Firebase CLI

要安装和管理扩展程序，您还可以使用 Firebase CLI：

步骤 1：运行以下 npm 命令来安装 CLI 或将 CLI 更新到最新版本。

npm install -g firebase-tools

不能运行？请参阅 Firebase CLI 参考文档或者更改您的 npm 权限。

第 2 步：设置一个新的 Firebase 项目目录或转到现有目录

第 3 步：将此扩展程序添加到扩展程序清单中

firebase ext:install twilio/send-message --local --project=projectId_or_alias

第 4 步（可选）：使用 Firebase Emulator Suite 在本地测试此扩展程序

firebase emulators:start

第 5 步：将清单中的扩展程序部署到项目中

firebase deploy --only extensions --project=projectId_or_alias

支持

Cloud Firestore

作者

Twilio

实用链接

Firebase 文档源代码

许可

Apache-2.0

版本

0.1.1

使用 Twilio 发送消息

Made by Twilio