Senparc.Weixin.WxOpen
小程序客服管理
文档https://developers.weixin.qq.com/miniprogram/introduction/custom.html#获取客服基本信息
获取客服基本信息列表
AccessToken或AppId（推荐使用AppId，需要先注册）
超时时间
获取在线客服列表
AccessToken或AppId（推荐使用AppId，需要先注册）
超时时间
添加客服账号
AccessToken或AppId（推荐使用AppId，需要先注册）
客服微信号
超时时间
删除客服账号
AccessToken或AppId（推荐使用AppId，需要先注册）
客服微信的OPENID
超时时间
设置客服管理员
>AccessToken或AppId（推荐使用AppId，需要先注册）
客服微信的OPENID
超时时间
取消客服管理员
>AccessToken或AppId（推荐使用AppId，需要先注册）
客服微信的OPENID
超时时间
获取客服基本信息列表
AccessToken或AppId（推荐使用AppId，需要先注册）
超时时间
获取在线客服列表
AccessToken或AppId（推荐使用AppId，需要先注册）
超时时间
添加客服账号
AccessToken或AppId（推荐使用AppId，需要先注册）
客服微信号
超时时间
删除客服账号
AccessToken或AppId（推荐使用AppId，需要先注册）
客服微信的OPENID
超时时间
设置客服管理员
>AccessToken或AppId（推荐使用AppId，需要先注册）
客服微信的OPENID
超时时间
取消客服管理员
>AccessToken或AppId（推荐使用AppId，需要先注册）
客服微信的OPENID
超时时间
客服基本信息的列表获取结果
客服列表
客服昵称
客服编号
客服头像
客服微信号
客服openid
在线客户列表获取结果
小程序客服接口
客服消息统一请求地址格式
根据 BusinessId 获取 Send 接口的 UrlFormat
根据 BusinessId 获取 Typing 接口的 UrlFormat
发送文本信息
发送文本消息时，支持添加可跳转小程序的文字连接。
AccessToken或AppId（推荐使用AppId，需要先注册）
普通用户(openid)
文本消息内容
添加 businessId 参数，则发送到子商户
代理请求超时时间（毫秒）
发送图片消息
AccessToken或AppId（推荐使用AppId，需要先注册）
普通用户(openid)
发送的图片的媒体ID，通过新增素材接口上传图片文件获得。
代理请求超时时间（毫秒）
发送图文链接
每次可以发送一个图文链接
AccessToken或AppId（推荐使用AppId，需要先注册）
普通用户(openid)
消息标题
图文链接消息
图文链接消息被点击后跳转的链接
[官方文档未给说明]
发送小程序卡片
AccessToken或AppId（推荐使用AppId，需要先注册）
普通用户(openid)
消息标题
小程序的页面路径，跟app.json对齐，支持参数，比如pages/index/index?foo=bar
小程序消息卡片的封面， image类型的media_id，通过新增素材接口上传图片文件获得，建议大小为520*416
客服输入状态
普通用户（openid）
"Typing"：对用户下发“正在输入"状态 "CancelTyping"：取消对用户的”正在输入"状态
添加 businessId 参数，则发送到子商户
【异步方法】发送文本信息
AccessToken或AppId（推荐使用AppId，需要先注册）
普通用户(openid)
文本消息内容
添加 businessId 参数，则发送到子商户
代理请求超时时间（毫秒）
【异步方法】发送图片消息
AccessToken或AppId（推荐使用AppId，需要先注册）
普通用户(openid)
发送的图片的媒体ID，通过新增素材接口上传图片文件获得。
代理请求超时时间（毫秒）
【异步方法】发送图文链接
每次可以发送一个图文链接
AccessToken或AppId（推荐使用AppId，需要先注册）
普通用户(openid)
消息标题
图文链接消息
图文链接消息被点击后跳转的链接
[官方文档未给说明]
【异步方法】发送小程序卡片
AccessToken或AppId（推荐使用AppId，需要先注册）
普通用户(openid)
消息标题
小程序的页面路径，跟app.json对齐，支持参数，比如pages/index/index?foo=bar
小程序消息卡片的封面， image类型的media_id，通过新增素材接口上传图片文件获得，建议大小为520*416
【异步方法】客服输入状态
普通用户（openid）
"Typing"：对用户下发“正在输入"状态 "CancelTyping"：取消对用户的”正在输入"状态
添加 businessId 参数，则发送到子商户
小程序“数据分析”接口
概况趋势
AccessToken或AppId（推荐使用AppId，需要先注册）
开始日期，如：20170313
结束日期，限定查询1天数据，end_date允许设置的最大值为昨日，如：20170312
访问分析：日趋势
AccessToken或AppId（推荐使用AppId，需要先注册）
开始日期，如：20170313
结束日期，限定查询1天数据，end_date允许设置的最大值为昨日，如：20170312
访问分析：周趋势
AccessToken或AppId（推荐使用AppId，需要先注册）
开始日期，为周一日期，如：20170306
结束日期，为周日日期，限定查询一周数据，如：20170312
访问分析：访问分布
AccessToken或AppId（推荐使用AppId，需要先注册）
开始日期，如：20170313
结束日期，限定查询1天数据，end_date允许设置的最大值为昨日，如：20170312
访问分析：访问留存-日留存
AccessToken或AppId（推荐使用AppId，需要先注册）
开始日期，如：20170313
结束日期，限定查询1天数据，end_date允许设置的最大值为昨日，如：20170312
访问分析：访问留存-周留存
AccessToken或AppId（推荐使用AppId，需要先注册）
开始日期，为周一日期，如：20170306
结束日期，为周日日期，限定查询一周数据，如：20170312
访问分析：访问留存-月留存
AccessToken或AppId（推荐使用AppId，需要先注册）
开始日期，为自然月第一天，如：20170201
结束日期，为自然月最后一天，限定查询一个月数据，如：20170228
访问分析：访问页面。
注意：目前只提供按 page_visit_pv 排序的 top200
AccessToken或AppId（推荐使用AppId，需要先注册）
开始日期，如：20170313
结束日期，限定查询1天数据，end_date允许设置的最大值为昨日，如：20170313
访问分析：用户画像。
注：
1、部分用户属性数据缺失，属性值可能出现 “未知”。
2、机型数据无 id 字段，暂只提供用户数最多的 top20。
AccessToken或AppId（推荐使用AppId，需要先注册）
开始日期，如：2017-06-11
结束日期，开始日期与结束日期相差的天数限定为0/6/29，分别表示查询最近1/7/30天数据，end_date允许设置的最大值为昨日，如：2017-06-17
【异步方法】概况趋势
开始日期，如：20170313
结束日期，限定查询1天数据，end_date允许设置的最大值为昨日，如：20170312
【异步方法】访问分析：日趋势
AccessToken或AppId（推荐使用AppId，需要先注册）
开始日期，如：20170313
结束日期，限定查询1天数据，end_date允许设置的最大值为昨日，如：20170312
【异步方法】访问分析：周趋势
AccessToken或AppId（推荐使用AppId，需要先注册）
开始日期，为周一日期，如：20170306
结束日期，为周日日期，限定查询一周数据，如：20170312
【异步方法】访问分析：访问分布
AccessToken或AppId（推荐使用AppId，需要先注册）
开始日期，如：20170313
结束日期，限定查询1天数据，end_date允许设置的最大值为昨日，如：20170312
【异步方法】访问分析：访问留存-日留存
AccessToken或AppId（推荐使用AppId，需要先注册）
开始日期，如：20170313
结束日期，限定查询1天数据，end_date允许设置的最大值为昨日，如：20170312
【异步方法】访问分析：访问留存-周留存
AccessToken或AppId（推荐使用AppId，需要先注册）
开始日期，为周一日期，如：20170306
结束日期，为周日日期，限定查询一周数据，如：20170312
【异步方法】访问分析：访问留存-月留存
AccessToken或AppId（推荐使用AppId，需要先注册）
开始日期，为自然月第一天，如：20170201
结束日期，为自然月最后一天，限定查询一个月数据，如：20170228
【异步方法】访问分析：访问页面。
注意：目前只提供按 page_visit_pv 排序的 top200
AccessToken或AppId（推荐使用AppId，需要先注册）
开始日期，如：20170313
结束日期，限定查询1天数据，end_date允许设置的最大值为昨日，如：20170313
【异步方法】访问分析：用户画像。
注：
1、部分用户属性数据缺失，属性值可能出现 “未知”。
2、机型数据无 id 字段，暂只提供用户数最多的 top20。
AccessToken或AppId（推荐使用AppId，需要先注册）
开始日期，如：2017-06-11
结束日期，开始日期与结束日期相差的天数限定为0/6/29，分别表示查询最近1/7/30天数据，end_date允许设置的最大值为昨日，如：2017-06-17
小程序“数据分析”接口 - 访问留存：周留存 返回结果
时间。
日存留如："20170313"；
周存留如："20170306-20170312"；
月存留如："201702"。
新增用户留存
活跃用户留存
公共类：小程序“数据分析”接口 - 访问留存：日/周/月留存 返回结果 - visit_uv及相关属性
标识。
日留存：0开始，0表示当天，1表示1天后，依此类推，key取值分别是：0,1,2,3,4,5,6,7,14,30；
周留存：0开始，0表示当周，1表示1周后，依此类推，key取值分别是：0,1,2,3,4；
月留存：标识，0开始，0表示当月，1表示1月后，key取值分别是：0,1。
key对应日期的新增用户数/活跃用户数（key=0时）或留存用户数（k>0时）
小程序“数据分析”接口 - 概况趋势 返回结果
小程序“数据分析”接口 - 概况趋势 返回结果 - list
日期，如：20170313
累计用户数
转发次数
转发人数
小程序“数据分析”接口 - 访问趋势：日趋势 返回结果
小程序“数据分析”接口 - 访问趋势：日趋势 返回结果 - list
日期，如：20170313
打开次数
访问次数
访问人数
新用户数
人均停留时长 (浮点型，单位：秒)
次均停留时长 (浮点型，单位：秒)
平均访问深度 (浮点型)
小程序“数据分析”接口 - 访问趋势：月趋势 返回结果
小程序“数据分析”接口 - 访问趋势：月趋势 返回结果 - list
时间，如："201702"
打开次数（自然月内汇总）
访问次数（自然月内汇总）
访问人数（自然月内去重）
新用户数（自然月内去重）
人均停留时长 (浮点型，单位：秒)
次均停留时长 (浮点型，单位：秒)
平均访问深度 (浮点型)
小程序“数据分析”接口 - 用户画像 返回结果
时间范围,如： "20170611-20170617"
新用户
活跃用户
小程序“数据分析”接口 - 用户画像 返回结果 - visit_uv_new and visit_uv
省份，如北京、广东等
城市，如北京、广州等
性别，包括男、女、未知
终端类型，包括iPhone, android,其他
机型，如苹果iPhone6, OPPO R9等
年龄，包括17岁以下、18-24岁等区间
小程序“数据分析”接口 - 用户画像 返回结果 - visit_uv_new and visit_uv 每一项属性
属性值id
属性值名称，与id一一对应。如属性为province时，返回的属性值名称包括“广东”等
属性值对应的指标值，如指标为visit_uv,属性为province,属性值为"广东省”，value对应广东地区的活跃用户数
小程序“数据分析”接口 - 访问趋势：访问分布 返回结果
时间： 如： "20170313"
小程序“数据分析”接口 - 访问趋势：访问分布 返回结果 - list
分布类型
访问次数（自然周内汇总）
小程序“数据分析”接口 - 访问趋势：访问分布 返回结果 - list - index 枚举
访问来源分布
访问时长分布
访问深度的分布
小程序“数据分析”接口 - 访问趋势：访问分布 返回结果 - list - item_list
场景 id
value 场景下的值（均为整数型）
该场景 id 访问 uv
小程序“数据分析”接口 - 访问页面 返回结果
时间，如："20170313"
小程序“数据分析”接口 - 访问页面 返回结果 - list
页面路径
访问次数
访问人数
次均停留时长
进入页次数
退出页次数
转发次数
转发人数
小程序“数据分析”接口 - 访问趋势：周趋势 返回结果
小程序“数据分析”接口 - 访问趋势：周趋势 返回结果 - list
时间，如："20170306-20170312"
打开次数（自然周内汇总）
访问次数（自然周内汇总）
访问人数（自然周内去重）
新用户数（自然周内去重）
人均停留时长 (浮点型，单位：秒)
次均停留时长 (浮点型，单位：秒)
平均访问深度 (浮点型)
即时配送接口
获取已支持的配送公司列表接口
AccessToken或AppId（推荐使用AppId，需要先注册）
代理请求超时时间（毫秒）
拉取已绑定账号
AccessToken或AppId（推荐使用AppId，需要先注册）
代理请求超时时间（毫秒）
第三方代商户发起绑定配送公司帐号的请求
AccessToken或AppId（推荐使用AppId，需要先注册）
配送公司ID
代理请求超时时间（毫秒）
第三方代商户发起开通即时配送权限
AccessToken或AppId（推荐使用AppId，需要先注册）
代理请求超时时间（毫秒）
预下配送单接口
AccessToken或AppId（推荐使用AppId，需要先注册）
请求数据
代理请求超时时间（毫秒）
预取消配送单接口
AccessToken或AppId（推荐使用AppId，需要先注册）
请求数据
代理请求超时时间（毫秒）
下配送单接口
AccessToken或AppId（推荐使用AppId，需要先注册）
请求数据
代理请求超时时间（毫秒）
取消配送单接口
AccessToken或AppId（推荐使用AppId，需要先注册）
请求数据
代理请求超时时间（毫秒）
重新下单
AccessToken或AppId（推荐使用AppId，需要先注册）
请求数据
代理请求超时时间（毫秒）
拉取配送单信息
AccessToken或AppId（推荐使用AppId，需要先注册）
请求数据
代理请求超时时间（毫秒）
可以对待接单状态的订单增加小费。需要注意：订单的小费，以最新一次加小费动作的金额为准，故下一次增加小费额必须大于上一次小费额
AccessToken或AppId（推荐使用AppId，需要先注册）
请求数据
代理请求超时时间（毫秒）
异常件退回商家商家确认收货接口
AccessToken或AppId（推荐使用AppId，需要先注册）
请求数据
代理请求超时时间（毫秒）
模拟配送公司更新配送单状态, 该接口用于测试账户下的单，将请求转发到运力测试环境
AccessToken或AppId（推荐使用AppId，需要先注册）
请求数据
代理请求超时时间（毫秒）
模拟配送公司更新配送单状态, 该接口只用于沙盒环境，即订单并没有真实流转到运力方
AccessToken或AppId（推荐使用AppId，需要先注册）
请求数据
代理请求超时时间（毫秒）
获取已支持的配送公司列表接口
AccessToken或AppId（推荐使用AppId，需要先注册）
代理请求超时时间（毫秒）
拉取已绑定账号
AccessToken或AppId（推荐使用AppId，需要先注册）
代理请求超时时间（毫秒）
第三方代商户发起绑定配送公司帐号的请求
AccessToken或AppId（推荐使用AppId，需要先注册）
配送公司ID
代理请求超时时间（毫秒）
第三方代商户发起开通即时配送权限
AccessToken或AppId（推荐使用AppId，需要先注册）
代理请求超时时间（毫秒）
预下配送单接口
AccessToken或AppId（推荐使用AppId，需要先注册）
请求数据
代理请求超时时间（毫秒）
预取消配送单接口
AccessToken或AppId（推荐使用AppId，需要先注册）
请求数据
代理请求超时时间（毫秒）
下配送单接口
AccessToken或AppId（推荐使用AppId，需要先注册）
请求数据
代理请求超时时间（毫秒）
取消配送单接口
AccessToken或AppId（推荐使用AppId，需要先注册）
请求数据
代理请求超时时间（毫秒）
重新下单
AccessToken或AppId（推荐使用AppId，需要先注册）
请求数据
代理请求超时时间（毫秒）
拉取配送单信息
AccessToken或AppId（推荐使用AppId，需要先注册）
请求数据
代理请求超时时间（毫秒）
可以对待接单状态的订单增加小费。需要注意：订单的小费，以最新一次加小费动作的金额为准，故下一次增加小费额必须大于上一次小费额
AccessToken或AppId（推荐使用AppId，需要先注册）
请求数据
代理请求超时时间（毫秒）
异常件退回商家商家确认收货接口
AccessToken或AppId（推荐使用AppId，需要先注册）
请求数据
代理请求超时时间（毫秒）
模拟配送公司更新配送单状态, 该接口用于测试账户下的单，将请求转发到运力测试环境
AccessToken或AppId（推荐使用AppId，需要先注册）
请求数据
代理请求超时时间（毫秒）
模拟配送公司更新配送单状态, 该接口只用于沙盒环境，即订单并没有真实流转到运力方
AccessToken或AppId（推荐使用AppId，需要先注册）
请求数据
代理请求超时时间（毫秒）
商家id， 由配送公司分配的appkey
唯一标识订单的 ID，由商户生成, 不超过128字节
商家门店编号，在配送公司登记，美团、闪送必填
用配送公司提供的appSecret加密的校验串说明
配送单id
用配送公司提供的appSecret加密的校验串说明
预下单接口返回的参数，配送公司可保证在一段时间内运费不变
非必填
商家id， 由配送公司分配的appkey
唯一标识订单的 ID，由商户生成, 不超过128字节
商家门店编号，在配送公司登记，美团、闪送必填
用配送公司提供的appSecret加密的校验串说明
配送公司ID
下单用户的openid
发件人信息，闪送、顺丰同城急送必须填写，美团配送、达达，若传了shop_no的值可不填该字段
收件人信息
货物信息
订单信息
商品信息，会展示到物流通知消息中
子商户id，区分小程序内部多个子商户
商家id， 由配送公司分配的appkey
唯一标识订单的 ID，由商户生成, 不超过128字节
商家门店编号，在配送公司登记，美团、闪送必填
用配送公司提供的appSecret加密的校验串说明
配送单id
下单用户的openid
小费金额(单位：元) 各家配送公司最大值不同
用配送公司提供的appSecret加密的校验串说明
商家id， 由配送公司分配的appkey
唯一标识订单的 ID，由商户生成, 不超过128字节
商家门店编号，在配送公司登记，美团、闪送必填
用配送公司提供的appSecret加密的校验串说明
配送公司ID
配送单id
取消原因id
取消原因
商家id， 由配送公司分配的appkey
唯一标识订单的 ID，由商户生成, 不超过128字节
商家门店编号，在配送公司登记，美团、闪送必填
用配送公司提供的appSecret加密的校验串说明
实际运费(单位：元)，运费减去优惠券费用
运费(单位：元)
优惠券费用(单位：元)
小费(单位：元)
保价费(单位：元)
配送距离(整数单位：米)
配送单号
配送状态
收货码
取货码
预计骑手接单时间，单位秒，比如5分钟，就填300, 无法预计填0
扣除的违约金(单位：元)，精确到分
说明
运力返回的错误码
运力返回的错误描述
获取已支持的配送公司列表接口
配送公司列表
配送公司Id
配送公司名称
拉取已绑定账号
绑定的商家签约账号列表
配送公司Id
商家id
审核状态
配送状态
配送单号
骑手姓名
骑手电话
骑手位置经度, 配送中时返回
骑手位置纬度, 配送中时返回
预计还剩多久送达时间, 配送中时返回，单位秒， 已取货配送中需返回，比如5分钟后送达，填300
实际运费(单位：元)，运费减去优惠券费用
运费(单位：元)
优惠券费用(单位：元)
小费(单位：元)
保价费(单位：元)
配送距离(整数单位：米)
预计骑手接单时间，单位秒，比如5分钟，就填300, 无法预计填0
配送公司可以返回此字段，当用户下单时候带上这个字段，保证在一段时间内运费不变
扣除的违约金(单位：元)，精确到分
说明
实际运费(单位：元)，运费减去优惠券费用
运费(单位：元)
优惠券费用(单位：元)
小费(单位：元)
保价费(单位：元)
配送距离(整数单位：米)
配送单号
配送状态
收货码
取货码
预计骑手接单时间，单位秒，比如5分钟，就填300, 无法预计填0
商家id， 由配送公司分配的appkey
唯一标识订单的 ID，由商户生成, 不超过128字节
状态变更时间点，Unix秒级时间戳
配送状态，枚举值
附加信息
非必填
商家id， 由配送公司分配的appkey
唯一标识订单的 ID，由商户生成, 不超过128字节
商家门店编号，在配送公司登记，美团、闪送必填
用配送公司提供的appSecret加密的校验串说明
配送公司ID
下单用户的openid
发件人信息，闪送、顺丰同城急送必须填写，美团配送、达达，若传了shop_no的值可不填该字段
收件人信息
货物信息
订单信息
商品信息，会展示到物流通知消息中
子商户id，区分小程序内部多个子商户
姓名，最长不超过256个字符
城市名称，如广州市
地址(街道、小区、大厦等，用于定位)
地址详情(楼号、单元号、层号)
电话/手机号，最长不超过64个字符
经度（火星坐标或百度坐标，和 coordinate_type 字段配合使用，确到小数点后6位
纬度（火星坐标或百度坐标，和 coordinate_type 字段配合使用，精确到小数点后6位）
坐标类型，0：火星坐标（高德，腾讯地图均采用火星坐标） 1：百度坐标
姓名，最长不超过256个字符
城市名称，如广州市
地址(街道、小区、大厦等，用于定位)
地址详情(楼号、单元号、层号)
电话/手机号，最长不超过64个字符
经度（火星坐标或百度坐标，和 coordinate_type 字段配合使用，确到小数点后6位
纬度（火星坐标或百度坐标，和 coordinate_type 字段配合使用，精确到小数点后6位）
坐标类型，0：火星坐标（高德，腾讯地图均采用火星坐标） 1：百度坐标
货物价格，单位为元，精确到小数点后两位（如果小数点后位数多于两位，则四舍五入保留两位小数），范围为(0-5000]
货物高度，单位为cm，精确到小数点后两位（如果小数点后位数多于两位，则四舍五入保留两位小数），范围为(0-45]
非必填
货物长度，单位为cm，精确到小数点后两位（如果小数点后位数多于两位，则四舍五入保留两位小数），范围为(0-65]
非必填
货物宽度，单位为cm，精确到小数点后两位（如果小数点后位数多于两位，则四舍五入保留两位小数），范围为(0-50]
非必填
货物重量，单位为kg，精确到小数点后两位（如果小数点后位数多于两位，则四舍五入保留两位小数），范围为(0-50]
货物详情，最长不超过10240个字符
非必填
货物取货信息，用于骑手到店取货，最长不超过100个字符
非必填
货物交付信息，最长不超过100个字符
非必填
品类一级类目, 详见品类表
品类二级类目
货物数量
货品名称
货品单价，精确到小数点后两位（如果小数点后位数多于两位，则四舍五入保留两位小数）
非必填
货品单位，最长不超过20个字符
非必填
均非必填
配送服务代码 不同配送公司自定义, 顺丰和达达不填
非必填
订单类型, 0: 即时单 1 预约单，如预约单，需要设置expected_delivery_time或expected_finish_time或expected_pick_time
非必填
期望派单时间(美团、达达支持，美团表示商家发单时间，达达表示系统调度时间, 到那个时间才会有状态更新的回调通知)，unix-timestamp, 比如1586342180
非必填
期望送达时间(顺丰同城急送支持），unix-timestamp, 比如1586342180
非必填
期望取件时间（闪送、顺丰同城急送支持，闪送需要设置两个小时后的时间，顺丰同城急送只需传expected_finish_time或expected_pick_time其中之一即可，同时都传则以expected_finish_time为准），unix-timestamp, 比如1586342180
门店订单流水号，建议提供，方便骑手门店取货，最长不超过32个字符
备注，最长不超过200个字符
用户下单付款时间, 比如1555220757
是否保价，0，非保价，1.保价
保价金额，单位为元，精确到分
小费，单位为元, 下单一般不加小费
是否选择直拿直送（0：不需要；1：需要。选择直拿直送后，同一时间骑手只能配送此订单至完成，配送费用也相应高一些，闪送必须选1，达达可选0或1，其余配送公司不支持直拿直送）
骑手应付金额，单位为元，精确到分
骑手应收金额，单位为元，精确到分
物流流向，1：从门店取件送至用户；2：从用户取件送至门店
收货码（0：不需要；1：需要。收货码的作用是：骑手必须输入收货码才能完成订单妥投）
非必填
取货码（0：不需要；1：需要。取货码的作用是：骑手必须输入取货码才能从商家取货）
非必填
商家小程序的路径，建议为订单页面
商品缩略图 url
商品名称
商品数量
若结算方式为：第三方向配送公司统一结算，商户后续和第三方结算，则该参数必填；在该结算模式下，第三方用自己的开发小程序替授权商户发起下单，并将授权小程序的appid给平台，后续配送通知中可回流授权商户小程序
商家id， 由配送公司分配的appkey
唯一标识订单的 ID，由商户生成, 不超过128字节
商家门店编号，在配送公司登记，美团、闪送必填
用配送公司提供的appSecret加密的校验串说明
配送公司ID
配送单id
取消原因id
取消原因
商家id， 由配送公司分配的appkey
唯一标识订单的 ID，由商户生成, 不超过128字节
状态变更时间点，Unix秒级时间戳
配送状态，枚举值
附加信息
非必填
用配送公司提供的appSecret加密的校验串说明
预下单接口返回的参数，配送公司可保证在一段时间内运费不变
非必填
商家id， 由配送公司分配的appkey
唯一标识订单的 ID，由商户生成, 不超过128字节
商家门店编号，在配送公司登记，美团、闪送必填
用配送公司提供的appSecret加密的校验串说明
配送公司ID
下单用户的openid
发件人信息，闪送、顺丰同城急送必须填写，美团配送、达达，若传了shop_no的值可不填该字段
收件人信息
货物信息
订单信息
商品信息，会展示到物流通知消息中
子商户id，区分小程序内部多个子商户
小程序订阅消息接口
发送订阅消息
AccessToken或AppId（推荐使用AppId，需要先注册）
接收者（用户）的 openid
所需下发的订阅模板id
模板内容，格式形如 { "key1": { "value": any }, "key2": { "value": any } }
点击模板卡片后的跳转页面，仅限本小程序内的页面。支持带参数,（示例index?foo=bar）。该字段不填则模板无跳转。
跳转小程序类型：developer为开发版；trial为体验版；formal为正式版；默认为正式版
进入小程序查看”的语言类型，支持zh_CN(简体中文)、en_US(英文)、zh_HK(繁体中文)、zh_TW(繁体中文)，默认为zh_CN
【异步方法】发送订阅消息
AccessToken或AppId（推荐使用AppId，需要先注册）
接收者（用户）的 openid
所需下发的订阅模板id
模板内容，格式形如 { "key1": { "value": any }, "key2": { "value": any } }
点击模板卡片后的跳转页面，仅限本小程序内的页面。支持带参数,（示例index?foo=bar）。该字段不填则模板无跳转。
跳转小程序类型：developer为开发版；trial为体验版；formal为正式版；默认为正式版
进入小程序查看”的语言类型，支持zh_CN(简体中文)、en_US(英文)、zh_HK(繁体中文)、zh_TW(繁体中文)，默认为zh_CN
获取已设置的二维码规则
请求超时时间
获取校验文件名称及内容
通过本接口下载随机校验文件，并将文件上传至服务器指定位置的目录下，方可通过所属权校验。
验证文件放置规则：放置于 URL 中声明的最后一级子目录下，若无子目录，则放置于 host 所属服务器的顶层目录下。
请求超时时间
增加或修改二维码规则
二维码规则
是否独占符合二维码前缀匹配规则的所有子规 1 为不占用，2 为占用;
小程序功能页面
测试范围1开发版（配置只对开发者生效）,2体验版（配置对管理员、体验者生效),3正式版（配置对开发者、管理员和体验者生效）
编辑标志位，0 表示新增二维码规则，1 表示修改已有二维码规则
测试链接，至多 5 个用于测试的二维码完整链接，此链接必须符合已填写的二维码规则。
请求超时时间
发布已设置的二维码规则
需要先添加二维码规则，然后调用本接口将二维码规则发布生效，发布后现网用户扫码命中改规则的普通链接二维码时将调整到正式版小程序指定的页面。
二维码规则
请求超时时间
删除已设置的二维码规则
二维码规则
请求超时时间
【异步方法】获取已设置的二维码规则
请求超时时间
【异步方法】获取校验文件名称及内容
通过本接口下载随机校验文件，并将文件上传至服务器指定位置的目录下，方可通过所属权校验。
验证文件放置规则：放置于 URL 中声明的最后一级子目录下，若无子目录，则放置于 host 所属服务器的顶层目录下。
请求超时时间
【异步方法】增加或修改二维码规则
二维码规则
是否独占符合二维码前缀匹配规则的所有子规 1 为不占用，2 为占用;
小程序功能页面
测试范围1开发版（配置只对开发者生效）,2体验版（配置对管理员、体验者生效),3正式版（配置对开发者、管理员和体验者生效）
编辑标志位，0 表示新增二维码规则，1 表示修改已有二维码规则
测试链接，至多 5 个用于测试的二维码完整链接，此链接必须符合已填写的二维码规则。
请求超时时间
【异步方法】发布已设置的二维码规则
需要先添加二维码规则，然后调用本接口将二维码规则发布生效，发布后现网用户扫码命中改规则的普通链接二维码时将调整到正式版小程序指定的页面。
二维码规则
请求超时时间
【异步方法】删除已设置的二维码规则
二维码规则
请求超时时间
文件名称
文件内容
获取已设置的普通链接二维码规则结果
是否已经打开二维码跳转链接设置
本月还可发布的次数
二维码规则数量
二维码规则详情
二维码规则
是否独占符合二维码前缀匹配规则的所有子规 1 为不占用，2 为占用;
小程序功能页面
测试范围1开发版（配置只对开发者生效）,2体验版（配置对管理员、体验者生效),3正式版（配置对开发者、管理员和体验者生效）
测试链接（选填）可填写不多于 5 个用于测试的二维码完整链接，此链接必须符合已填写的二维码规则。
发布标志位，1 表示未发布，2 表示已发布
WxApp接口
code 换取 session_key
保持默认：authorization_code
请求超时时间
【异步方法】code 换取 session_key
保持默认：authorization_code
请求超时时间
JsCode2Json接口结果
用户唯一标识
会话密钥
用户在开放平台的唯一标识符。本字段在满足一定条件的情况下才返回。具体参看：https://mp.weixin.qq.com/debug/wxadoc/dev/api/uinionID.html
云函数
注意: HTTP API 途径触发云函数不包含用户信息
触发云函数。注意：HTTP API 途径触发云函数不包含用户信息。
接口调用凭证
云开发环境ID
云函数名称
云函数的传入参数，具体结构由开发者定义。
数据库导入
接口调用凭证
云环境ID
导入collection名
导入文件路径(导入文件需先上传到同环境的存储中，可使用开发者工具或 HTTP API的上传文件 API上传）
导入文件类型，文件格式参考数据库导入指引中的文件格式部分
是否在遇到错误时停止导入
冲突处理模式
数据库导出
接口调用凭证
云环境ID
导出文件路径（文件会导出到同环境的云存储中，可使用获取下载链接 API 获取下载链接）
导出文件类型，文件格式参考数据库导入指引中的文件格式部分
导出条件
数据库迁移状态查询
接口调用凭证
云环境ID
迁移任务ID
变更数据库索引
接口调用凭证
云环境ID
集合名称
新增索引
删除索引
新增集合
接口调用凭证
云环境ID
集合名称
删除集合
接口调用凭证
云环境ID
集合名称
获取特定云环境下集合信息
接口调用凭证
云环境ID
获取数量限制
偏移量
数据库插入记录
接口调用凭证
云环境ID
数据库操作语句
数据库删除记录
接口调用凭证
云环境ID
数据库操作语句
数据库更新记录
接口调用凭证
云环境ID
数据库操作语句
数据库查询记录
接口调用凭证
云环境ID
数据库操作语句
数据库聚合
接口调用凭证
云环境ID
数据库操作语句
统计集合记录数或统计查询语句对应的结果记录数
接口调用凭证
云环境ID
数据库操作语句
获取文件上传链接
接口调用凭证
云环境ID
上传路径
获取文件下载链接
接口调用凭证
云环境ID
文件列表
删除文件
接口调用凭证
云环境ID
文件ID列表
获取腾讯云API调用凭证
接口调用凭证
有效期（单位为秒，最大7200）
【异步方法】触发云函数。注意：HTTP API 途径触发云函数不包含用户信息。
接口调用凭证
云开发环境ID
云函数名称
云函数的传入参数，具体结构由开发者定义。
【异步方法】数据库导入
接口调用凭证
云环境ID
导入collection名
导入文件路径(导入文件需先上传到同环境的存储中，可使用开发者工具或 HTTP API的上传文件 API上传）
导入文件类型，文件格式参考数据库导入指引中的文件格式部分
是否在遇到错误时停止导入
冲突处理模式
【异步方法】数据库导出
接口调用凭证
云环境ID
导出文件路径（文件会导出到同环境的云存储中，可使用获取下载链接 API 获取下载链接）
导出文件类型，文件格式参考数据库导入指引中的文件格式部分
导出条件
【异步方法】数据库迁移状态查询
接口调用凭证
云环境ID
迁移任务ID
【异步方法】变更数据库索引
接口调用凭证
云环境ID
集合名称
新增索引
删除索引
【异步方法】新增集合
接口调用凭证
云环境ID
集合名称
【异步方法】删除集合
接口调用凭证
云环境ID
集合名称
【异步方法】获取特定云环境下集合信息
接口调用凭证
云环境ID
获取数量限制
偏移量
【异步方法】数据库插入记录
接口调用凭证
云环境ID
数据库操作语句
【异步方法】数据库删除记录
接口调用凭证
云环境ID
数据库操作语句
【异步方法】数据库更新记录
接口调用凭证
云环境ID
数据库操作语句
【异步方法】数据库查询记录
接口调用凭证
云环境ID
数据库操作语句
【异步方法】数据库聚合
接口调用凭证
云环境ID
数据库操作语句
【异步方法】统计集合记录数或统计查询语句对应的结果记录数
接口调用凭证
云环境ID
数据库操作语句
【异步方法】获取文件上传链接
接口调用凭证
云环境ID
上传路径
【异步方法】获取文件下载链接
接口调用凭证
云环境ID
文件列表
【异步方法】删除文件
接口调用凭证
云环境ID
文件ID列表
获取腾讯云API调用凭证
接口调用凭证
有效期（单位为秒，最大7200）
新增索引
索引名
是否唯一
索引字段
索引字段
字段名
字段排序
"1" 升序
"-1" 降序
"2dsphere" 地理位置
删除索引
索引名
云函数返回的buffer
集合信息
分页信息
偏移
单次查询限制
符合查询条件的记录总数
集合名
表中文档数量
表的大小（即表中文档总大小），单位：字节
索引数量
索引占用大小，单位：字节
数据库插入记录 返回结果
插入成功的数据集合主键_id。
数据库删除记录 返回结果
删除记录数量
数据库更新记录 返回结果
更新条件匹配到的结果数
修改的记录数，注意：使用set操作新插入的数据不计入修改数目
新插入记录的id，注意：只有使用set操作新插入数据时这个字段会有值
数据库查询记录 返回结果
分页信息
记录数组
数据库聚合 返回结果
记录数组
统计集合记录数或统计查询语句对应的结果记录数 返回结果
记录数量
数据库导入/导出 返回结果
任务ID，可使用数据库迁移进度查询 API 查询进度及结果
数据库迁移状态查询 返回结果
导出状态
导出成功记录数
导出失败记录数
导出错误信息
导出文件下载地址
获取文件上传链接 返回结果
上传url
文件ID
cos文件ID
获取文件下载链接 返回结果
文件列表
删除文件 返回结果
文件列表
文件ID
下载链接
状态码
该文件错误信息
文件ID
下载链接有效期
获取腾讯云API调用凭证 返回结果
过期时间戳
模板消息接口
小程序模板消息接口
AccessToken或AppId（推荐使用AppId，需要先注册）
模板需要放大的关键词，不填则默认无放大
模板内容字体的颜色，不填默认黑色（非必填）
代理请求超时时间（毫秒）
表单提交场景下，为 submit 事件带上的 formId；支付场景下，为本次支付的 prepay_id
点击模板查看详情跳转页面，不填则模板无跳转（非必填）
下发小程序和公众号统一的服务消息
获取小程序模板库标题列表
接口调用凭证
offset和count用于分页，表示从offset开始，拉取count条记录，offset从0开始，count最大为20。
offset和count用于分页，表示从offset开始，拉取count条记录，offset从0开始，count最大为20。
请求超时时间
获取模板库某个模板标题下关键词库
接口调用凭证
模板标题id，可通过接口获取，也可登录小程序后台查看获取
请求超时时间
组合模板并添加至帐号下的个人模板库
接口调用凭证
模板标题id，可通过接口获取，也可登录小程序后台查看获取
开发者自行组合好的模板关键词列表，关键词顺序可以自由搭配（例如[3,5,4]或[4,5,3]），最多支持10个关键词组合
请求超时时间
获取帐号下已存在的模板列表
接口调用凭证
offset和count用于分页，表示从offset开始，拉取count条记录，offset从0开始，count最大为20。最后一页的list长度可能小于请求的count
offset和count用于分页，表示从offset开始，拉取count条记录，offset从0开始，count最大为20。最后一页的list长度可能小于请求的count
请求超时时间
删除帐号下的某个模板
接口调用凭证
要删除的模板id
请求超时时间
【异步方法】小程序模板消息接口
AccessToken或AppId（推荐使用AppId，需要先注册）
模板需要放大的关键词，不填则默认无放大
模板内容字体的颜色，不填默认黑色（非必填）
代理请求超时时间（毫秒）
表单提交场景下，为 submit 事件带上的 formId；支付场景下，为本次支付的 prepay_id
点击模板查看详情跳转页面，不填则模板无跳转（非必填）
【异步方法】下发小程序和公众号统一的服务消息
【异步方法】获取小程序模板库标题列表
接口调用凭证
offset和count用于分页，表示从offset开始，拉取count条记录，offset从0开始，count最大为20。
offset和count用于分页，表示从offset开始，拉取count条记录，offset从0开始，count最大为20。
请求超时时间
【异步方法】获取模板库某个模板标题下关键词库
接口调用凭证
模板标题id，可通过接口获取，也可登录小程序后台查看获取
请求超时时间
【异步方法】组合模板并添加至帐号下的个人模板库
接口调用凭证
模板标题id，可通过接口获取，也可登录小程序后台查看获取
开发者自行组合好的模板关键词列表，关键词顺序可以自由搭配（例如[3,5,4]或[4,5,3]），最多支持10个关键词组合
请求超时时间
【异步方法】获取帐号下已存在的模板列表
接口调用凭证
offset和count用于分页，表示从offset开始，拉取count条记录，offset从0开始，count最大为20。最后一页的list长度可能小于请求的count
offset和count用于分页，表示从offset开始，拉取count条记录，offset从0开始，count最大为20。最后一页的list长度可能小于请求的count
请求超时时间
【异步方法】删除帐号下的某个模板
接口调用凭证
要删除的模板id
请求超时时间
“获取模板库某个模板标题下关键词库”接口：Add 结果
添加至帐号下的模板id，发送小程序模板消息时所需
“获取模板库某个模板标题下关键词库”接口：LibraryGet 结果
关键词id，添加模板时需要
关键词内容
关键词内容对应的示例
“获取小程序模板库标题列表”接口：LibraryList 结果
模板库标题总数
模板标题id（获取模板标题下的关键词库时需要）
模板标题内容
“获取帐号下已存在的模板列表”接口：List 结果
帐号下的模板列表
模板id，发送小程序模板消息时所需
模板标题
模板内容
模板内容示例
模板消息Post数据
目标用户OpenId
模板ID
点击模板查看详情跳转页面，不填则模板无跳转（非必填）
表单提交场景下，为 submit 事件带上的 formId；支付场景下，为本次支付的 prepay_id
数据
模板需要放大的关键词，不填则默认无放大（非必填）
模板内容字体的颜色，不填默认黑色（非必填）
下发小程序和公众号统一的服务消息
（必须）用户openid，可以是小程序的openid，也可以是mp_template_msg.appid对应的公众号的openid
小程序模板消息相关的信息，可以参考小程序模板消息接口; 有此节点则优先发送小程序模板消息；（小程序模板消息已下线，不用传此节点）
（必须）公众号模板消息相关的信息，可以参考公众号模板消息接口；有此节点并且没有weapp_template_msg节点时，发送公众号模板消息
下发小程序和公众号统一的服务消息
（必须）用户openid，可以是小程序的openid，也可以是mp_template_msg.appid对应的公众号的openid
（必须）公众号模板消息相关的信息，可以参考公众号模板消息接口；有此节点并且没有weapp_template_msg节点时，发送公众号模板消息
（可选）小程序模板消息相关的信息，可以参考小程序模板消息接口; 有此节点则优先发送小程序模板消息；（小程序模板消息已下线，不用传此节点）
weappTemplateMsg
小程序模板ID
小程序页面路径
小程序模板消息formid
小程序模板数据
小程序模板放大关键词
weappTemplateMsg
小程序模板ID
小程序页面路径
小程序模板消息formid
小程序模板数据
小程序模板放大关键词
mpTemplateMsg
公众号appid，要求与小程序有绑定且同主体
公众号模板id
公众号模板消息所要跳转的url
公众号模板消息所要跳转的小程序，小程序的必须与公众号具有绑定关系，
可使用 或
公众号模板消息的数据
mpTemplateMsg
公众号appid，要求与小程序有绑定且同主体
公众号模板id
公众号模板消息所要跳转的url
公众号模板消息所要跳转的小程序，小程序的必须与公众号具有绑定关系，可使用 或
公众号模板消息的数据
Miniprogram 接口，用户可选择使用 page 或者 pagepath 参数，
可使用 或
小程序AppId
小程序信息（使用 page 参数）
小程序AppId
页面路径，如：index?foo=bar
小程序AppId
小程序AppId
页面路径，如：index?foo=bar，
小程序信息（使用 pagepath 参数）
小程序AppId
页面路径，如：index?foo=bar
小程序AppId
页面路径，如：index?foo=bar，
wxa/business 接口
code换取用户手机号。
每个code只能使用一次，code的有效期为5min
【异步方法】code换取用户手机号。
每个code只能使用一次，code的有效期为5min
code换取用户手机号 返回信息
小程序搜索
小程序开发者可以通过本接口提交小程序页面url及参数信息，让微信可以更及时的收录到小程序的页面信息，开发者提交的页面信息将可能被用于小程序搜索结果展示。
接口调用凭证
小程序页面信息列表
小程序开发者可以通过本接口提交小程序页面url及参数信息，让微信可以更及时的收录到小程序的页面信息，开发者提交的页面信息将可能被用于小程序搜索结果展示。
接口调用凭证
小程序页面信息列表
小程序二维码线条颜色（RGB颜色）
红色
绿色
蓝色
LineColor 构造函数
小程序搜索
小程序开发者可以通过本接口提交小程序页面url及参数信息，让微信可以更及时的收录到小程序的页面信息，开发者提交的页面信息将可能被用于小程序搜索结果展示。
接口调用凭证
小程序页面信息列表
小程序开发者可以通过本接口提交小程序页面url及参数信息，让微信可以更及时的收录到小程序的页面信息，开发者提交的页面信息将可能被用于小程序搜索结果展示。
接口调用凭证
小程序页面信息列表
页面路径
页面参数
小程序 Short Link
获取小程序 Short Link，适用于微信内拉起小程序的业务场景。目前只开放给电商类目(具体包含以下一级类目：电商平台、商家自营、跨境电商)。通过该接口，可以选择生成到期失效和永久有效的小程序短链，详见获取 Short Link。
接口调用凭证
（必须）通过 Short Link 进入的小程序页面路径，必须是已经发布的小程序存在的页面，可携带 query，最大1024个字符
（必须）页面标题，不能包含违法信息，超过20字符会用... 截断代替
生成的 Short Link 类型，短期有效：false，永久有效：true
获取小程序 Short Link，适用于微信内拉起小程序的业务场景。目前只开放给电商类目(具体包含以下一级类目：电商平台、商家自营、跨境电商)。通过该接口，可以选择生成到期失效和永久有效的小程序短链，详见获取 Short Link。
接口调用凭证
（必须）通过 Short Link 进入的小程序页面路径，必须是已经发布的小程序存在的页面，可携带 query，最大1024个字符
（必须）页面标题，不能包含违法信息，超过20字符会用... 截断代替
生成的 Short Link 类型，短期有效：false，永久有效：true
小程序 Short Link
（必填）云开发环境
静态网站自定义域名，不填则使用默认域名
云开发静态网站 H5 页面路径，不可携带 query
第三方批量代云开发时必填，表示创建该 env 的 appid （小程序/第三方平台）
UrlLinkApi.Generate() 接口返回结果
生成的小程序 URL Link
WxApp接口
获取小程序页面的小程序码
AccessToken或AppId（推荐使用AppId，需要先注册）
储存小程序码的流
不能为空，最大长度 128 字节（如：pages/index?query=1。注：pages/index 需要在 app.json 的 pages 中定义）
小程序码的宽度
自动配置线条颜色，如果颜色依然是黑色，则说明不建议配置主色调
auth_color 为 false 时生效，使用 rgb 设置颜色 例如 {"r":"xxx","g":"xxx","b":"xxx"}
是否需要透明底色， is_hyaline 为true时，生成透明底色的小程序码，默认为 false
请求超时时间
获取小程序页面的小程序码
AccessToken或AppId（推荐使用AppId，需要先注册）
储存图片的物理路径
不能为空，最大长度 128 字节（如：pages/index?query=1。注：pages/index 需要在 app.json 的 pages 中定义）
二维码的宽度
自动配置线条颜色，如果颜色依然是黑色，则说明不建议配置主色调
auth_color 为 false 时生效，使用 rgb 设置颜色 例如 {"r":"xxx","g":"xxx","b":"xxx"}
是否需要透明底色， is_hyaline 为true时，生成透明底色的小程序码，默认为 false
请求超时时间
获取小程序页面二维码
AccessToken或AppId（推荐使用AppId，需要先注册）
储存二维码的流
不能为空，最大长度 128 字节（如：pages/index?query=1。注：pages/index 需要在 app.json 的 pages 中定义）
二维码的宽度
请求超时时间
获取小程序页面二维码
AccessToken或AppId（推荐使用AppId，需要先注册）
储存图片的物理路径
不能为空，最大长度 128 字节（如：pages/index?query=1。注：pages/index 需要在 app.json 的 pages 中定义）
二维码的宽度
请求超时时间
session_key 合法性校验
https://mp.weixin.qq.com/debug/wxagame/dev/tutorial/http-signature.html
AccessToken或AppId（推荐使用AppId，需要先注册）
用户唯一标识符
用户登录态签名
托管数据，类型为字符串，长度不超过1000字节（官方文档没有提供说明，可留空）
用户登录态签名的哈希方法，默认为hmac_sha256
拉取门店小程序类目
申请门店小程序类目
此类目与小程序类目不同，需要单独申请，每个入驻附近的小程序只能申请一个类目
类目审核周期为1个工作日，请在期间内留意审核结果事件推送。提交后未当即返回事件推送即为审核中，请耐心等待。
一级类目id,必填,每个商家仅可选择一个一级类目
二级类目id,必填,每个商家仅可选择一个二级类目
类目资质证明,sensitive_type=1的类目，才需要填media_list
查询门店小程序类目信息
门店小程序拉取官方服务标签
从腾讯地图拉取省市区信息
在腾讯地图中搜索门店
在腾讯地图中创建门店
腾讯地图审核周期为3个工作日，请在期间内留意审核结果事件推送。提交后未当即返回事件推送即为审核中，请耐心等待
门店名字
经度
纬度
省份
城市
区
详细地址
类目，比如美食:中餐厅
电话，可多个，使用英文分号间隔
门店图片url
营业执照url
介绍
腾讯地图拉取省市区信息接口返回的id
如果是迁移门店， 必须填 mp_id字段
查看地点列表
AccessToken或AppId（推荐使用AppId，需要先注册）
起始页id（从1开始计数）
每页展示个数（最多1000个）
删除地点
AccessToken或AppId（推荐使用AppId，需要先注册）
附近地点ID
查询门店详情
门店的poi_id
展示/取消展示附近小程序
AccessToken或AppId（推荐使用AppId，需要先注册）
附近地点ID
0：取消展示；1：展示
异步校验图片/音频是否含有违法违规内容
https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/sec-check/security.mediaCheckAsync.html
AccessToken或AppId（推荐使用AppId，需要先注册）
要检测的图片或音频的url，支持图片格式包括 jpg , jepg, png, bmp, gif（取首帧），支持的音频格式包括mp3, aac, ac3, wma, flac, vorbis, opus, wav
1:音频;2:图片
接口版本号，2.0版本为固定值2
用户的openid（用户需在近两小时访问过小程序）
场景枚举值（1 资料；2 评论；3 论坛；4 社交日志）
检查一段文本是否含有违法违规内容
https://developers.weixin.qq.com/miniprogram/dev/api/msgSecCheck.html
AccessToken或AppId（推荐使用AppId，需要先注册）
要检测的文本内容，长度不超过 500KB，编码格式为utf-8
文本内容安全识别
该接口用于检查一段文本是否含有违法违规内容。
https://developers.weixin.qq.com/miniprogram/dev/OpenApiDoc/sec-center/sec-check/msgSecCheck.html
AccessToken或AppId（推荐使用AppId，需要先注册）
要检测的文本内容，长度不超过 500KB，编码格式为utf-8
接口版本号，2.0版本为固定值2
场景枚举值（1 资料；2 评论；3 论坛；4 社交日志）
用户的openid（用户需在近两小时访问过小程序）
非必填 文本标题，需使用UTF-8编码
非必填 用户昵称，需使用UTF-8编码
非必填 个性签名，该参数仅在资料类场景有效(scene=1)，需使用UTF-8编码
校验一张图片是否含有违法违规内容
https://developers.weixin.qq.com/miniprogram/dev/api/imgSecCheck.html
AccessToken或AppId（推荐使用AppId，需要先注册）
文件完整物理路径格式支持PNG、JPEG、JPG、GIF，图片尺寸不超过 750px * 1334px
向插件开发者发起使用插件的申请
https://developers.weixin.qq.com/miniprogram/dev/api/open-api/plugin-management/applyPlugin.html
AccessToken或AppId（推荐使用AppId，需要先注册）
获取当前所有插件使用方（供插件开发者调用）
https://developers.weixin.qq.com/miniprogram/dev/api/open-api/plugin-management/getPluginDevApplyList.html
AccessToken或AppId（推荐使用AppId，需要先注册）
修改插件使用申请的状态（供插件开发者调用）
https://developers.weixin.qq.com/miniprogram/dev/api/open-api/plugin-management/setDevPluginApplyStatus.html
AccessToken或AppId（推荐使用AppId，需要先注册）
查询已添加的插件
https://developers.weixin.qq.com/miniprogram/dev/api/open-api/plugin-management/getPluginList.html
AccessToken或AppId（推荐使用AppId，需要先注册）
删除已添加的插件
https://developers.weixin.qq.com/miniprogram/dev/api/open-api/plugin-management/unbindPlugin.html
AccessToken或AppId（推荐使用AppId，需要先注册）
风险用户扫描
快速发现使用小程序的风险用户，提升小程序运营安全
根据提交的用户信息数据获取用户的安全等级 risk_rank，无需用户授权。
https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/safety-control-capability/getuserriskrank.html
【异步方法】获取小程序页面的小程序码
AccessToken或AppId（推荐使用AppId，需要先注册）
储存图片的物理路径
不能为空，最大长度 128 字节（如：pages/index?query=1。注：pages/index 需要在 app.json 的 pages 中定义）
二维码的宽度
自动配置线条颜色
auth_color 为 false 时生效，使用 rgb 设置颜色 例如 {"r":"xxx","g":"xxx","b":"xxx"}
是否需要透明底色， is_hyaline 为true时，生成透明底色的小程序码，默认为 false
请求超时时间
【异步方法】获取小程序页面的小程序码
AccessToken或AppId（推荐使用AppId，需要先注册）
储存小程序码的流
不能为空，最大长度 128 字节（如：pages/index?query=1。注：pages/index 需要在 app.json 的 pages 中定义）
小程序码的宽度
自动配置线条颜色，如果颜色依然是黑色，则说明不建议配置主色调
auth_color 为 false 时生效，使用 rgb 设置颜色 例如 {"r":"xxx","g":"xxx","b":"xxx"}
是否需要透明底色， is_hyaline 为true时，生成透明底色的小程序码，默认为 false
请求超时时间
【异步方法】获取小程序页面二维码
AccessToken或AppId（推荐使用AppId，需要先注册）
储存二维码的流
不能为空，最大长度 128 字节（如：pages/index?query=1,注：pages/index 需要在 app.json 的 pages 中定义）
二维码的宽度
请求超时时间
【异步方法】获取小程序页面二维码
AccessToken或AppId（推荐使用AppId，需要先注册）
储存图片的物理路径
不能为空，最大长度 128 字节（如：pages/index?query=1。注：pages/index 需要在 app.json 的 pages 中定义）
二维码的宽度
请求超时时间
【异步方法】session_key 合法性校验
https://mp.weixin.qq.com/debug/wxagame/dev/tutorial/http-signature.html
AccessToken或AppId（推荐使用AppId，需要先注册）
用户唯一标识符
用户登录态签名
托管数据，类型为字符串，长度不超过1000字节（官方文档没有提供说明，可留空）
用户登录态签名的哈希方法，默认为hmac_sha256
【异步方法】拉取门店小程序类目
【异步方法】申请门店小程序类目
此类目与小程序类目不同，需要单独申请，每个入驻附近的小程序只能申请一个类目
类目审核周期为1个工作日，请在期间内留意审核结果事件推送。提交后未当即返回事件推送即为审核中，请耐心等待。
一级类目id,必填,每个商家仅可选择一个一级类目
二级类目id,必填,每个商家仅可选择一个二级类目
类目资质证明,sensitive_type=1的类目，才需要填media_list
【异步方法】查询门店小程序类目信息
【异步方法】门店小程序拉取官方服务标签
【异步方法】从腾讯地图拉取省市区信息
【异步方法】在腾讯地图中搜索门店
【异步方法】在腾讯地图中创建门店
腾讯地图审核周期为3个工作日，请在期间内留意审核结果事件推送。提交后未当即返回事件推送即为审核中，请耐心等待
门店名字
经度
纬度
省份
城市
区
详细地址
类目，比如美食:中餐厅
电话，可多个，使用英文分号间隔
门店图片url
营业执照url
介绍
腾讯地图拉取省市区信息接口返回的id
如果是迁移门店， 必须填 mp_id字段
【异步方法】查看地点列表
AccessToken或AppId（推荐使用AppId，需要先注册）
起始页id（从1开始计数）
每页展示个数（最多1000个）
【异步方法】删除地点
AccessToken或AppId（推荐使用AppId，需要先注册）
附近地点ID
【异步方法】展示/取消展示附近小程序
AccessToken或AppId（推荐使用AppId，需要先注册）
附近地点ID
0：取消展示；1：展示
【异步方法】查询门店详情
门店的poi_id
【异步方法】异步校验图片/音频是否含有违法违规内容
https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/sec-check/security.mediaCheckAsync.html
AccessToken或AppId（推荐使用AppId，需要先注册）
要检测的图片或音频的url，支持图片格式包括 jpg , jepg, png, bmp, gif（取首帧），支持的音频格式包括mp3, aac, ac3, wma, flac, vorbis, opus, wav
1:音频;2:图片
接口版本号，2.0版本为固定值2
用户的openid（用户需在近两小时访问过小程序）
场景枚举值（1 资料；2 评论；3 论坛；4 社交日志）
检查一段文本是否含有违法违规内容
https://developers.weixin.qq.com/miniprogram/dev/api/msgSecCheck.html
AccessToken或AppId（推荐使用AppId，需要先注册）
要检测的文本内容，长度不超过 500KB，编码格式为utf-8
文本内容安全识别
该接口用于检查一段文本是否含有违法违规内容。
https://developers.weixin.qq.com/miniprogram/dev/OpenApiDoc/sec-center/sec-check/msgSecCheck.html
AccessToken或AppId（推荐使用AppId，需要先注册）
要检测的文本内容，长度不超过 500KB，编码格式为utf-8
接口版本号，2.0版本为固定值2
场景枚举值（1 资料；2 评论；3 论坛；4 社交日志）
用户的openid（用户需在近两小时访问过小程序）
非必填 文本标题，需使用UTF-8编码
非必填 用户昵称，需使用UTF-8编码
非必填 个性签名，该参数仅在资料类场景有效(scene=1)，需使用UTF-8编码
【异步方法】校验一张图片是否含有违法违规内容
https://developers.weixin.qq.com/miniprogram/dev/api/imgSecCheck.html
AccessToken或AppId（推荐使用AppId，需要先注册）
文件完整物理路径格式支持PNG、JPEG、JPG、GIF，图片尺寸不超过 750px * 1334px
【异步方法】向插件开发者发起使用插件的申请
https://developers.weixin.qq.com/miniprogram/dev/api/open-api/plugin-management/applyPlugin.html
AccessToken或AppId（推荐使用AppId，需要先注册）
【异步方法】获取当前所有插件使用方（供插件开发者调用）
https://developers.weixin.qq.com/miniprogram/dev/api/open-api/plugin-management/getPluginDevApplyList.html
AccessToken或AppId（推荐使用AppId，需要先注册）
【异步方法】修改插件使用申请的状态（供插件开发者调用）
https://developers.weixin.qq.com/miniprogram/dev/api/open-api/plugin-management/setDevPluginApplyStatus.html
AccessToken或AppId（推荐使用AppId，需要先注册）
【异步方法】查询已添加的插件
https://developers.weixin.qq.com/miniprogram/dev/api/open-api/plugin-management/getPluginList.html
AccessToken或AppId（推荐使用AppId，需要先注册）
删除已添加的插件
https://developers.weixin.qq.com/miniprogram/dev/api/open-api/plugin-management/unbindPlugin.html
AccessToken或AppId（推荐使用AppId，需要先注册）
风险用户扫描
快速发现使用小程序的风险用户，提升小程序运营安全
根据提交的用户信息数据获取用户的安全等级 risk_rank，无需用户授权。
https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/safety-control-capability/getuserriskrank.html
添加地点返回结果
审核单ID
附近地点ID
经营资质证件号
在腾讯地图中创建门店返回结果
错误信息
从腾讯地图拉取省市区信息结果
三维数组，第一维表示省的信息，第二维表示市的信息，第三维表示区的信息
区域id，也叫做 districtid
省市区的名字
通过省的cidx，可以在 result[1] 中找到省下的所有市
拉取门店小程序类目结果
类目id
类目的级别
0或者1 sensitive_type=1：在申请类目时需要上传相关证件
Sensitive_type为1的类目需要提供的资质文件名称
添加地点返回结果
拉取官方服务标签结果
添加地点返回结果
true表示小程序没有被下架
0表示未申请类目，1 类目审核通过，2 类目审核中，3 类目审核失败
剩余可添加地点个数
最大可添加地点个数
地址列表的 JSON 格式字符串
拉取门店小程序类目信息结果
等于false表示从来没有申请过类目
审核ID
1 类目审核通过 2 类目审核中 3 类目审核失败
审核失败时，返回信息
如果数组大小等于2 ，第一个表示之前申请成功的类目，第二个表示当前正在审核中的类目
一级类目ID
二级类目ID
1审核中,2审核失败,3审核通过
审核ID
小程序appid(必填)
用户的openid(必填)
场景值，0:注册，1:营销作弊(必填)
用户手机号
用户访问源ip(必填)
用户邮箱地址
额外补充信息
用户风险等级
唯一请求标识，标记单次请求，用于匹配异步推送结果
文本是否含有违法违规内容返回结果
详细检测结果
唯一请求标识，标记单次请求
综合结果
策略类型
错误码，仅当该值为0时，该项结果有效
建议，有risky、pass、review三种值
命中标签枚举值，100 正常；10001 广告；20001 时政；20002 色情；20003 辱骂；20006 违法犯罪；20008 欺诈；20012 低俗；20013 版权；21000 其他
命中的自定义关键词
0-100，代表置信度，越高代表越有可能属于当前返回的标签（label）
建议，有risky、pass、review三种值
命中标签枚举值，100 正常；10001 广告；20001 时政；20002 色情；20003 辱骂；20006 违法犯罪；20008 欺诈；20012 低俗；20013 版权；21000 其他
获取当前所有插件使用方返回结果
在腾讯地图中搜索门店结果
门店名称
详细地址
经度
纬度
客服电话
从腾讯地图换取的位置点id， 即后面创建门店接口中的map_poi_id参数
Short Link 生成结果
Short Link
URL Scheme 接口
获取小程序scheme码
适用于短信、邮件、外部网页等拉起小程序的业务场景。通过该接口，可以选择生成到期失效和永久有效的小程序码，目前仅针对国内非个人主体的小程序开放，
详见
https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/url-scheme/urlscheme.generate.html
（必填）跳转到的目标小程序信息。
（非必填）生成的scheme码类型，到期失效：true，永久有效：false。
（非必填）到期失效的scheme码的失效时间，为Unix时间戳。生成的到期失效scheme码在该时间前有效。生成到期失效的scheme时必填。
【异步方法】获取小程序scheme码
适用于短信、邮件、外部网页等拉起小程序的业务场景。通过该接口，可以选择生成到期失效和永久有效的小程序码，目前仅针对国内非个人主体的小程序开放，
详见
https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/url-scheme/urlscheme.generate.html
（必填）跳转到的目标小程序信息。
（非必填）生成的scheme码类型，到期失效：true，永久有效：false。
（非必填）到期失效的scheme码的失效时间，为Unix时间戳。生成的到期失效scheme码在该时间前有效。生成到期失效的scheme时必填。
GenerateScheme() 接口返回参数
小程序scheme码
GenerateScheme() 接口中的 jumpWxa 参数
2021年1月6日更新公告：https://developers.weixin.qq.com/community/develop/doc/00060aa283430885398b44a7c5d001?blockType=1
（必填）通过scheme码进入的小程序页面路径，必须是已经发布的小程序存在的页面，不可携带query。path为空时会跳转小程序主页。
GenerateScheme() 接口中的 jumpWxa 参数
发送文本客服消息
发送图片客服消息
返回多图文消息（转成文字发送）
针对AccessToken无效或过期的自动处理类
使用AccessToken进行操作时，如果遇到AccessToken错误的情况，重新获取AccessToken一次，并重试。
使用此方法之前必须使用AccessTokenContainer.Register(_appId, _appSecret);或JsApiTicketContainer.Register(_appId, _appSecret);方法对账号信息进行过注册，否则会出错。
AccessToken或AppId。如果为null，则自动取已经注册的第一个appId/appSecret来信息获取AccessToken。
请保留默认值true，不用输入。
【异步方法】使用AccessToken进行操作时，如果遇到AccessToken错误的情况，重新获取AccessToken一次，并重试。
使用此方法之前必须使用AccessTokenContainer.Register(_appId, _appSecret);或JsApiTicketContainer.Register(_appId, _appSecret);方法对账号信息进行过注册，否则会出错。
AccessToken或AppId。如果为null，则自动取已经注册的第一个appId/appSecret来信息获取AccessToken。
请保留默认值true，不用输入。
小程序 AccessToken 包
小程序的通用接口 AccessToken 容器，用于自动管理 AccessToken，如果过期会重新获取
注册应用凭证信息，此操作只是注册，不会马上获取Token，并将清空之前的Token
微信小程序后台的【开发】>【基本配置】中的“AppID(应用ID)”
微信小程序后台的【开发】>【基本配置】中的“AppSecret(应用密钥)”
标记AccessToken名称（如微信小程序名称），帮助管理员识别。当 name 不为 null 和 空值时，本次注册内容将会被记录到 Senparc.Weixin.Config.SenparcWeixinSetting.Items[name] 中，方便取用。
使用完整的应用凭证获取Token，如果不存在将自动注册
获取可用Token
是否强制重新获取新的Token
获取可用AccessTokenResult对象
是否强制重新获取新的Token
【异步方法】注册应用凭证信息，此操作只是注册，不会马上获取Token，并将清空之前的Token
微信小程序后台的【开发】>【基本配置】中的N“AppID(应用ID)”
微信小程序后台的【开发】>【基本配置】中的“AppSecret(应用密钥)”
标记AccessToken名称（如微信小程序名称），帮助管理员识别。当 name 不为 null 和 空值时，本次注册内容将会被记录到 Senparc.Weixin.Config.SenparcWeixinSetting.Items[name] 中，方便取用。
【异步方法】使用完整的应用凭证获取Token，如果不存在将自动注册
【异步方法】获取可用Token
是否强制重新获取新的Token
获取可用AccessTokenResult对象
是否强制重新获取新的Token
第三方APP信息包
Session的Key（3rd_session / sessionId）
OpenId
SessionKey
过期时间
ComponentBag
3rdSession容器
获取最新的过期时间
获取Session
更新或插入SessionBag
如果留空，则新建一条记录
OpenId
SessionKey
UnionId
添加解码后的用户信息
获取Session
更新或插入SessionBag
如果留空，则新建一条记录
OpenId
SessionKey
UnionId
【异步方法】添加解码后的用户信息
用户绑定手机号解密类
用户绑定的手机号（国外手机号会有区号）
没有区号的手机号
区号（Senparc注：国别号）
解码后的用户信息
IRequestMessageEventBase
事件类型
请求消息的事件推送消息基类
事件类型
事件类型
事件之地点审核
事件类型
审核单id
审核状态（3：审核通过，2：审核失败）
如果status为2，会返回审核失败的原因
poi_id
事件之小程序审核失败
事件类型
申诉单id
违规小程序APPID
违规时间
申诉次数
申诉来源（0--用户，1--服务商）
申诉状态，1正在处理，2申诉通过，3申诉不通过，申诉已撤销
审核时间（“正在处理”或者“撤销”状态，不返回该字段）
审核结果理由（“正在处理”或者“撤销”状态，不返回该字段）
处罚原因描述
违规材料和申诉材料
违规材料
违规内容
违规链接
申诉材料
申诉理由
申诉材料id(可以通过“获取临时素材”接口下载对应的材料）
腾讯地图中创建门店的审核结果
事件类型
审核单id，即前面返回的base_id字段
审核状态（0：审核通过，1：审核失败）
从腾讯地图换取的位置点id
门店名字
详细地址
纬度
经度
备注
事件之小程序审核失败
事件类型
违规记录ID
违规小程序APPID
违规时间
违规原因
违规内容
规则URL
规则名称
内容安全回调：wxa_media_check 推送结果
事件类型
小程序的appid
任务id
可用于区分接口版本
详细检测结果
说明：文档 Json 中显示的此处是一个数组，收到的 XML 中是单个对象
综合结果
检测结果，可能的取值：pass（正常），其他值可能为异常，推测如：block
检测结果，可能的取值：pass（正常），其他值可能为异常，推测如：block
事件之地点审核
事件类型
审核单id
审核状态（3：审核通过，2：审核失败）
如果status为2，会返回审核失败的原因
事件之小程序审核失败
事件类型
审核结果 2：失败，3：成功
需要更改的昵称
驳回原因
事件之隐私权限审核结果推送
事件类型
审核结果
2-审核不通过,3-审核通过
事件之用户进入客服
事件类型
开发者在客服会话按钮设置的sessionFrom参数
事件之小程序审核延后
事件类型
审核延后的原因
审核延后时的时间戳
事件之小程序审核失败
事件类型
审核失败的原因
审核失败时的时间（整型），时间戳
审核不通过的截图示例。用 | 分隔的 media_id 的列表，可通过获取永久素材接口拉取截图内容
事件之小程序审核成功
事件类型
审核成功时的时间（整型），时间戳
事件之小程序审核成功
事件类型
一级类目id
二级类目id
审核结果 2.驳回，3通过
审核失败的驳回原因
微信公众服务器Post过来的加密参数集合（不包括PostData）
如需使用 NeuChar，需要在 MessageHandler 中提供 PostModel 并设置 AppId
设置服务器内部保密信息
图片消息媒体id，可以调用多媒体文件下载接口拉取数据。
图片链接
接收小程序页面消息
文本消息内容
小程序appid
小程序页面路径
封面图片的临时cdn链接
封面图片的临时素材id
文本消息内容
代表消息是从子商户的会话中过来的
响应回复多客服消息
水印
当RequestMsgType类型为Event时，Event属性的类型
进入会话事件
mediaCheckAsync 异步检测结果
类目审核结果事件推送
WxOpenException
签名及加密帮助类
获得签名
比较签名是否正确
当SessionId或SessionKey无效时抛出异常
解密所有消息的基础方法
储存在 SessionBag 中的当前用户 会话 SessionKey
接口返回数据中的 encryptedData 参数
接口返回数据中的 iv 参数，对称解密算法初始向量
默认 128，
解密消息（通过SessionId获取）
当SessionId或SessionKey无效时抛出异常
检查解密消息水印
entity为null时也会返回false
解密到实例信息
DecodeEntityBase
解密到实例信息
DecodeEntityBase
解密UserInfo消息（通过SessionId获取）
当SessionId或SessionKey无效时抛出异常
解密手机号
解密手机号(根据sessionKey解密)
解密微信小程序运动步数
2019-04-02
Session帮助类
获取新的3rdSession名称
Session名称长度，单位：B，建议为16的倍数，通常情况下16B已经够用（32位GUID字符串）
小程序上下文消息的默认实现
获取请求消息和实体之间的映射结果
获取响应消息和实体之间的映射结果
小程序MessageHandler
上下文MessageContext类型
请求实体
响应实体
正常情况下只有当执行Execute()方法后才可能有值。
也可以结合Cancel，提前给ResponseMessage赋值。
请求和响应消息定义
Api 接口定义
小程序MessageHandler构造函数
XML流（后期会支持JSON）
PostModel
上下文最多保留消息（0为保存所有）
当平台同时兼容明文消息和加密消息时，只允许处理加密消息（不允许处理明文消息），默认为 False
小程序MessageHandler构造函数
XML格式的请求
PostModel
上下文最多保留消息（0为保存所有）
当平台同时兼容明文消息和加密消息时，只允许处理加密消息（不允许处理明文消息），默认为 False
小程序MessageHandler构造函数
RequestMessageBase
PostModel
上下文最多保留消息（0为保存所有）
当平台同时兼容明文消息和加密消息时，只允许处理加密消息（不允许处理明文消息），默认为 False
初始化数据
自动判断默认异步方法调用（在没有override的情况下调用的默认方法）
requestMessage
同名的同步方法(DefaultMessageHandlerAsyncEvent值为SelfSynicMethod时调用)
【异步方法】认返回消息（当任何OnXX消息没有被重写，都将自动返回此默认消息）
执行微信请求
Event事件类型请求
小程序类目审核结果事件推送
在腾讯地图中创建门店的审核结果
门店小程序类目审核事件
进入客服会话事件
地点审核事件
小程序审核延后通知
小程序审核失败通知
小程序审核成功通知
名称审核结果事件推送
违规记录事件推送
小程序申诉记录推送
隐私权限申请结果推送
内容安全回调：wxa_media_check 推送结果
【异步方法】Event事件类型请求
【异步方法】小程序类目审核结果事件推送
在腾讯地图中创建门店的审核结果
【异步方法】门店小程序类目审核事件
【异步方法】进入客服会话事件
【异步方法】地点审核事件
【异步方法】小程序审核延后通知
【异步方法】小程序审核失败通知
【异步方法】小程序审核成功通知
【异步方法】名称审核结果事件推送
【异步方法】违规记录事件推送
【异步方法】小程序申诉记录推送
【异步方法】隐私权限申请结果推送
【异步方法】内容安全回调：wxa_media_check 推送结果
默认返回消息（当任何OnXX消息没有被重写，都将自动返回此默认消息）
文字类型请求
图片类型请求
注册小程序
注册小程序信息
RegisterService
微信公众号后台的【开发】>【基本配置】中的“AppID(应用ID)”
微信公众号后台的【开发】>【基本配置】中的“AppSecret(应用密钥)”
标记AccessToken名称（如微信公众号名称），帮助管理员识别
根据 SenparcWeixinSetting 自动注册小程序信息
RegisterService
SenparcWeixinSetting
统一标识，如果为null，则使用 SenparcWeixinSetting.ItemKey
RequestMessage消息处理方法工厂类
获取XDocument转换后的IRequestMessageBase实例。
如果MsgType不存在，抛出UnknownRequestMsgTypeException异常
获取XML转换后的IRequestMessageBase实例。
如果MsgType不存在，抛出UnknownRequestMsgTypeException异常
获取内容为XML的Stream转换后的IRequestMessageBase实例。
如果MsgType不存在，抛出UnknownRequestMsgTypeException异常
如Request.InputStream