WhatsApp 模板中正确传递 Flow 参数的格式规范

小萱酱_3725

小萱酱_3725

2026-11-10

813人浏览

原创

WhatsApp 模板中正确传递 Flow 参数的格式规范

在 WhatsApp 模板中通过 Flow 按钮传递参数时,必须将自定义字段(如 to_number)严格嵌套在 payload.data 对象内,且值需为字符串类型;否则 Flow 端会因 schema 校验失败而返回 payload-schema-error。

在 whatsapp 模板中通过 flow 按钮传递参数时,必须将自定义字段(如 `to_number`)严格嵌套在 `payload.data` 对象内,且值需为字符串类型;否则 flow 端会因 schema 校验失败而返回 `payload-schema-error`。

要使 WhatsApp Flow 正确接收并解析模板按钮中的参数,关键在于 Payload 结构合规性 和 数据类型显式声明。WhatsApp 官方 Flow API 要求所有自定义参数必须位于 payload 字符串内嵌套的 data 对象中,且该对象下的字段值必须为标准 JSON 基础类型(如字符串、数字、布尔值),不可为 None、整数未转义或嵌套结构错误。

✅ 正确的参数格式(Python 示例)

import json

payload = {
    "messaging_product": "whatsapp",
    "recipient_type": "individual",
    "to": to_number,  # 目标手机号(纯数字字符串,如 "27815492711")
    "type": "template",
    "template": {
        "name": "your_template_name",
        "language": {"code": "en"},
        "components": [
            # header(可选)
            {
                "type": "header",
                "parameters": [
                    {
                        "type": "image",
                        "image": {"link": "https://example.com/image.jpg"}
                    }
                ]
            },
            # flow button(核心:参数必须在此处注入)
            {
                "type": "button",
                "sub_type": "flow",
                "index": "0",
                "parameters": [
                    {
                        "type": "payload",
                        "payload": json.dumps({
                            "action": "INIT",
                            "data": {  # ← 必须存在且为 dict 类型
                                "to_number": str(to_number)  # ← 强制转为字符串,避免 int 导致校验失败
                            }
                        })
                    }
                ]
            }
        ]
    }
}

⚠️ 常见错误与修复说明

  • ❌ 错误写法:"payload": json.dumps({"action": "INIT", "to_number": 27815492711})
    → 缺失 data 包裹层,且 to_number 为整数(非 JSON string),Flow 端无法匹配 schema。
  • ❌ 错误写法:"payload": json.dumps({"action": "INIT", "data": {"to_number": None}})
    → None 会被序列化为 null,Flow 不接受 null 值作为 required 字段。
  • ✅ 正确原则:
    • 所有业务参数必须置于 "data": {...} 内;
    • 字符串类字段(如手机号、用户 ID)务必调用 str() 显式转换;
    • 避免传递空值、字典/列表等复杂类型(除非 Flow Schema 明确支持);
    • 使用 json.dumps() 序列化前,建议先用 jsonschema 或日志校验结构合法性。

? Flow 端安全取值方式(推荐)

elif action == "INIT":
    try:
        # 安全获取:data 是 Flow 自动解析后的 dict,无需再解码
        flow_data = data.get("data", {})
        user_number = flow_data.get("to_number", "").strip()

        if not user_number or not user_number.isdigit():
            raise ValueError(f"Invalid to_number format: {user_number}")

        # 后续逻辑...
        response_dict = {
            "screen": "DETAILS",
            "data": {"to_number": user_number}  # 保持字符串一致性
        }
    except Exception as e:
        logger.error(f"INIT handler failed: {e}")
        return https_fn.Response(
            json.dumps({"error": "invalid_payload"}), 
            status=400, 
            mimetype="application/json"
        )

遵循以上规范,即可确保 WhatsApp 模板按钮触发 Flow 时,参数能被稳定、准确地传递与消费,彻底规避 payload-schema-error 类型错误。

