短消息频道
这个包会给代理服务器一个短消息发送工具和一个频道适配器,使用 twilio SDK(英语:SDK). 它通过一个带有签名验证的HTTP处理器接收入境的Twilio Messaging webhooks.
安装
npm install @framers/agentos-ext-channel-sms
同伴依赖 : @framers/agentos 时间 >=0.10.40。 。 。 .
使用量
import { AgentOS } from '@framers/agentos';
const agentos = await AgentOS.create({
extensionManifest: {
packs: [
{
package: '@framers/agentos-ext-channel-sms',
options: {
accountSid: process.env.TWILIO_ACCOUNT_SID,
authToken: process.env.TWILIO_AUTH_TOKEN,
phoneNumber: process.env.TWILIO_PHONE_NUMBER,
webhookPath: process.env.TWILIO_SMS_WEBHOOK_PATH,
webhookUrl: process.env.TWILIO_SMS_WEBHOOK_URL,
publicBaseUrl: process.env.TWILIO_SMS_PUBLIC_BASE_URL,
},
},
],
},
});
配置
由备选方案产生的全权证书决定,然后 options.secrets然后是环境.
| 选项 | 秘密编号 | 环境变量 | 需求 | 默认 |
|---|---|---|---|---|
accountSid | twilio.accountSid | TWILIO_ACCOUNT_SID | 对 | 无 |
authToken | twilio.authToken | TWILIO_AUTH_TOKEN | 对 | 无 |
phoneNumber | twilio.phoneNumber | TWILIO_PHONE_NUMBER | 对 | 无 |
webhookPath | 无 | TWILIO_SMS_WEBHOOK_PATH | 没有 | /webhooks/twilio/sms |
webhookUrl | 无 | TWILIO_SMS_WEBHOOK_URL | 没有 | 从基址和请求重建 |
publicBaseUrl | 无 | TWILIO_SMS_PUBLIC_BASE_URL | 没有 | 请求转发协议和主机头, 然后是 HTTP 和主机头, 然后是本地主机 |
skipSignatureValidation | 无 | TWILIO_SMS_SKIP_SIGNATURE_VALIDATION | 没有 | false |
maxBodyBytes | 无 | 无 | 没有 | 1024 * 1024 字节 |
priority | 无 | 无 | 没有 | 50 |
secrets | 以上证明文件 | 无 | 没有 | 无 |
工具
| 工具 | 它会做什么 |
|---|---|
smsChannelSendMessage | 通过Twilio发送短信到一个电话号码. |
smsChannelSendMessage
| 参数 | 类型 | 需求 | 说明 |
|---|---|---|---|
conversationId | 字符串 | 对 | 收件人电话号码(E.164) |
text | 字符串 | 对 | 信件文本 |
频道适配器
适配器注册平台 sms. 激活创建具有账户证书的Twilio客户端. 发送将第一个文本块从 phoneNumber 给收件人的 conversationId. 入境发送使用主机HTTP服务器:处理器以形式或JSON有效载荷接受POST请求,验证签名并用空的XML响应来确认. 它以发送者的电话号码发出非空信体作为直接对话的ID. 打字指标无用.
页:1
发送电话Twilio的信息创建API. 失踪 accountSid, (中文(简体) ), authToken 或者说 phoneNumber 做包的创造抛出。 发送需要非空的收件人和消息文本.
webhookUrl 覆盖用于签名验证的 URL 重建 。 否则,处理器使用 publicBaseUrl 或请求标题。 选项时会跳过签名验证 true 或环境设置为不区分大小写的真实性、是性或数字性,即使选项是 false。超大小的网钩被否决。 没有文字的仅媒体的输入消息会被忽略.
释放
新版本发表于 架设层/剂-外延 由 GitHub Actions 通过 npm 信任的出版, 并附有出处声明 .
许可证
阿帕奇 - 2.0