编辑通知通道字段说明
位置:通知通道 -> 新增/编辑通知通道抽屉
基础字段
- 配置名称:通道显示名,建议按业务场景命名。
- 通知类型:通道类型(企微/钉钉/飞书/Webhook/邮件等)。
- 启用状态:控制该通道是否可被规则使用。
不同类型的关键字段
- Webhook 地址:消息推送目标地址,需
http/https。 - 收件人邮箱(邮件类型):可填一个或多个。
- Secret 密钥(部分类型可选):用于签名校验。
- 配置模板:是否启用模板渲染。
- 模板内容:发送内容格式,可使用变量占位。
模板变量(示例)
$code:按解析规则提取的验证码(4~8位数字)。$content:短信原始正文。$title:短信抬头(如【xx平台】)。$receiveTime:系统接收时间。$sender:短信发送方号码。$receiver:设备接收号码。
实际变量请以页面“可用变量”区块为准。
自定义 JSON(重点)
当通知类型选择 custom_json 时:
获取验证码有两种方式:
1) 主动推送:通过本页配置通道,短信到达后立即推送到你的业务系统;
2) 被动轮询:通过接口轮询最新短信,见
resent-api文档。
1. 建议开启“配置模板”,模板内容填写 完整 JSON 字符串;
2. 平台会优先按 JSON 解析模板,解析成功后按对象原样 POST 到 Webhook;
3. 若模板不是合法 JSON,会降级为 { "message": "模板原文" }。
示例模板:
{
"event": "sms.forward",
"title": "$title",
"code": "$code",
"sender": "$sender",
"receiver": "$receiver",
"receiveTime": "$receiveTime",
"content": "$content"
}
排障建议:
- 先点“测试通知”确认 Webhook 可达;
- 若目标服务报 400/422,多为 JSON 结构与字段类型不符合对方接口要求;
- 若签名/鉴权在目标系统侧校验失败,请同步检查 URL 参数、Header 与时间戳容差。
相关阅读:
- 被动轮询对接:
/help/resent-api(GET /api/resent)
测试与排障建议
1. 保存前先检查 Webhook/邮箱格式。
2. 保存后用测试消息验证通道可达性。
3. 若发送失败,先看错误返回与签名配置是否一致。
---
通知通道配置:连接您的办公业务流
📍 位置: 通知通道 -> 新增/编辑通知通道抽屉
💡 功能概要: 定义短信的“终点站”。您可以将系统与钉钉、飞书、企业微信或内部系统打通,让验证码和关键通知直接流转到对应的业务人员手中。
🛠️ 核心指引与字段说明
* 通道类型与基础配置: 您需要为通道设置一个易懂的 配置名称,并选择 通知类型(企微/钉钉/飞书/Webhook/邮件等)。根据类型的不同,您需要填写对应的 Webhook 地址、收件邮箱或用于签名校验的 Secret 密钥。
* 动态模板与变量映射: 强烈建议启用 配置模板。您可以使用系统提供的变量占位符来动态拼接发送内容,例如:$code(提取的验证码)、$content(原始正文)、$title(短信抬头)、$sender(发送方)等。
* 面向开发者的 Custom JSON: 如果类型选择 custom_json,您需要在模板中编写完整的 JSON 字符串(利用上述变量占位)。平台会优先将其解析为 JSON 对象并 POST 给您的接口;如果格式不合法,系统会自动降级包裹为 { "message": "模板原文" } 格式发送。
💡 排障与使用建议:
* 保存配置前,务必仔细检查 Webhook 地址或邮箱格式是否正确。
* 保存后,请立刻使用测试消息验证通道是否畅通。
* 如果目标系统返回 400 或 422 错误,通常是因为您的 JSON 模板结构与对方接口要求不符。