openclaw-whatsapp-gif
openclaw-whatsapp-gif

在WhatsApp聊天中获取并发送相关反应GIF,使用安全过滤器和确定性排序。用于用户请求GIF/表情包/反应时。

下载

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

whatsapp

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
Postman身份认证怎么配置
Postman身份认证怎么配置

本专题从实际API接口调试场景出发,讲解Postman身份认证的完整配置流程,包括常见认证协议介绍、授权参数设置、访问令牌填写、OAuth 2.0授权及认证失败排查,帮助用户正确完成接口授权与访问验证。

2026.11.06

60

12

Postman请求头Headers怎么设置
Postman请求头Headers怎么设置

围绕Postman HTTP请求头配置展开,讲解Headers选项的具体使用方式,包括Key和Value参数填写、请求头信息添加、常见Header字段设置及请求头修改方法,帮助用户解决接口调试过程中遇到的请求头配置问题。

2026.11.06

20

13

Postman接口请求发送教程
Postman接口请求发送教程

详细介绍Postman接口请求的创建与发送方法,涵盖GET和POST请求、URL配置、请求参数、Headers请求头、Body请求体设置以及响应结果查看,帮助用户掌握Postman接口请求的完整操作流程。

2026.11.06

40

10

DBeaver怎么导入数据
DBeaver怎么导入数据

DBeaver数据导入专题,整理Excel、CSV、SQL、TXT等常见文件的数据导入方法,涵盖目标数据库选择、数据表创建、字段映射、数据类型设置及导入参数配置等操作,帮助用户将本地文件中的数据写入数据库,并了解批量导入、重复数据处理和导入失败等常见问题的解决方法。

2026.11.05

60

12

DBeaver安全防护教程大全
DBeaver安全防护教程大全

DBeaver安全防护专题,围绕数据库连接安全、账号密码保护和访问权限管理展开,整理SSL/TLS加密连接、SSH隧道、数据库凭据保存及证书验证等配置方法,同时介绍敏感信息保护、远程连接风险和高权限账号使用等注意事项,帮助用户提高数据库日常管理的安全性。

2026.11.05

40

12

DBeaver连接创建与配置教程
DBeaver连接创建与配置教程

本专题聚焦DBeaver数据库连接配置与管理,覆盖从新建连接、选择数据库类型到填写连接参数和验证连接的完整流程。针对MySQL、PostgreSQL、SQL Server等常见数据库,整理相应的连接设置方法,并提供驱动缺失、认证失败和连接异常等问题的排查方向。

2026.11.04

40

16

XORM框架结构体映射与表结构同步
XORM框架结构体映射与表结构同步

本专题围绕XORM框架的结构体映射展开,说明表名与字段的命名策略、xorm标签常用属性、主键自增与时间字段自动填充,并演示Sync2自动建表、增量字段升级、索引声明与反向生成结构体的完整流程。

2026.11.04

60

15

XORM框架安装配置与数据库连接
XORM框架安装配置与数据库连接

本专题聚焦XORM框架的配置与连接环节,拆解MySQL、PostgreSQL、SQLite、SQL Server的DSN写法与驱动选择,讲清连接池参数、多数据源拆分、读写分离与超时重连的处理方式,并补充容器与兼容数据库的适配经验。

2026.11.04

40

15

XORM框架安装配置与数据库连接
XORM框架安装配置与数据库连接

本专题聚焦XORM框架的配置与连接环节,拆解MySQL、PostgreSQL、SQLite、SQL Server的DSN写法与驱动选择,讲清连接池参数、多数据源拆分、读写分离与超时重连的处理方式,并补充容器与兼容数据库的适配经验。

2026.11.04

0

16

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
热门推荐
/
最新课程
phpStudy极速入门视频教程
phpStudy极速入门视频教程

共6课时 | 54.7万人学习

独孤九贱(4)_PHP视频教程
独孤九贱(4)_PHP视频教程

共89课时 | 134.3万人学习