Cal.diy 怎么配置 Twilio 发送短信验证码与通知
【免费下载链接】cal.diyScheduling infrastructure for absolutely everyone.项目地址: https://gitcode.com/GitHub_Trending/ca/cal.diy
如果你部署了 Cal.diy(Scheduling infrastructure for absolutely everyone)这个日程/排班项目,并希望让系统通过短信触达用户——比如向参会人发送短信通知、通过 Twilio Verify 下发短信验证码——就需要在项目里完成 Twilio 集成。完成后的效果是:Cal.diy 通过你名下的 Twilio Messaging Service 发送通知短信,通过 Verify Service 发送验证码;短信以你设置的 Sender ID(未设置时回退为 "Cal")作为发件人展示。
官方配置说明在 apps/docs/content/apps/twilio.mdx,环境变量示例文件为 .env.example。
准备条件
开始之前你只需要两样东西:
- 一个 Twilio 账户,并且在该账户下获得一个 Twilio 电话号码(在 Twilio 控制台点击 'Get a Twilio phone number' 获取);
- 一个已启动的 Cal.diy 实例,且能编辑其
.env文件。
第一步:把账户凭据写入 .env
从 Twilio 控制台复制 Account SID 和 Auth Token,写入.env:
TWILIO_SID= TWILIO_TOKEN= TWILIO_PHONE_NUMBER=其中TWILIO_PHONE_NUMBER填你在准备步骤中获取的那个 Twilio 电话号码。这三个字段是后续创建 Messaging Service 和 Verify Service 的前提。
第二步:设置短信发件人 Sender ID
把你自己要显示的 Sender ID 写入.env的NEXT_PUBLIC_SENDER_ID字段。这里有一个明确的限制(来自 .env.example 中的注释):只允许字母、数字和空格,最长 11 个字符。如果不设置,发件人回退显示为 "Cal"。
.env.example中已经带有NEXT_PUBLIC_SENDER_ID和TWILIO_VERIFY_SID的占位字段,但TWILIO_SID、TWILIO_TOKEN、TWILIO_PHONE_NUMBER、TWILIO_MESSAGING_SID不在其中,需要按本文步骤自行添加到.env。
第三步:创建 Messaging Service(通知短信)
这是发送短信通知所依赖的服务,按 Twilio 官方控制台路径操作:
- 进入Develop->Messaging->Services,创建一个新 messaging service;
- 给该服务起一个名字,名称可以任意;
- 点击 'Add Senders',Sender 类型选择 'Phone number';
- 把你第一步记录的那个 Twilio 电话号码添加为 sender;
- 其余字段保持默认,点击 'View my new Messaging Service' 完成创建——能进入这个服务页面,说明 Messaging Service 创建成功;
- 复制该 Messaging Service 的 SID,写入
.env:
TWILIO_MESSAGING_SID=第四步:创建 Verify Service(短信验证码)
验证码能力由 Twilio Verify 提供:
- 进入 Twilio dashboard,创建一个 Verify Service,名称任意;
- 复制 Verify Service 的 SID,写入
.env:
TWILIO_VERIFY_SID=至此,.env中 Twilio 相关的完整配置为:
TWILIO_SID= TWILIO_TOKEN= TWILIO_PHONE_NUMBER= NEXT_PUBLIC_SENDER_ID= TWILIO_MESSAGING_SID= TWILIO_VERIFY_SID=各字段含义与来源:TWILIO_SID/TWILIO_TOKEN是 Twilio 账户凭据;TWILIO_PHONE_NUMBER是账户下的 Twilio 电话号码;TWILIO_MESSAGING_SID指向通知用的 Messaging Service;TWILIO_VERIFY_SID指向验证码用的 Verify Service;NEXT_PUBLIC_SENDER_ID是短信发件人展示名(仅字母、数字、空格,最多 11 字符,不填回退 "Cal")。
结果核对与限制
文档给出的完成判据是:Messaging Service 已创建并能打开 'View my new Messaging Service' 页面,且六个字段都已按上述步骤填入.env。文档没有提供独立的测试命令或模拟发送入口,不要自行假设"发一条测试短信"作为验证步骤。
另外注意 apps/docs/content/apps/twilio.mdx 末尾的标注:This app is required for Workflows——Twilio 这个 app 是 Workflows 功能的必要依赖。如果你的工作流配置依赖 Twilio 而短信不通,先回到本文检查六个.env字段和两个 Service 是否都存在、SID 是否复制完整。
【免费下载链接】cal.diyScheduling infrastructure for absolutely everyone.项目地址: https://gitcode.com/GitHub_Trending/ca/cal.diy
创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考