Senparc.Weixin.MP

分析数据接口最大时间跨度是指一次接口调用时最大可获取数据的时间范围，如最大时间跨度为7是指最多一次性获取7天的数据。注意：所有的日期请使用【yyyy-MM-dd】的格式

获取图文群发每日数据（getarticlesummary）最大时间跨度 1

调用接口凭证获取数据的起始日期，begin_date和end_date的差值需小于“最大时间跨度”（比如最大时间跨度为1时，begin_date和end_date的差值只能为0，才能小于1），否则会报错获取数据的结束日期，end_date允许设置的最大值为昨日代理请求超时时间（毫秒）

获取图文群发总数据（getarticletotal）请注意，details中，每天对应的数值为该文章到该日为止的总量（而不是当日的量）最大时间跨度 1

获取数据的起始日期，begin_date和end_date的差值需小于“最大时间跨度”（比如最大时间跨度为1时，begin_date和end_date的差值只能为0，才能小于1），否则会报错获取数据的结束日期，end_date允许设置的最大值为昨日代理请求超时时间（毫秒）

获取图文统计数据（getuserread）最大时间跨度 3

获取图文统计分时数据（getuserreadhour）最大时间跨度 1

获取图文分享转发数据（getusershare）最大时间跨度 7

获取图文分享转发分时数据（getusersharehour）最大时间跨度 1

获取接口分析数据（getinterfacesummary）最大时间跨度 30

获取接口分析分时数据（getinterfacesummaryhour）最大时间跨度 1

获取消息发送概况数据（getupstreammsg）最大时间跨度 7

获取消息分送分时数据（getupstreammsghour）最大时间跨度 1

获取消息发送周数据（getupstreammsgweek）最大时间跨度 30

获取消息发送月数据（getupstreammsgmonth）最大时间跨度 30

获取消息发送分布数据（getupstreammsgdist）最大时间跨度 15

获取消息发送分布周数据（getupstreammsgdistweek）最大时间跨度 30

获取消息发送分布月数据（getupstreammsgdistmonth）最大时间跨度 30

获取用户增减数据最大时间跨度 7

获取累计用户数据最大时间跨度 7

图文群发每日数据单条数据

数据的日期

这里的msgid实际上是由msgid（图文消息id）和index（消息次序索引）组成，例如12003_3，其中12003是msgid，即一次群发的id消息的； 3为index，假设该次群发的图文消息共5个文章（因为可能为多图文）， 3表示5个中的第3个

图文消息的标题

图文页（点击群发图文卡片进入的页面）的阅读人数

图文页的阅读次数

原文页（点击图文页“阅读原文”进入的页面）的阅读人数，无原文页时此处数据为0

原文页的阅读次数

分享的人数

分享的次数

收藏的人数

收藏的次数

图文群发总数据单条数据

数据的日期

图文消息的标题

统计的日期，在getarticletotal接口中，ref_date指的是文章群发出日期，而stat_date是数据统计日期

送达人数，一般约等于总粉丝数（需排除黑名单或其他异常情况下无法收到消息的粉丝）

图文页（点击群发图文卡片进入的页面）的阅读人数

图文页的阅读次数

原文页（点击图文页“阅读原文”进入的页面）的阅读人数，无原文页时此处数据为0

原文页的阅读次数

分享的人数

分享的次数

收藏的人数

收藏的次数

图文统计数据单条数据

数据的日期

图文页（点击群发图文卡片进入的页面）的阅读人数

图文页的阅读次数

原文页（点击图文页“阅读原文”进入的页面）的阅读人数，无原文页时此处数据为0

原文页的阅读次数

分享的人数

分享的次数

收藏的人数

收藏的次数

图文统计分时数据单条数据

数据的日期

数据的小时，包括从000到2300，分别代表的是[000,100)到[2300,2400)，即每日的第1小时和最后1小时

图文页（点击群发图文卡片进入的页面）的阅读人数

图文页的阅读次数

原文页（点击图文页“阅读原文”进入的页面）的阅读人数，无原文页时此处数据为0

原文页的阅读次数

分享的人数

分享的次数

收藏的人数

收藏的次数

图文分享转发数据单条数据

数据的日期

分享的场景 1代表好友转发 2代表朋友圈 3代表腾讯微博 255代表其他

分享的人数

分享的次数

图文分享转发分时数据单条数据

数据的日期

数据的小时，包括从000到2300，分别代表的是[000,100)到[2300,2400)，即每日的第1小时和最后1小时

分享的场景 1代表好友转发 2代表朋友圈 3代表腾讯微博 255代表其他

分享的人数

分享的次数

分析数据接口返回结果

数据的日期，需在begin_date和end_date之间

消息类型，代表含义如下：1代表文字 2代表图片 3代表语音 4代表视频 6代表第三方应用消息（链接消息）

上行发送了（向公众号发送了）消息的用户数

上行发送了消息的消息总数

消息发送概况数据单条数据

消息分送分时数据单条数据

数据的小时，包括从000到2300，分别代表的是[000,100)到[2300,2400)，即每日的第1小时和最后1小时

消息发送周数据单条数据

消息发送月数据单条数据

数据的日期，需在begin_date和end_date之间

当日发送消息量分布的区间，0代表 “0”，1代表“1-5”，2代表“6-10”，3代表“10次以上”

上行发送了（向公众号发送了）消息的用户数

消息发送分布数据单条数据

消息发送分布周数据单条数据

消息发送分布月数据单条数据

数据的日期，需在begin_date和end_date之间

通过服务器配置地址获得消息后，被动回复用户消息的次数

上述动作的失败次数

总耗时，除以callback_count即为平均耗时

最大耗时

接口分析数据单条数据

接口分析分时数据单条数据

数据的小时

获取自动回复规则

调用接口凭证

关注后自动回复是否开启，0代表未开启，1代表开启

消息自动回复是否开启，0代表未开启，1代表开启

关注后自动回复的信息

消息自动回复的信息

关键词自动回复的信息

自动回复的类型。关注后自动回复和消息自动回复的类型仅支持文本（text）、图片（img）、语音（voice）、视频（video），关键词自动回复则还多了图文消息（news）

对于文本类型，content是文本内容，对于图文、图片、语音、视频类型，content是mediaID

关键词自动回复的信息列表

规则名称

创建时间

回复模式，reply_all代表全部回复，random_one代表随机回复其中一条

匹配的关键词列表

回复模式，reply_all代表全部回复，random_one代表随机回复其中一条

对于文本类型，content是文本内容，对于图文、图片、语音、视频类型，content是mediaID

图文消息的信息

对于文本类型，content是文本内容，对于图文、图片、语音、视频类型，content是mediaID

图文消息的信息列表

图文消息的标题

作者

摘要

是否显示封面，0为不显示，1为显示

封面图片的URL

正文的URL

原文的URL，若置空则无查看原文入口

卡券接口

创建卡券

创建卡券需要的数据，格式可以看CardCreateData.cs 代理请求超时时间（毫秒）

生成卡券二维码获取二维码ticket 后，开发者可用ticket 换取二维码图片。换取指引参考：http://mp.weixin.qq.com/wiki/index.php?title=生成带参数的二维码

卡券ID 指定卡券code 码，只能被领一次。use_custom_code 字段为true 的卡券必须填写，非自定义code 不必填写。指定领取者的openid，只有该用户能领取。bind_openid 字段为true 的卡券必须填写，非自定义openid 不必填写。指定二维码的有效时间，范围是60 ~ 1800 秒。不填默认为永久有效。指定下发二维码，生成的二维码随机分配一个code，领取后不可再次扫描。填写true 或false。默认false。红包余额，以分为单位。红包类型必填（LUCKY_MONEY），其他卡券类型不填。代理请求超时时间（毫秒）

创建货架

导入code 新创建卡券情况如果开发者打算新创建一张支持导入code模式的卡券，不同于以往的创建方式，建议开发者采用以下流程创建预存code模式卡券，否则会报错。步骤一：创建预存模式卡券，将库存quantity初始值设置为0，并填入Deposit_Mode字段；步骤二：待卡券通过审核后，调用导入code接口并核查code；步骤三：调用修改库存接口，须令卡券库存小于或等于导入code的数目。（为了避免混乱建议设置为相等）注： 1）单次调用接口传入code的数量上限为100个。 2）每一个 code 均不能为空串。 3）导入结束后系统会自动判断提供方设置库存与实际导入code的量是否一致。 4）导入失败支持重复导入，提示成功为止。

需要进行导入code的卡券ID 需导入微信卡券后台的自定义code，上限为100个。

查询导入code数目

进行导入code的卡券ID。

核查code

进行导入code的卡券ID。已经微信卡券后台的自定义code，上限为100个。

图文消息群发卡券

卡券消耗code

要消耗的序列号要消耗序列号所述的card_id，创建卡券时use_custom_code 填写true 时必填。非自定义code不必填写。代理请求超时时间（毫秒）

code 解码接口 code 解码接口支持两种场景： 1.商家获取choos_card_info 后，将card_id 和encrypt_code 字段通过解码接口，获取真实code。 2.卡券内跳转外链的签名中会对code 进行加密处理，通过调用解码接口获取真实code。

通过choose_card_info 获取的加密字符串代理请求超时时间（毫秒）

删除卡券

卡券ID 代理请求超时时间（毫秒）

查询code接口

代理请求超时时间（毫秒）

批量查询卡列表

查询卡列表的起始偏移量，从0 开始，即offset: 5 是指从从列表里的第六个开始读取。需要查询的卡片的数量（数量最大50）代理请求超时时间（毫秒）

查询卡券详情

代理请求超时时间（毫秒）

更改code

卡券的code 编码卡券ID 新的卡券code 编码代理请求超时时间（毫秒）

设置卡券失效接口

需要设置为失效的code 自定义code 的卡券必填。非自定义code 的卡券不填。代理请求超时时间（毫秒）

更改卡券信息接口支持更新部分通用字段及特殊卡券（会员卡、飞机票、电影票、红包）中特定字段的信息。

卡券种类，会员卡、飞机票、电影票、红包中的一种创建卡券需要的数据，格式可以看CardUpdateData.cs 代理请求超时时间（毫秒）

设置测试用户白名单由于卡券有审核要求，为方便公众号调试，可以设置一些测试帐号，这些帐号可以领取未通过审核的卡券，体验整个流程。注：同时支持“openid”、“username”两种字段设置白名单，总数上限为10 个。

测试的openid 列表测试的微信号列表代理请求超时时间（毫秒）

激活/绑定会员卡

必填，会员卡编号，作为序列号显示在用户的卡包里。创建会员卡时获取的code 激活后的有效截至时间。若不填写默认以创建时的 data_info 为准。Unix时间戳格式。初始积分，不填为0 初始余额，不填为0 创建时字段custom_field1定义类型的初始值，限制为4个汉字，12字节。创建时字段custom_field2定义类型的初始值，限制为4个汉字，12字节。创建时字段custom_field3定义类型的初始值，限制为4个汉字，12字节。代理请求超时时间（毫秒）激活后的有效起始时间。若不填写默认以创建时的 data_info 为准。Unix时间戳格式。

设置开卡字段接口

设置跟随推荐接口有使用消息配置卡券（cardCellData）和使用消息配置URL（urlCellData）两种方式注意：cardCellData和urlCellData必须也只能选择一个，不可同时为空

卡券ID 使用消息配置卡券数据使用消息配置URL数据

设置微信买单接口注意：在调用买单接口之前，请开发者务必确认是否已经开通了微信支付以及对相应的cardid设置了门店，否则会报错错误码，0为正常；43008为商户没有开通微信支付权限

卡券ID 是否开启买单功能，填true/false

更新会员信息

post数据：可以传入积分、余额的差值 { "code": "12312313", "card_id":"p1Pj9jr90_SQRaVqYI239Ka1erkI", "record_bonus": "消费30元，获得3积分", "add_bonus": 3,//可以传入积分增减的差值 "add_balance": -3000,//可以传入余额本次增减的差值 "record_balance": "购买焦糖玛琪朵一杯，扣除金额30元。", "custom_field_value1": "xxxxx", } 或者直接传入积分、余额的全量值 { "code": "12312313", "card_id":"p1Pj9jr90_SQRaVqYI239Ka1erkI", "record_bonus": "消费30元，获得3积分", "bonus": 3000,//可以传入第三方系统记录的积分全量值 "balance": 3000,//可以传入第三方系统记录的余额全量值 "record_balance": "购买焦糖玛琪朵一杯，扣除金额30元。", "custom_field_value1": "xxxxx", } 卡券Code码。卡券ID。需要变更的积分，扣除积分用“-“表示。需要变更的余额，扣除金额用“-”表示。单位为分。需要设置的积分全量值，传入的数值会直接显示，如果同时传入add_bonus和bonus,则前者无效。需要设置的余额全量值，传入的数值会直接显示，如果同时传入add_balance和balance,则前者无效。商家自定义积分消耗记录，不超过14个汉字。商家自定义金额消耗记录，不超过14个汉字。创建时字段custom_field1定义类型的最新数值，限制为4个汉字，12字节。创建时字段custom_field2定义类型的最新数值，限制为4个汉字，12字节。创建时字段custom_field3定义类型的最新数值，限制为4个汉字，12字节。

会员卡交易

要消耗的序列号要消耗序列号所述的card_id。自定义code 的会员卡必填商家自定义积分消耗记录，不超过14 个汉字需要变更的积分，扣除积分用“-“表需要变更的余额，扣除金额用“-”表示。单位为分商家自定义金额消耗记录，不超过14 个汉字代理请求超时时间（毫秒）

更新电影票

电影票的序列号电影票card_id。自定义code 的电影票为必填，非自定义code 的电影票不必填。电影票的类别，如2D、3D 电影放映时间对应的时间戳放映时长，填写整数该场电影的影厅信息座位号代理请求超时时间（毫秒）

飞机票在线选座

飞机票的序列需办理值机的机票card_id。自定义code 的飞机票为必乘客姓名，上限为15 个汉字舱等，如头等舱等，上限为5 个汉字乘客座位号电子客票号，上限为14 个数字二维码数据。乘客用于值机的二维码字符串，微信会通过此数据为用户生成值机用的二维码是否取消值机。填写true 或false。true 代表取消，如填写true 上述字段（如calss 等）均不做判断，机票返回未值机状态，乘客可重新值机。默认填写false 代理请求超时时间（毫秒）

更新红包金额

红包的序列号自定义code 的卡券必填。非自定义code 可不填。红包余额代理请求超时时间（毫秒）

更新会议门票接口

用户的门票唯一序列号要更新门票序列号所述的card_id ，生成券时use_custom_code 填写true 时必填。区域入口座位号代理请求超时时间（毫秒）

获取用户已领取卡券

需要查询的用户openid 卡券ID。不填写时默认查询当前appid下的卡券。

修改库存接口

卡券ID 增加多少库存，支持不填或填0 减少多少库存，可以不填或填0

通用券数据

基本的卡券数据

卡类型（不在Json数据中）

描述文本必填

团购券数据

团购券专用，团购详情必填

礼品券数据

礼品券专用，表示礼品名字必填

代金券数据

代金券专用，表示起用金额（单位为分）非必填

代金券专用，表示减免金额（单位为分）必填

折扣券数据

折扣券专用，表示打折额度（百分比）。填30 就是七折。必填

会员卡数据

是否支持积分，填写true 或false，如填写true，积分相关字段均为必填。填写false，积分字段无需填写。储值字段处理方式相同。必填

是否支持储值，填写true 或false。必填

设置为true时用户领取会员卡后系统自动将其激活，无需调用激活接口。非必填

设置为true时会员卡支持一键激活，不允许同时传入activate_url字段，否则设置wx_activate失效。非必填

积分清零规则非必填

积分规则非必填

储值说明非必填

特权说明必填

绑定旧卡的url，与“activate_url”字段二选一必填。

激活会员卡的url，与“bind_old_card_url”字段二选一必填。

设置跳转外链查看积分详情。仅适用于积分无法通过激活接口同步的情况下使用该字段。非必填

设置跳转外链查看余额详情。仅适用于余额无法通过激活接口同步的情况下使用该字段。非必填

自定义会员信息类目，会员卡激活后显示。非必填

自定义会员信息类目，会员卡激活后显示非必填

会员信息类目名称。FIELD_NAME_TYPE_LEVEL等级；FIELD_NAME_TYPE_COUPON优惠券；FIELD_NAME_TYPE_STAMP印花；FIELD_NAME_TYPE_DISCOUNT折扣；FIELD_NAME_TYPE_ACHIEVEMEN成就；FIELD_NAME_TYPE_MILEAGE里程。

点击类目跳转外链url

入口名称必填

入口右侧提示语，6个汉字内必填

入口跳转链接必填

门票数据

票类型，例如平日全票，套票等非必填

导览图url 非必填

电影票数据

电影票详请非必填

飞机票数据

起点，上限为18 个汉字必填

终点，上限为18 个汉字必填

航班必填

起飞时间，上限为17 个汉字非必填

降落时间，上限为17 个汉字非必填

在线值机的链接非必填

登机口。如发生登机口变更，建议商家实时调用该接口变更

登机时间，只显示“时分”不显示日期，按时间戳格式填写。如发生登机时间变更，建议商家实时调用该接口变更

机型，上限为8 个汉字非必填

红包数据

会议门票数据

会议详情

会场导览图

创建卡券数据

卡券信息部分

卡券信息数据中的card字段

通用券

团购券

礼品券

代金券

折扣券

会员卡

门票

电影票

飞机票

红包

会议门票

创建卡券返回结果

卡券ID

获取颜色列表返回结果

颜色列表

可以填入的color 名称

对应的颜色数值

生成卡券二维码返回结果

获取的二维码ticket，凭借此ticket 可以在有效时间内换取二维码。

消耗code返回结果

用户openid

卡券ID

code 解码

上传logo返回结果

会员卡设置开卡字段需要的数据

卡券ID

会员卡激活时的必填选项

会员卡激活时的选填项

微信格式化的选项类型 USER_FORM_INFO_FLAG_MOBILE 手机号 USER_FORM_INFO_FLAG_NAME 姓名 USER_FORM_INFO_FLAG_BIRTHDAY 生日 USER_FORM_INFO_FLAG_IDCARD 身份证 USER_FORM_INFO_FLAG_EMAIL 邮箱 USER_FORM_INFO_FLAG_DETAIL_LOCATION 详细地址 USER_FORM_INFO_FLAG_EDUCATION_BACKGROUND 教育背景 USER_FORM_INFO_FLAG_CAREER 职业 USER_FORM_INFO_FLAG_INDUSTRY 行业 USER_FORM_INFO_FLAG_INCOME 收入 USER_FORM_INFO_FLAG_HABIT 兴趣爱好

自定义选项名称

卡券信息部分

会员卡

门票

电影票

飞机票

基本的卡券数据

基本的卡券数据，所有卡券通用。

卡券的商户logo，尺寸为300*300。必填

券颜色。按色彩规范标注填写Color010-Color100 必填

使用提醒，字数上限为9 个汉字。（一句话描述，展示在首页，示例：请出示二维码核销卡券）非必填

客服电话非必填

使用说明。长文本描述，可以分行，上限为1000 个汉字。必填

code 码展示类型必填

每人使用次数限制非必填

每人最大领取次数，不填写默认等于quantity。非必填

领取卡券原生页面是否可分享，填写true 或false，true 代表可分享。默认可分享。非必填

卡券是否可转赠，填写true 或false,true 代表可转赠。默认可转赠。非必填

门店位置ID。商户需在mp 平台上录入门店信息或调用批量导入门店信息接口获取门店位置ID。非必填

使用日期，有效期的信息必填

商户自定义cell 名称非必填

商户自定义url 地址，支持卡券页内跳转,跳转页面内容需与自定义cell 名称保持一致。非必填

使用日期，有效期的信息

固定日期区间专用，表示起用时间。从1970 年1 月1 日00:00:00 至起用时间的秒数，最终需转换为字符串形态传入，下同。（单位为秒）非必填

固定日期区间专用，表示结束时间。（单位为秒）非必填

卡券详情

通用券

团购券

礼品券

代金券

折扣券

会员卡

门票

电影票

飞机票

红包

通用券数据

基本的卡券数据

描述文本

团购券数据

团购券专用，团购详情

礼品券数据

礼品券专用，表示礼品名字

代金券数据

代金券专用，表示起用金额（单位为分）

代金券专用，表示减免金额（单位为分）

折扣券数据

折扣券专用，表示打折额度（百分比）。填30 就是七折。

会员卡数据

是否支持积分，填写true 或false，如填写true，积分相关字段均为必填。填写false，积分字段无需填写。储值字段处理方式相同。

是否支持储值，填写true 或false。

积分清零规则

积分规则

储值说明

特权说明

绑定旧卡的url，与“activate_url”字段二选一必填。

激活会员卡的url，与“bind_old_card_url”字段二选一必填。

门票数据

票类型，例如平日全票，套票等

导览图url

电影票数据

电影票详请

飞机票数据

起点，上限为18 个汉字

终点，上限为18 个汉字

航班

起飞时间，上限为17 个汉字

降落时间，上限为17 个汉字

在线值机的链接

登机口。如发生登机口变更，建议商家实时调用该接口变更

登机时间，只显示“时分”不显示日期，按时间戳格式填写。如发生登机时间变更，建议商家实时调用该接口变更

机型，上限为8 个汉字

红包数据

基本的卡券数据，所有卡券通用。

基本的卡券数据，所有卡券通用。作为 Card_BaseInfo和的基类

卡券的商户logo，尺寸为300*300。必填

code 码展示类型必填

商户名字,字数上限为12 个汉字。（填写直接提供服务的商户名，第三方商户名填写在source 字段）必填

券名，字数上限为9 个汉字。(建议涵盖卡券属性、服务及金额) 必填

券名的副标题，字数上限为18个汉字。非必填

券颜色。按色彩规范标注填写Color010-Color100 必填

使用提醒，字数上限为9 个汉字。（一句话描述，展示在首页，示例：请出示二维码核销卡券）必填

客服电话非必填

第三方来源名，例如同程旅游、格瓦拉。非必填

使用说明。长文本描述，可以分行，上限为1000 个汉字。必填

每人使用次数限制非必填

每人最大领取次数，不填写默认等于quantity。非必填

是否自定义code 码。填写true或false，不填代表默认为false。非必填

是否指定用户领取，填写true或false。不填代表默认为否。非必填

领取卡券原生页面是否可分享，填写true 或false，true 代表可分享。默认可分享。非必填

卡券是否可转赠，填写true 或false,true 代表可转赠。默认可转赠。非必填

门店位置ID。商户需在mp 平台上录入门店信息或调用批量导入门店信息接口获取门店位置ID。非必填

使用日期，有效期的信息必填

商品信息

商户自定义cell 名称非必填

商户自定义url 地址，支持卡券页内跳转,跳转页面内容需与自定义cell 名称保持一致。非必填

自定义跳转外链的入口名字非必填

显示在入口右侧的提示语非必填

营销场景的自定义入口名称非必填

入口跳转外链的地址链接非必填

显示在营销入口右侧的提示语非必填

积分余额变动消息类型

卡券Id

删除卡券返回结果

查询code返回结果

用户openid

卡券ID

起始使用时间

结束时间

批量查询卡列表返回结果

查询卡券详情返回结果

卡券类型

会员卡交易返回结果

当前用户积分总额

当前用户预存总金额

用户openid

获取用户已领取卡券返回结果

卡券列表

更新会员信息返回结果

当前用户积分总额。

当前用户预存总金额。

用户openid。

图文消息群发卡券返回结果

返回一段html代码，可以直接嵌入到图文消息的正文里。即可以把这段代码嵌入到上传图文消息素材接口中的content字段里。

会员卡数据

积分清零规则非必填

积分规则非必填

储值说明非必填

特权说明非必填

门票数据

导览图url 非必填

电影票数据

电影票详请非必填

飞机票数据

起飞时间，上限为17 个汉字非必填

降落时间，上限为17 个汉字非必填

登机口。如发生登机口变更，建议商家实时调用该接口变更

登机时间，只显示“时分”不显示日期，按时间戳格式填写。如发生登机时间变更，建议商家实时调用该接口变更

查询导入code数目返回结果

货架已经成功存入的code数目。

核查code返回结果

已经成功存入的code。

没有存入的code。

卡券类型的推荐位

链接类型的推荐位

推荐位展示的截止时间

需要在运营位投放的卡券id

推荐位展示的截止时间

文本内容

跳转链接

使用日期，有效期的信息

使用时间的类型 1：固定日期区间，2：固定时长（自领取后按天算）必填

固定日期区间专用，表示起用时间。从1970 年1 月1 日00:00:00 至起用时间的秒数，最终需转换为字符串形态传入，下同。（单位为秒）必填

固定日期区间专用，表示结束时间。（单位为秒）必填

固定时长专用，表示自领取后多少天内有效。（单位为天）必填

固定时长专用，表示自领取后多少天开始生效。（单位为天）必填

商品信息

上架的数量。（不支持填写0或无限大）必填

创建货架数据

页面的banner图片链接，须调用。

页面的title。

页面是否可以分享,填入true/false

投放页面的场景值；SCENE_NEAR_BY 附近 SCENE_MENU 自定义菜单 SCENE_QRCODE 二维码 SCENE_ARTICLE 公众号文章 SCENE_H5 h5页面 SCENE_IVR 自动回复 SCENE_CARD_CUSTOM_CELL 卡券自定义cell

卡券列表

所要在页面投放的cardid

缩略图url

创建货架返回结果

货架链接。

货架ID。货架的唯一标识。

客服列表

客服账号

客服昵称

客服工号

客服头像

在线客服列表

客服账号

客服在线状态 1：pc在线，2：手机在线若pc和手机同时在线则为 1+2=3

客服工号

客服设置的最大自动接入数

客服当前正在接待的会话数

聊天记录结果

官方文档暂没有说明

客服记录消息

客服账号

用户的标识，对当前公众号唯一

操作ID（会话状态）

操作时间，UNIX时间戳

聊天记录

操作ID(会化状态）定义

多客服接口

获取用户聊天记录

调用接口凭证查询开始时间，会自动转为UNIX时间戳查询结束时间，会自动转为UNIX时间戳，每次查询不能跨日查询每页大小，每页最多拉取1000条查询第几页，从1开始代理请求超时时间（毫秒）

获取客服基本信息

调用接口凭证代理请求超时时间（毫秒）

获取在线客服接待信息

调用接口凭证代理请求超时时间（毫秒）

添加客服账号

完整客服账号，格式为：账号前缀@公众号微信号，账号前缀最多10个字符，必须是英文或者数字字符。如果没有公众号微信号，请前往微信公众平台设置。客服昵称，最长6个汉字或12个英文字符客服账号登录密码，格式为密码明文的32位加密MD5值代理请求超时时间（毫秒）

设置客服信息

上传客服头像

完整客服账号，格式为：账号前缀@公众号微信号 form-data中媒体文件标识，有filename、filelength、content-type等信息代理请求超时时间（毫秒）

删除客服账号

完整客服账号，格式为：账号前缀@公众号微信号代理请求超时时间（毫秒）

创建会话

客户openid 完整客服账号，格式为：账号前缀@公众号微信号附加信息，文本会展示在客服人员的多客服客户端(非必须) 代理请求超时时间（毫秒）

关闭会话

客户openid 完整客服账号，格式为：账号前缀@公众号微信号附加信息，文本会展示在客服人员的多客服客户端(非必须) 代理请求超时时间（毫秒）

获取客户的会话状态

客户openid 代理请求超时时间（毫秒）

获取客服的会话列表

完整客服账号，格式为：账号前缀@公众号微信号，账号前缀最多10个字符，必须是英文或者数字字符。代理请求超时时间（毫秒）

获取未接入会话列表

代理请求超时时间（毫秒）

获取客户的会话状态返回结果

正在接待的客服，为空表示没有人在接待

会话接入的时间

获取客服的会话列表返回结果

会话列表

客户openid

会话创建时间，UNIX时间戳

获取未接入会话列表返回结果

未接入会话数量

未接入会话列表，最多返回100条数据

客户openid

指定接待的客服，为空表示未指定客服

用户来访时间，UNIX时间戳

客服接口

发送文本信息

代理请求超时时间（毫秒）

发送图片消息

代理请求超时时间（毫秒）

发送语音消息

代理请求超时时间（毫秒）

发送视频消息

代理请求超时时间（毫秒）

发送音乐消息

音乐标题（非必须）音乐描述（非必须）音乐链接高品质音乐链接，wifi环境优先使用该链接播放音乐视频缩略图的媒体ID 代理请求超时时间（毫秒）

发送图文消息

代理请求超时时间（毫秒）

高级群发接口

根据分组进行群发【订阅号与服务号认证后均可用】请注意： 1、该接口暂时仅提供给已微信认证的服务号 2、虽然开发者使用高级群发接口的每日调用限制为100次，但是用户每月只能接收4条，请小心测试 3、无论在公众平台网站上，还是使用接口群发，用户每月只能接收4条群发消息，多于4条的群发将对该用户发送失败。 4、群发视频时需要先调用GetVideoMediaIdResult接口获取专用的MediaId然后进行群发

群发到的分组的group_id，参加用户管理中用户分组接口，若is_to_all值为true，可不填写group_id 群发媒体文件时传入mediaId,群发文本消息时传入content,群发卡券时传入cardId 用于设定是否向全部用户发送，值为true或false，选择true该消息群发给所有用户，选择false可根据group_id发送给指定群组的用户代理请求超时时间（毫秒）

根据OpenId进行群发

群发媒体文件时传入mediaId,群发文本消息时传入content,群发卡券时传入cardId openId字符串数组代理请求超时时间（毫秒）

根据OpenID列表群发视频消息【订阅号不可用，服务号认证后可用】注意：群发视频时需要先调用GetVideoMediaIdResult接口获取专用的MediaId然后进行群发

openId字符串数组代理请求超时时间（毫秒）

删除群发消息

发送出去的消息ID 代理请求超时时间（毫秒）

预览接口【订阅号与服务号认证后均可用】注意：openId与wxName两者任选其一，同时传入以wxName优先

群发媒体消息时为media_id，群发文本信息为content 接收消息用户对应该公众号的openid 接收消息用户的微信号代理请求超时时间（毫秒）

预览卡券接口

查询群发消息发送状态【订阅号与服务号认证后均可用】

群发消息后返回的消息id 代理请求超时时间（毫秒）

获取视频群发用的MediaId

图文消息模型

图文消息缩略图的media_id，可以在基础支持上传多媒体文件接口中获得

图文消息的作者

图文消息的标题

在图文消息页面点击“阅读原文”后的页面

图文消息页面的内容，支持HTML标签

图文消息的描述

是否显示封面，1为显示，0为不显示

发送信息后的结果

媒体文件类型，分别有图片（image）、语音（voice）、视频（video）和缩略图（thumb），图文消息为news

消息ID

消息发送后的状态，SEND_SUCCESS表示发送成功

OpenId

微信号

消息类型

mediaId

类型（通常为video）

创建时间戳

创建分组返回结果

获取用户分组ID返回结果

用户组接口

创建分组

分组名字（30个字符以内）代理请求超时时间（毫秒）

获取所有分组

获取用户分组

代理请求超时时间（毫秒）

修改分组名

分组名字（30个字符以内）代理请求超时时间（毫秒）

移动用户分组

代理请求超时时间（毫秒）

批量移动用户分组

调用接口凭证分组id 代理请求超时时间（毫秒）用户唯一标识符openid的列表（size不能超过50）

删除分组

分组id 代理请求超时时间（毫秒）

此属性在CreateGroupResult的Json数据中，创建结果中始终为0

素材管理接口（原多媒体文件接口）

新增临时素材（原上传媒体文件）

代理请求超时时间（毫秒）

上传临时图文消息素材（原上传图文消息素材）

Token 图文消息组代理请求超时时间（毫秒）

获取临时素材（原下载媒体文件）

新增永久图文素材

Token 图文消息组代理请求超时时间（毫秒）

新增其他类型永久素材(图片（image）、语音（voice）和缩略图（thumb）)

文件路径代理请求超时时间（毫秒）

新增永久视频素材

文件路径代理请求超时时间（毫秒）

获取永久图文素材

代理请求超时时间（毫秒）

获取永久素材(除了图文)

删除永久素材

代理请求超时时间（毫秒）

修改永久图文素材

要修改的图文消息的id 要更新的文章在图文消息中的位置（多图文消息时，此字段才有意义），第一篇为0 代理请求超时时间（毫秒）图文素材

获取素材总数永久素材的总数，也会计算公众平台官网素材管理中的素材图片和图文消息素材（包括单图文和多图文）的总数上限为5000，其他素材的总数上限为1000

获取图文素材列表

从全部素材的该偏移位置开始返回，0表示从第一个素材返回返回素材的数量，取值在1到20之间代理请求超时时间（毫秒）

获取图片、视频、语音素材列表

素材的类型，图片（image）、视频（video）、语音（voice）

上传图文消息内的图片获取URL

获取图文类型永久素材返回结果

图文页的URL

修改永久图文素材需要post的数据

要修改的图文消息的id

要更新的文章在图文消息中的位置（多图文消息时，此字段才有意义），第一篇为0

图文素材若新增的是多图文素材，则此处应还有几段articles结构

获取素材总数返回结果

语音总数量

视频总数量

图片总数量

图文总数量

获取素材总数返回结果

该类型的素材的总数

本次调用获取的素材的数量

图文素材的Item

这个素材的最后更新时间

除图文之外的其他素材的Item

文件名称

这个素材的最后更新时间

图文页的URL，或者，当获取的列表是图片素材列表时，该字段是图片的URL

微小店接口，官方API：http://mp.weixin.qq.com/wiki/index.php?title=%E5%BE%AE%E4%BF%A1%E5%B0%8F%E5%BA%97%E6%8E%A5%E5%8F%A3

增加邮费模板

增加邮费模板需要Post的数据

删除邮费模板

邮费模板Id

修改邮费模板

修改邮费模板需要Post的数据

获取指定ID的邮费模板

邮费模板Id

获取所有邮费模板

邮费模板信息

邮费模板名称

支付方式(0-买家承担运费, 1-卖家承担运费)

计费单位(0-按件计费, 1-按重量计费, 2-按体积计费，目前只支持按件计费，默认为0)

具体运费计算

快递类型ID(参见增加商品/快递列表)

默认邮费计算方法

指定地区邮费计算方法

起始计费数量(比如计费单位是按件, 填2代表起始计费为2件)

起始计费金额(单位: 分）

递增计费数量

递增计费金额(单位 : 分)

起始计费数量

起始计费金额(单位: 分）

递增计费数量

递增计费金额(单位 : 分)

指定国家

指定省份

指定城市

增加邮费模板

修改邮费模板Post数据

邮费模板Id

添加邮费模板返回结果

邮费模板ID

获取指定ID的邮费模板返回结果

邮费模板ID

邮费模板名称

支付方式(0-买家承担运费, 1-卖家承担运费)

计费单位(0-按件计费, 1-按重量计费, 2-按体积计费，目前只支持按件计费，默认为0)

具体运费计算

获取所有邮费模板

所有邮费模板集合

微小店分组接口

增加分组

增加分组需要Post的数据

删除分组

分组Id

修改分组属性

修改分组属性需要Post的数据

修改分组商品

修改分组商品需要Post的数据

获取所有分组

根据分组ID获取分组信息

分组Id

分组名称

商品ID集合

修改分组属性需要Post的数据

分组Id

分组名称

修改分组商品需要Post的数据

分组ID

分组的商品集合

商品ID

修改操作(0-删除, 1-增加)

增加分组

增加分组返回信息

分组ID

获取所有分组返回信息

分组集合

分组ID

分组名称

分组信息

分组ID

分组名称

商品ID集合

微小店订单接口

根据订单ID获取订单详情

订单Id

根据订单状态/创建时间获取订单详情

订单状态(不带该字段-全部状态, 2-待发货, 3-已发货, 5-已完成, 8-维权中, ) 订单创建时间起始时间(不带该字段则不按照时间做筛选) 订单创建时间终止时间(不带该字段则不按照时间做筛选)

设置订单发货信息

订单ID 物流公司ID(参考《物流公司ID》；当need_delivery为0时，可不填本字段；当need_delivery为1时，该字段不能为空；当need_delivery为1且is_others为1时，本字段填写其它物流公司名称) 运单ID(当need_delivery为0时，可不填本字段；当need_delivery为1时，该字段不能为空；) 商品是否需要物流(0-不需要，1-需要，无该字段默认为需要物流) 是否为其它物流公司(0-否，1-是，无该字段默认为不是其它物流公司) 物流公司 Id 邮政EMS Fsearch_code 申通快递 002shentong 中通速递 066zhongtong 圆通速递 056yuantong 天天快递 042tiantian 顺丰速运 003shunfeng 韵达快运 059Yunda 宅急送 064zhaijisong 汇通快运 020huitong 易迅快递 zj001yixun

关闭订单

订单ID

根据订单ID获取订单详情返回结果

订单详情

订单ID

订单状态

订单总价格(单位 : 分)

订单创建时间

订单运费价格(单位 : 分)

买家微信OPENID

买家微信昵称

收货人姓名

收货地址省份

收货地址城市

收货详细地址

收货人移动电话

收货人固定电话

商品ID

商品名称

商品价格(单位 : 分)

商品SKU

商品个数

商品图片

运单ID

物流公司编码

交易ID

根据订单状态/创建时间获取订单详情返回结果

微小店图片接口

上传图片返回结果

图片Url

微小店接口

增加商品

提交到接口的数据（AddProductData）

删除商品

商品的Id

修改商品 product_id表示要更新的商品的ID，其他字段说明请参考增加商品接口。从未上架的商品所有信息均可修改，否则商品的名称(name)、商品分类(category)、商品属性(property)这三个字段不可修改。

修改商品的信息

查询商品

商品的Id

获取指定状态的所有商品

商品状态(0-全部, 1-上架, 2-下架)

商品上下架

商品上下架标识(0-下架, 1-上架) 商品ID

获取指定分类的所有子分类

大分类ID(根节点分类id为1)

获取指定子分类的所有SKU

商品子分类ID

获取指定分类的所有属性

分类ID

商品信息

基本属性

sku信息列表(可为多个)，每个sku信息串即为一个确定的商品，比如白色的37码的鞋子

商品其他属性

运费信息

商品分类id

商品属性列表

商品名称

商品sku定义

商品主图

商品图片列表

商品详情列表，显示在客户端的商品详情页内

用户商品限购数量

属性id

属性值id

sku属性

sku值

文字描述

图片

sku信息

sku微信价(单位 : 分, 微信价必须比原价小, 否则添加商品失败)

sku iconurl(图片需调用图片上传接口获得图片Url)

商家商品编码

sku原价(单位 : 分)

sku库存

商品所在地地址

是否包邮(0-否, 1-是), 如果包邮delivery_info字段可省略

是否提供发票(0-否, 1-是)

是否保修(0-否, 1-是)

是否支持退换货(0-否, 1-是)

国家

省份

城市

地址

快递列表(Id 说明) 10000027 平邮 10000028 快递 10000029 EMS

运费类型(0-使用下面express字段的默认模板, 1-使用template_id代表的邮费模板)

邮费模板ID

快递信息

快递ID

运费(单位 : 分)

添加商品信息

修改商品信息

商品ID

增加商品返回结果

查询商品返回结果

修改商品信息

获取指定状态的所有商品返回结果

获取指定分类的所有子分类返回结果

子分类ID

子分类名称

获取指定子分类的所有SKU返回结果

sku id

sku 名称

sku vid列表

vid

vid名称

获取指定分类的所有属性返回结果

属性id

属性名称

属性值

属性值id

属性值名称

微小店货架接口

增加货架

控件1数据控件2数据控件3数据控件4数据控件5数据货架招牌图片Url 货架名称

删除货架

货架Id

修改货架

控件1数据控件2数据控件3数据控件4数据控件5数据货架Id 货架招牌图片Url 货架名称

获取所有货架

根据货架ID获取货架信息

货架Id

控件1数据初始化

group_info/filter/count group_info/group_id

控件2数据初始化

groups/[group_id]

控件3数据初始化

控件4数据初始化

groups/[group_id] groups/[img] 注意groupIds和imgs要对应

控件5数据初始化

groups/[group_id] groups/img_background

添加货架返回结果

获取所有货架

货架banner

货架名称

货架ID

根据货架ID获取货架信息

货架banner

货架名称

货架ID

微小店库存接口

增加库存

增加库存需要Post的数据

减少库存

减少库存需要Post的数据

商品ID

sku信息,格式"id1:vid1;id2:vid2",如商品为统一规格，则此处赋值为空字符串即可

增加的库存数量

增加库存

减少库存

获取OAuth AccessToken的结果如果错误，返回结果{"errcode":40029,"errmsg":"invalid code"}

接口调用凭证

access_token接口调用凭证超时时间，单位（秒）

用户刷新access_token

授权用户唯一标识

用户授权的作用域，使用逗号（,）分隔

获取验证地址

获取AccessToken

code作为换取access_token的票据，每次用户授权带上的code将不一样，code只能使用一次，5分钟未被使用自动过期。

刷新access_token（如果需要）

填写通过access_token获取到的refresh_token参数

获取用户基本信息

调用接口凭证普通用户的标识，对当前公众号唯一返回国家地区语言版本，zh_CN 简体，zh_TW 繁体，en 英语

检验授权凭证（access_token）是否有效

用户的唯一标识

通过OAuth的获取到的用户信息（snsapi_userinfo=scope）

用户的性别，值为1时是男性，值为2时是女性，值为0时是未知

用户头像，最后一个数值代表正方形头像大小（有0、46、64、96、132数值可选，0代表640*640正方形头像），用户没有头像时该项为空

用户特权信息，json 数组，如微信沃卡用户为（chinaunicom）作者注：其实这个格式称不上JSON，只是个单纯数组。

二维码创建返回结果

获取的二维码ticket，凭借此ticket可以在有效时间内换取二维码。

二维码的有效时间，以秒为单位。最大不超过1800。

二维码图片解析后的地址，开发者可根据该地址自行生成需要的二维码图片

二维码接口

创建二维码

该二维码有效时间，以秒为单位。最大不超过1800。0时为永久二维码场景值ID，临时二维码时为32位整型，永久二维码时最大值为1000 代理请求超时时间（毫秒）

用字符串类型创建二维码

场景值ID（字符串形式的ID），字符串类型，长度限制为1到64，仅永久二维码支持此字段

获取下载二维码的地址

获取二维码（不需要AccessToken）错误情况下（如ticket非法）返回HTTP错误码404。

语意理解接口

发送语义理解请求

语意理解返回的结果类型，在 AdvancedAPIs/Semantic/SemanticResult 语义理解请求需要post的数据代理请求超时时间（毫秒）

用于标识用户请求后的状态文档中写的是res，但实际测试应该是ret

用户的输入字符串

服务的全局类别id

SEARCH 普通查询 ROUTE 路线查询

语义输入协议

输入文本串必填

需要使用的服务类别，多个用,隔开，不能为空必填

纬度坐标，与经度同时传入；与城市二选一传入见说明，选填

经度坐标，与纬度同时传入；与城市二选一传入见说明，选填

城市名称，与经纬度二选一传入见说明，选填

区域名称，在城市存在的情况下可省；与经纬度二选一传入` 见说明，选填

App id，开发者的唯一标识，用于区分开放者，如果为空，则没法使用上下文理解功能。非必填

用户唯一id（并非开发者id），用于区分该开发者下不同用户，如果为空，则没法使用上下文理解功能。appid和uid同时存在的情况下，才可以使用上下文理解功能。非必填

时间相关协议datetime

单时间的描述协议类型：“DT_SINGLE”。DT_SINGLE又细分为两个类别：DT_ORI和DT_INFER。DT_ORI是字面时间，比如：“上午九点”；DT_INFER是推理时间，比如：“提前5分钟” 时间段的描述协议类型：“DT_INTERVAL” 重复时间的描述协议类型：“DT_REPEAT” DT_ REPEAT又细分为两个类别：DT_RORI和DT_RINFER。DT_RORI是字面时间，比如：“每天上午九点”；DT_RINFER是推理时间，比如：“工作日除外”

24小时制，格式：HH:MM:SS，默认为00:00:00

单时间的描述协议datetime

格式：YYYY-MM-DD，默认是当天时间

date的原始字符串

Time的原始字符串

时间段的描述协议datetime

格式：YYYY-MM-DD，默认是当天时间

date的原始字符串

time的原始字符串

格式：YYYY-MM-DD，默认是当前时间

date的原始字符串

24小时制，格式：HH:MM:SS

Time的原始字符串

重复时间的描述协议datetime

time的原始字符串

重复标记：0000000 注：依次代表周日，周六，…，周一；1表示该天要重复，0表示不重复

date的原始字符串

地点相关协议

大类型：“LOC” LOC又细分为如下类别：LOC_COUNTRY、LOC_PROVINCE、LOC_CITY、LOC_TOWN、LOC_POI、NORMAL_POI。

国家

省全称，例如：广东省

省简称，例如：广东|粤

市全称，例如：北京市

市简称，例如：北京

县区全称，例如：海淀区

县区简称，例如：海淀

poi详细地址

原始地名串

说明：begin或end，如果为“-1”表示无上限或者下限，如果为“-2”，表示该字段无信息。 NUM_PRICE：价格相关，例：200元左右 NUM_RADIUS：距离相关，例：200米以内 NUM_DISCOUNT：折扣相关，例：八折 NUM_SEASON：部，季相关，例：第一部 NUM_EPI：集相关，例：第一集

大类型：“NUMBER” NUMBER又细分为如下类别：NUM_PRICE、NUM_PADIUS、NUM_DISCOUNT、NUM_SEASON、NUM_EPI、NUM_CHAPTER。

开始

结束

上映电影服务（movie）

电影名

主演

导演

类型：动作片，剧情片，…

地区：美国，大陆，香港，…

电影院

地点

时间

优惠信息：0无（默认），1优惠券，2团购

排序类型：0排序无要求（默认），1评价高优先级

音乐服务（music）

歌曲名

歌手

专辑

歌曲类型

语言：中文，英文，韩文，日文，…

电影名

电视剧名

节目名

排序类型：0排序无要求（默认），1时间升序，2时间降序，3热度高优先级

餐馆服务（restaurant）

SEARCH 普通查询

地点

餐馆名称

餐馆类型/菜系

菜名

价格（单位元）

距离（单位米）

优惠信息：0无（默认），1优惠券，2团购

排序类型：0距离（默认），1点评高优先级，2服务质量高优先级，3环境高优

地图服务（map）注：地点区域是地点位置的修饰描述，比如：“我现在在皇寺广场远东大厦门口”，起点区域是：“皇寺广场”，起点位置是：“远东大厦门口”。

起点区域

起点位置

终点区域

终点位置

出行方式：walk（步行）, taxi（打车）, bus（公交）, subway（地铁）, drive（自驾）

公交车号

地铁线

排序类型：0较快捷（默认），1少换乘，2少步行

关键词

周边服务（nearby）注：service字段表示是否是服务类，比如：找家政、租房、招聘等即为服务类；找ATM、羽毛球馆等即为非服务类。

SEARCH 普通查询

地点

关键词

限定词

价格（单位元）

距离（单位米）

是否是服务类：0不是（默认），1是

优惠信息：0无（默认），1优惠券，2团购

排序类型：0距离（默认），1点评高优先级，2服务质量高优先级，3环境高优先级，4价格高到低，5价格低到高

团购服务（coupon）

SEARCH 普通查询

地点

价格（单位元）

距离（单位米）

关键词

优惠信息：0所有（默认），1优惠券，2团购

排序类型：0距离（默认），1价格高到低，2价格低到高

酒店服务（hotel）

地点

入住时间

离开时间

酒店名称

价格（单位元）

距离（单位米）

等级：五星级酒店，四星级酒店，三星级酒店，青年旅社，经济型酒店，公寓式酒店

1（有wifi），0（无wifi）

房间类型：标准间，单人间，双人间，三人间

优惠信息：0无（默认），1优惠券，2团购

排序类型：0距离（默认），1点评高优先级，2服务质量高优先级，3环境高优先级，4价格高到低，5价格低到高

火车服务（train）

出发日期

返回日期

起点

终点

车次代码，比如：T43等

座位级别：YZ（硬座），RZ（软座），YW（硬卧），RW（软卧），YD（一等座），ED（二等座），TD（特等座）

车次类型：G（高铁），D（动车），T（特快），K（快速），Z（直达），L（临时客车），P（普通）

类型：DC（单程），WF（往返）

旅游服务（travel）

SEARCH 普通查询 PRICE 价格查询 GUIDE 攻略查询

旅游目的地

景点名称

旅游日期

旅游类型词

0默认，1自由行，2跟团游

航班服务（flight）

航班号

出发地

目的地

出发日期

返回日期

航空公司

座位级别（默认无限制）：ECONOMY（经济舱）BIZ（商务舱）FIRST（头等舱）

排序类型：0排序无要求（默认），1价格升序，2价格降序，3时间升序，4时间降序

视频服务（video）

视频名

主演/嘉宾

导演/主持人

视频类型：MOVIE（电影），TV（电视剧），COMIC（动漫），SHOW（综艺节目），OTHER（其他）

类型：动作片，剧情片，…

地区：美国，大陆，香港，…

季，部等

集

排序类型：0好评（默认），1热门，2经典

小说服务（novel）

小说名

小说作者

小说类型

小说章节

排序类型：0排序无要求（默认），1热度高优先级，2时间升序，3时间降序

百科服务（baike）

百科关键词

股票服务（stock）注：1、币种单位同上市所在地；2、如果用户输入的时间是未来的时间，那么结果展示的是当前时间的信息。

股票名称

标准股票代码

市场：sz,sh,hk,us

时间

股票代码

当前价

涨幅

涨幅比例

最高价

最低价

成交量(单位：万)

成交额(单位：亿)

市盈率

市值(单位：亿)

提醒服务（remind）

时间

事件

类别：0提醒；1闹钟注：提醒有具体事件，闹钟没有具体事件

常用电话服务（telephone）

名字

电话

菜谱服务（cookbook）

菜名

菜系

食材

天气服务（weather）

地点

时间

资讯服务（news）

关键词

新闻类别

电视节目预告（tv）

播放时间

电视台名称

电视频道名称

节目名称

节目类型

通用指令（instruction）[beta]

数字，根据intent有不同的含义，例如：把声音调到20；

操作值：STANDARD(标准模式)，MUTE(静音模式)，VIBRA(振动模式)，INAIR(飞行模式)，RING(铃声)，WALLPAPER(壁纸)，TIME(时间)，WIFI(无线网络)，BLUETOOTH(蓝牙)，GPS(GPS)，NET(移动网络)，SPACE(存储空间)，INPUT(输入法设置)，LANGUAGE(语言设置)，PERSONAL(个性化设置)，SCREEN(屏幕保护)，FACTORY_SETTINGS (出厂设置)，SI(系统信息)，UPDATE(系统更新)，PLAY(播放)，OPEN_MUSIC(开机音乐)，TIME_ON(定时开机)，TIME_OFF(定时关机)

操作值：OPEN (打开)，CLOSE (关闭)，MIN (最小)，MAX (最大)，UP (变大)，DOWN (变小)

电视指令（tv_instruction）[beta]

电视台名称

电视频道名称

节目类型

数字，根据intent有不同的含义，例如：把声音调到20；换到5台。

操作值：3D，AV(视频)，AV1(视频1)，AV2(视频2)，HDMI，HDMI1，HDMI2，HDMI3，DTV，ATV，YPBPR，DVI，VGA，USB，ANALOG(模拟电视)，DIGITAL(数字电视)，IMAGE(图像设置)，SCREEN(屏幕比例)，SOUND(声音模式) ，IMAGE_MODEL(图像模式)

操作值：OPEN (打开)，CLOSE (关闭)

设备：U(U盘)，CLOUD(云存储)

文件类型：VIDEO(视频)，TEXT(文本)，APP(安装包)，PIC(照片)，MUSIC(音乐)

车载指令（car_instruction）[beta]

数字，根据intent有不同的含义，例如：把温度调到20度

窗户位置：1(司机)，2(副驾驶)，3(司机后面)，4(副驾驶后面)，5(天窗)

操作值：OPEN (打开)，CLOSE (关闭)，MIN (最小)，MAX (最大)，UP (变大)，DOWN (变小)

应用服务（app）

app名称

app类别

排序方式：0（按质量从高到低），1（按时间从新到旧）

查看的类型：install（已安装），buy（已购买），update（可更新），latest（最近运行的），home（主页）

网址服务（website）

网址名

url

网页搜索（search））

关键词

搜索引擎类型：google, baidu, sogou, 360, taobao,jingdong

摇一摇周边接口

申请开通功能

查询审核状态

申请设备ID

调用接口凭证申请的设备ID的数量，单次新增设备超过500个，需走人工审核流程申请理由，不超过100个字备注，不超过15个汉字或30个英文字母设备关联的门店ID，关联门店后，在门店1KM的范围内有优先摇出信息的机会。

编辑设备信息设备编号，若填了UUID、major、minor，则可不填设备编号，若二者都填，则以设备编号为优先 UUID、major、minor，三个信息需填写完整，若填了设备编号，则可不填此信息。

设备编号

配置设备与门店的关联关系设备编号，若填了UUID、major、minor，则可不填设备编号，若二者都填，则以设备编号为优先 UUID、major、minor，三个信息需填写完整，若填了设备编号，则可不填此信息。

调用接口凭证设备编号 Poi_id 的说明改为：设备关联的门店ID，关联门店后，在门店1KM的范围内有优先摇出信息的机会。

查询设备列表Api url

根据指定的设备Id查询设备列表

设备Id列表设备编号，若填了UUID、major、minor，则可不填设备编号，若二者都填，则以设备编号为优先 UUID、major、minor，三个信息需填写完整，若填了设备编号，则可不填此信息。

根据分页查询或者指定范围查询设备列表

根据批次ID查询设备列表

上传图片素材上传在摇一摇页面展示的图片素材，素材保存在微信侧服务器上。格式限定为：jpg,jpeg,png,gif，图片大小建议120px*120 px，限制不超过200 px *200 px，图片需为正方形。

新增页面

调用接口凭证在摇一摇页面展示的主标题，不超过6个字在摇一摇页面展示的副标题，不超过7个字点击页面跳转链接在摇一摇页面展示的图片。图片需先上传至微信侧服务器，用“素材管理-上传图片素材”接口上传图片，返回的图片URL再配置在此处页面的备注信息，不超过15个字

编辑页面信息

调用接口凭证摇周边页面唯一ID 在摇一摇页面展示的主标题，不超过6个字在摇一摇页面展示的副标题，不超过7个字点击页面跳转链接在摇一摇页面展示的图片。图片需先上传至微信侧服务器，用“素材管理-上传图片素材”接口上传图片，返回的图片URL再配置在此处页面的备注信息，不超过15个字

根据页面Id查询页面列表

指定页面的Id数组

根据分页或者指定范围查询页面列表

删除页面

指定页面的Id数组

配置设备与页面的关联关系配置设备与页面的关联关系。支持建立或解除关联关系，也支持新增页面或覆盖页面等操作。配置完成后，在此设备的信号范围内，即可摇出关联的页面信息。若设备配置多个页面，则随机出现页面信息。一个设备最多可配置30个关联页面。

设备编号，若填了UUID、major、minor，则可不填设备编号，若二者都填，则以设备编号为优先 UUID、major、minor，三个信息需填写完整，若填了设备编号，则可不填此信息关联操作标志位， 0为解除关联关系，1为建立关联关系新增操作标志位， 0为覆盖，1为新增

获取摇周边的设备及用户信息

调用接口凭证摇周边业务的ticket，可在摇到的URL中得到，ticket生效时间为30分钟，每一次摇都会重新生成新的ticket 是否需要返回门店poi_id，传1则返回，否则不返回

以设备为维度的数据统计接口

调用接口凭证指定页面的设备ID 设备编号，若填了UUID、major、minor，即可不填设备编号，二者选其一 UUID、major、minor，三个信息需填写完成，若填了设备编辑，即可不填此信息，二者选其一起始日期时间戳，最长时间跨度为30天结束日期时间戳，最长时间跨度为30天

以页面为维度的数据统计接口

调用接口凭证指定页面的设备ID 起始日期时间戳，最长时间跨度为30天结束日期时间戳，最长时间跨度为30天

查询审核状态返回结果

提交申请的时间戳

审核备注，包括审核不通过的原因

审核状态。0：审核未通过、1：审核中、2：审核已通过；审核会在三个工作日内完成

确定审核结果的时间戳；若状态为审核中，则该时间值为0

新增与编辑页面返回结果基类

返回数据

页面id

新增页面返回结果

编辑页面返回结果

查询页面列表返回结果

查询页面列表返回数据

页面基本信息

商户名下的页面总数

页面的备注信息

在摇一摇页面展示的副标题

在摇一摇页面展示的图片

摇周边页面唯一ID

跳转链接

在摇一摇页面展示的主标题

获取摇周边的设备及用户信息返回结果

获取摇周边的设备及用户信息返回数据

摇周边页面唯一ID

设备信息，包括UUID、major、minor，以及距离

商户AppID下用户的唯一标识

门店ID，有的话则返回，反之不会在JSON格式内

Beacon信号与手机的距离，单位为米

申请开通功能数据

数据统计返回结果

数据统计返回数据

点击摇周边消息的次数

点击摇周边消息的人数

当天0点对应的时间戳

摇周边的次数

摇周边的人数

上传图片素材返回结果

申请设备ID返回数据

图片url地址，用在“新增页面”和“编辑页面”的“icon_url”字段

申请设备ID返回结果

申请设备ID返回数据

申请的批次ID，可用在“查询设备列表”接口按批次查询本次申请成功的设备ID。

指定的设备ID列表

审核状态。0：审核未通过、1：审核中、2：审核已通过；审核会在三个工作日内完成

审核备注，包括审核不通过的原因

设备编号

查询设备列表返回结果

申请设备ID返回数据

指定的设备信息列表

商户名下的设备总量

设备的备注信息

设备编号

与此设备关联的页面ID列表，用逗号隔开

激活状态，0：未激活，1：已激活（但不活跃），2：活跃

设备关联的门店ID

门店管理接口

上传图片

文件路径

创建门店

查询门店信息

查询门店列表

开始位置，0 即为从第一条开始查询返回数据条数，最大允许50，默认为20

删除门店

修改门店服务信息

修改门店服务信息需要Post的数据商户可以通过该接口，修改门店的服务信息，包括：图片列表、营业时间、推荐、特色服务、简介、人均价格、电话7 个字段。目前基础字段包括（名称、坐标、地址等不可修改）若有填写内容则为覆盖更新，若无内容则视为不修改，维持原有内容。 photo_list 字段为全列表覆盖，若需要增加图片，需将之前图片同样放入list 中，在其后增加新增图片。如：已有A、B、C 三张图片，又要增加D、E 两张图，则需要调用该接口，photo_list 传入A、B、C、D、E 五张图片的链接。

获取门店类目表

可以被修改的门店基础信息

门店的电话必填

图片列表，url 形式，可以有多张图片，尺寸为640*340px。必须为上一接口生成的url 必填

推荐品，餐厅可为推荐菜；酒店为推荐套房；景点为推荐游玩景点等，针对自己行业的推荐内容非必填

特色服务，如免费wifi，免费停车，送货上门等商户能提供的特色功能或服务必填

商户简介，主要介绍商户信息等非必填

营业时间，24 小时制表示，用“-”连接，如8:00-20:00 必填

人均价格，大于0 的整非必填

门店基础信息

商户自己的id，用于后续审核通过收到poi_id 的通知时，做对应关系。请商户自己保证唯一识别性非必填

门店名称必填

分店名称非必填

门店所在的省必填

门店所在的市必填

门店所在的区非必填

门店所在的详细街道地址必填

门店的类型（酒店、餐饮、购物...）必填

坐标类型，1 为火星坐标（目前只能选1）

门店所在地理位置的经度（建议使用腾讯地图定位经纬度）必填

门店所在地理位置的纬度必填

图片Url

创建门店需要Post的数据

门店信息

修改门店服务信息需要Post的数据

微信的门店ID，微信内门店唯一标示ID

查询门店信息返回结果

门店信息

查询门店基础信息

门店是否可用状态。1 表示系统错误、2 表示审核中、3 审核通过、4 审核驳回。当该字段为1、2、4 状态时，poi_id 为空

扩展字段是否正在更新中。1 表示扩展字段正在更新中，尚未生效，不允许再次更新； 0 表示扩展字段没有在更新中或更新已生效，可以再次更新

查询门店列表返回结果

门店总数量

审核通过才会返回此字段

门店名称（仅为商户名，如：国美、麦当劳，不应包含地区、店号等信息，错误示例：北京国美）

分店名称（不应包含地区信息、不应与门店名重复，错误示例：北京王府井店）

门店所在的详细街道地址（不要填写省市信息）

门店是否可用状态。1 表示系统错误、2 表示审核中、3 审核通过、4 审核驳回。当该字段为1、2、4 状态时，poi_id 为空

获取门店类目表返回结果

上传图片返回结果

上传成功后图片的链接

模板消息接口

代理请求超时时间（毫秒）

发送模板消息结果

msgid

模板消息的数据项类型

value color

项目值

16进制颜色代码，如：#FF0000

目标用户OpenId

模板ID

模板消息顶部颜色（16进制），默认为#FF0000

数据

用户增减数据单条数据

数据的日期

用户的渠道，数值代表的含义如下： 0代表其他 30代表扫二维码 17代表名片分享 35代表搜号码（即微信添加朋友页的搜索） 39代表查询微信公众帐号 43代表图文页右上角菜单

新增的用户数量

取消关注的用户数量，new_user减去cancel_user即为净增用户数量

累计用户数据单条数据

数据的日期

总用户量

用户接口

获取用户信息

调用接口凭证普通用户的标识，对当前公众号唯一返回国家地区语言版本，zh_CN 简体，zh_TW 繁体，en 英语

获取关注者OpenId信息

修改关注者备注信息

调用接口凭证普通用户的标识，对当前公众号唯一新的备注名，长度必须小于30字符代理请求超时时间（毫秒）

批量获取用户基本信息

批量获取用户基本信息数据

用户的标识，对当前公众号唯一必填

国家地区语言版本，zh_CN 简体，zh_TW 繁体，en 英语，默认为zh-CN 非必填

高级接口获取的用户信息

用户是否订阅该公众号标识，值为0时，代表此用户没有关注该公众号，拉取不到其余信息。

批量获取用户基本信息返回结果

添加设备

门店ID 无线网络设备的ssid，不能包含中文字符，必需是“WX”开头(“WX”为大写字母) 无线网络设备的密码，大于8个字符，不能包含中文字符无线网络设备无线mac地址，格式冒号分隔，字符长度17个，并且字母小写，例如：00:1f:7a:ad:5c:a8

查询设备

分页下标，默认从1开始每页的个数，默认10个，最大20个根据门店id查询

删除设备

需要删除的无线网络设备无线mac地址，格式冒号分隔，字符长度17个，并且字母小写，例如：00:1f:7a:ad:5c:a8

获取物料二维码

设置商家主页传入自定义链接则是使用自定义链接，否则使用默认模板

门店ID 自定义链接（选择传入）

查询商家主页

查询的门店id

数据统计

起始日期时间，格式yyyy-mm-dd，最长时间跨度为30天结束日期时间戳，格式yyyy-mm-dd，最长时间跨度为30天按门店ID搜索，-1为总统计

查询商家主页返回结果

门店ID

模板类型

商家主页链接

数据统计返回结果

门店ID，-1为总统计

统计时间，单位为毫秒

微信连wifi成功人数

商家主页访问人数

新增公众号关注人数

累计公众号关注人数

获取物料二维码返回结果

二维码图片url

查询设备返回结果

总数

分页下标

分页页数

当前页列表数组

门店ID

连网设备ssid

无线MAC地址

自动更新Passport的链接方法

API操作容器（每次构造都会获取当前缓存中最新的Passport）

API调用类基类

获取用户信息

注册P2P应用基本信息（可以选择不立即载入Passport以节省系统启动时间）

P2P后台申请到微信应用后的AppKey AppKey对应的Secret API地址，建议使用默认值是否马上获取Passport，默认为False

申请新的通行证。每次调用完毕前将有1秒左右的Thread.Sleep时间

清除当前的通行证

获取appKey对应的接口集合。调用此方法请确认此appKey已经成功使用SdkManager.Register(appKey, appSecret, appUrl)方法注册过。

微微嗨开发者信息。申请开发者：http://www.weiweihi.com/User/Developer/Apply

在www.weiweihi.com对接微信公众号之后，自动生成的WeiweihiKey。

JSON返回结果（用于菜单接口等）

如果结果未成功，则Data为期望的类型

错误信息，如果结果为成功，错误信息为Null

Api执行时间

获取微信会员信息结果

Base64格式的头像信息，当提供HeadImageUrl时不再提供HeadImageBase64

头像URL地址

普通API返回类型

获取通行证结果

获取OAuth AccessToken的结果如果错误，返回结果{"errcode":40029,"errmsg":"invalid code"}

JSON返回结果（用于菜单接口等）

过期时间Ticks

过期时间

P2P通行证

API常规URL

供微微嗨服务器记录唯一开发人员ID

P2P返回结果类型

性别

获取验证地址

正在使用此APP的weixinId 此App的唯一标识。可以在此APP的【开发接入】页面的【OAuth认证设置】页面看到

获取AccessToken

此App的唯一标识。可以在此APP的【开发接入】页面的【OAuth认证设置】页面看到对应此App的唯一标识的密码。可以在此APP的【开发接入】页面的【OAuth认证设置】页面看到 code作为换取access_token的票据，每次用户授权带上的code将不一样，code只能使用一次，5分钟未被使用自动过期。

同时管理多个应用的Passport的容器

统一URL前缀，如http://api.weiweihi.com:8080/App/Api

如果>0则进入某个APP状态，如果=0则维持当前状态不变，如果>0则退出某个App状态

改变状态的AppId

错误信息

微信请求中ToUserName包含的信息

使用此应用的微信账号ID（在微微嗨平台上的唯一ID）

被请求应用的唯一ID

获取RequestMessage中ToUserName中的信息（这条信息由微微嗨平台向APP发出）

RequestMessage中的ToUserName属性

获取RequestMessage中ToUserName中的信息（这条信息由微微嗨平台向APP发出）

AccessToken及JsApiTicket包

只针对这个AppId的锁

通用接口AccessToken容器，用于自动管理AccessToken，如果过期会重新获取

注册应用凭证信息，此操作只是注册，不会马上获取Token，并将清空之前的Token，

返回已经注册的第一个AppId

使用完整的应用凭证获取Token，如果不存在将自动注册

获取可用Token

是否强制重新获取新的Token

获取可用Token

是否强制重新获取新的Token

使用完整的应用凭证获取Ticket，如果不存在将自动注册

获取可用Ticket

是否强制重新获取新的Ticket

获取可用Ticket

是否强制重新获取新的Ticket

通用接口通用接口用于和微信服务器通讯，一般不涉及自有网站服务器的通讯

创建菜单

AccessToken或AppId。当为AppId时，如果AccessToken错误将自动获取一次。当为null时，获取当前注册的第一个AppId。菜单内容

获取单击按钮

从JSON字符串获取菜单对象

获取当前菜单，如果菜单不存在，将返回null

根据微信返回的Json数据得到可用的GetMenuResult结果

删除菜单

获取凭证接口

获取access_token填写client_credential 第三方用户唯一凭证第三方用户唯一凭证密钥，既appsecret

用户信息接口

获取调用微信JS接口的临时票据

jsapi_ticket请求后的JSON返回格式

获取到的凭证

凭证有效时间，单位：秒

单个按键

所有单击按钮的基类（view，click等）

所有按钮基类

按钮描述，既按钮名字，不超过16个字节，子菜单不超过40个字节

按钮类型（click或view）

类型为scancode_push时必须。用户点击按钮后，微信客户端将调起扫一扫工具，完成扫码操作后显示扫描结果（如果是URL，将进入URL），且会将扫码的结果传给开发者，开发者可以下发消息。仅支持微信iPhone5.4.1以上版本，和Android5.4以上版本的微信用户，旧版本微信用户点击后将没有回应，开发者也不能正常接收到事件推送。

事件之微小店订单付款通知

接收到请求的消息

事件类型

订单号

订单状态

商品ID

事件之摇一摇事件通知(ShakearoundUserShake)

事件类型

最近的IBeacon信息

附近的IBeacon信息

事件之接收会员信息事件通知（submit_membercard_user_info）卡券会员卡

事件类型

卡券ID

卡券Code码

从卡券进入公众号会话

卡券ID

卡券Code码

进入会员卡

卡券ID

商户自定义code值。非自定code推送为空串。

卡券核销

卡券ID

卡券Code码

核销来源。支持开发者统计API核销（FROM_API）、公众平台核销（FROM_MP）、卡券商户助手核销（FROM_MOBILE_HELPER）（核销员微信号）

事件之Wi-Fi连网成功

事件类型

连网时间

系统保留字段，固定值

连网的门店id

连网的设备无线mac地址，对应bssid

事件之审核结果事件推送

事件类型

商户自己内部ID，即字段中的sid

微信的门店ID，微信内门店唯一标示ID

审核结果，成功succ 或失败fail

成功的通知信息，或审核失败的驳回理由

事件推送群发结果。由于群发任务提交后，群发任务可能在一定时间后才完成，因此，群发接口调用时，仅会给出群发任务是否提交成功的提示，若群发任务提交成功，则在群发任务结束时，会向开发者在公众平台填写的开发者URL（callback URL）推送事件。

群发的结构，为“success”（送达成功）或“failed:user block”（送达由于用户拒收（用户设置拒绝接收公众号消息））或“failed: system failed”（送达由于其他原因失败）。

消息id

事件之弹出地理位置选择器（location_select）

具有EventKey属性的RequestMessage接口

事件类型

事件KEY值，与自定义菜单接口中KEY值对应

发送的位置信息

事件之弹出微信相册发图器(pic_weixin)

事件类型

事件KEY值，与自定义菜单接口中KEY值对应

发送的图片信息

弹出地理位置选择器的事件推送中的SendLocationInfo

X坐标信息

Y坐标信息

精度，可理解为精度或者比例尺、越精细的话 scale越高

地理位置的字符串信息

朋友圈POI的名字，可能为空

卡券通过审核

卡券ID

卡券未通过审核

卡券ID

领取卡券

赠送方账号（一个OpenID），"IsGiveByFriend”为1时填写该参数

卡券ID

是否为转赠，1 代表是，0 代表否。

code 序列号。自定义code 及非自定义code的卡券被领取后都支持事件推送。

领取场景值，用于领取渠道数据统计。可在生成二维码接口及添加JS API 接口中自定义该字段的整型值。

删除卡券

卡券ID

code 序列号。自定义code 及非自定义code的卡券被领取后都支持事件推送。

事件之多客服接入会话(kf_create_session)

事件类型

完整客服账号，格式为：账号前缀@公众号微信号

事件之多客服关闭会话(kf_close_session)

事件类型

完整客服账号，格式为：账号前缀@公众号微信号

事件之多客服转接会话kf_switch_session)

事件类型

完整客服账号，格式为：账号前缀@公众号微信号

Beacon的参数以及距离

设备与用户的距离（浮点数；单位：米）

微信公众服务器Post过来的加密参数集合（不包括PostData）

设置服务器内部保密信息

扫码事件中的ScanCodeInfo

系统拍照发图中的SendPicsInfo

发送的图片数量

图片列表

图片的MD5值，开发者若需要，可用于验证接收到图片

视频消息媒体id，可以调用多媒体文件下载接口拉取数据。

视频消息缩略图的媒体id，可以调用多媒体文件下载接口拉取数据。

响应回复消息

获取响应类型实例，并初始化

请求响应类型

获取响应类型实例，并初始化

需要返回的类型请求数据

从返回结果XML转换成IResponseMessageBase实体类

返回给服务器的Response Xml

接收消息类型

当RequestMsgType类型为Event时，Event属性的类型

进入会话（似乎已从官方API中移除）

地理位置（似乎已从官方API中移除）

取消订阅

自定义菜单点击事件

二维码扫描

URL跳转

事件推送群发结果

模板信息发送完成

扫码推事件

扫码推事件且弹出“消息接收中”提示框

弹出系统拍照发图

弹出拍照或者相册发图

弹出微信相册发图器

弹出地理位置选择器

卡券通过审核

卡券未通过审核

领取卡券

删除卡券

多客服接入会话

多客服关闭会话

多客服转接会话

审核结果事件推送

Wi-Fi连网成功

卡券核销

进入会员卡

从卡券进入公众号会话

微小店订单付款通知

接收会员信息事件通知

摇一摇事件通知

发送消息类型

菜单按钮类型

点击

Url

扫码推事件

扫码推事件且弹出“消息接收中”提示框

弹出系统拍照发图

弹出拍照或者相册发图

弹出微信相册发图器

弹出地理位置选择器

上传媒体文件类型

图片: 128K，支持JPG格式

语音：256K，播放长度不超过60s，支持AMR\MP3格式

视频：1MB，支持MP4格式

thumb：64KB，支持JPG格式

图文消息

文本

语音

图片

视频

卡券

卡券类型

通用券

团购券

折扣券

礼品券

代金券

会员卡

门票

电影票

飞机票

红包

会议门票

卡券code码展示类型

文本

一维码

二维码

卡券商户自定义cell 名称

外卖

在线预订

立即使用

在线预约

在线兑换

车辆信息

等级

优惠券

印花

折扣

成就

里程

应用授权作用域

不弹出授权页面，直接跳转，只能获取用户openid

弹出授权页面，可通过openid拿到昵称、性别、所在地。并且，即使在未关注的情况下，只要用户授权，也能获取其信息

关联操作标志位， 0为解除关联关系，1为建立关联关系

新增操作标志位， 0为覆盖，1为新增

卡券使用时间的类型

固定日期区间

固定时长（自领取后按天算）

永久有效

自动回复规则类型

文本

图片

语音

视频

图文消息

自动回复模式

全部回复

随机回复其中一条

自动回复匹配模式

消息中含有该关键词即可

消息内容必须和关键词严格相同

卡券创建货架投放页面的场景值

附近

自定义菜单

二维码

公众号文章

h5页面

自动回复

卡券自定义cell

根据XML信息填充实实体

MessageBase为基类的类型，Response和Request都可以实体 XML

将实体转为XML

RequestMessage或ResponseMessage 实体

将实体转为XML字符串

RequestMessage或ResponseMessage 实体

ResponseMessageBase.CreateFromRequestMessage<T>(requestMessage)的扩展方法

需要生成的ResponseMessage类型 IRequestMessageBase接口下的接收信息类型

ResponseMessageBase.CreateFromResponseXml(xml)的扩展方法

返回给服务器的Response Xml

检查是否是通过场景二维码扫入

根据xml信息，返回RequestMsgType

根据xml信息，返回ResponseMsgType

获取随机字符串

获取时间戳

sha1加密

生成cardSign的加密方法

添加卡券Ext参数的签名加密方法

获取JS-SDK权限验证的签名Signature

获取位置签名AddrSign

获取卡券签名CardSign

获取添加卡券时Ext参数内的签名

签名算法

微信请求的集中处理方法此方法中所有过程，都基于Senparc.Weixin.MP的基础功能，只为简化代码而设。

上下文（仅限于当前MessageHandler基类内）

构造MessageHandler

请求消息流 PostModel 单个用户上下文消息列表储存的最大长度微微嗨开发者信息，如果不为空，则优先请求云端应用商店的资源

构造MessageHandler

请求消息的XML PostModel 单个用户上下文消息列表储存的最大长度微微嗨开发者信息，如果不为空，则优先请求云端应用商店的资源

直接传入IRequestMessageBase，For UnitTest

PostModel 单个用户上下文消息列表储存的最大长度微微嗨开发者信息，如果不为空，则优先请求云端应用商店的资源

根据当前的RequestMessage创建指定类型的ResponseMessage

基于ResponseMessageBase的响应消息类型

执行微信请求

Event事件类型请求

Event事件类型请求之ENTER

Event事件类型请求之LOCATION

Event事件类型请求之subscribe

Event事件类型请求之unsubscribe

Event事件类型请求之CLICK

Event事件类型请求之scan

事件之URL跳转视图（View）

事件推送群发结果

发送模板消息返回结果

弹出拍照或者相册发图

扫码推事件

扫码推事件且弹出“消息接收中”提示框

弹出地理位置选择器

弹出微信相册发图器

弹出系统拍照发图

卡券通过审核

卡券未通过审核

领取卡券

删除卡券

多客服接入会话

多客服关闭会话

多客服转接会话

Event事件类型请求之审核结果事件推送

Event事件类型请求之Wi-Fi连网成功

Event事件类型请求之卡券核销

Event事件类型请求之从卡券进入公众号会话

Event事件类型请求之进入会员卡

Event事件类型请求之微小店订单付款通知

Event事件类型请求之接收会员信息事件通知

Event事件类型请求之摇一摇事件通知

默认返回消息（当任何OnXX消息没有被重写，都将自动返回此默认消息）

预处理文字或事件类型请求。这个请求是一个比较特殊的请求，通常用于统一处理来自文字或菜单按钮的同一个执行逻辑，会在执行OnTextRequest或OnEventRequest之前触发，具有以下一些特征： 1、如果返回null，则继续执行OnTextRequest或OnEventRequest 2、如果返回不为null，则终止执行OnTextRequest或OnEventRequest，返回最终ResponseMessage 3、如果是事件，则会将RequestMessageEvent自动转为RequestMessageText类型，其中RequestMessageText.Content就是RequestMessageEvent.EventKey

文字类型请求

位置类型请求

图片类型请求

语音类型请求

视频类型请求

链接消息类型请求

小视频类型请求

全局消息上下文

原始的加密请求（如果不加密则为null）

根据ResponseMessageBase获得转换后的ResponseDocument 注意：这里每次请求都会根据当前的ResponseMessageBase生成一次，如需重用此数据，建议使用缓存或局部变量

最后返回的ResponseDocument。这里是Senparc.Weixin.MP，根据请求消息半段在ResponseDocument基础上是否需要再次进行加密（每次获取重新加密，所以结果会不同）

请求实体

响应实体正常情况下只有当执行Execute()方法后才可能有值。也可以结合Cancel，提前给ResponseMessage赋值。

是否使用了加密信息

是否使用了兼容模式加密信息

微微嗨开发者信息

获取XDocument转换后的IRequestMessageBase实例。如果MsgType不存在，抛出UnknownRequestMsgTypeException异常

如Request.InputStream

获取XDocument转换后的IResponseMessageBase实例（通常在反向读取日志的时候用到）。如果MsgType不存在，抛出UnknownRequestMsgTypeException异常

获取XDocument转换后的IRequestMessageBase实例。如果MsgType不存在，抛出UnknownRequestMsgTypeException异常

解密方法

密文将数字转化成ASCII码对应的字符，用于对明文进行补码 @param a 需要转化的数字 @return 转化得到的字符

密钥

请求的参数

debug信息

初始化函数

获取debug信息

获取密钥

设置密钥

设置参数值

创建md5摘要,规则是:按参数名称a-z排序,遇到空值的参数不参加签名

参数名参数值 key和value通常用于填充最后一组参数

输出XML

设置debug信息

'============================================================================ 'Api说明： 'GetKey()/setKey(),获取/设置密钥 'GetParameter()/setParameter(),获取/设置参数值 'GetAllParameters(),获取所有参数 'IsTenpaySign(),是否正确的签名,true:是 false:否 'IsWXsign(),是否正确的签名,true:是 false:否 ' * IsWXsignfeedback判断微信维权签名 ' *GetDebugInfo(),获取debug信息 '============================================================================

密钥

appkey

xmlMap

应答的参数

debug信息

原始内容

初始化函数

获取页面提交的get和post参数

获取密钥

设置密钥

获取参数值

设置参数值

是否财付通签名,规则是:按参数名称a-z排序,遇到空值的参数不参加签名。return boolean

获取debug信息

设置debug信息

输出XML

微信支付信息集合，Key为商户号（MchId）

注册TenPayV3Info信息

微信支付基础信息储存类

第三方用户唯一凭证appid

第三方用户唯一凭证密钥，即appsecret

商户ID

商户支付密钥Key。登录微信商户后台，进入栏目【账户设置】【密码安全】【API 安全】【API 密钥】

支付完成后的回调处理页面

TenpayUtil 的摘要说明。配置文件

随机生成Noncestr

对字符串进行URL编码

对字符串进行URL解码

取时间戳生成随即数,替换交易单号中的后10位流水号

取随机数

统一支付接口统一支付接口，可接受JSAPI/NATIVE/APP 下预支付订单，返回预支付订单号。NATIVE 支付返回二维码code_url。

微信支付需要post的xml数据

Native

开放平台账户的唯一标识时间戳商户Id 32 位内的随机串，防重发商品唯一id 签名

订单查询接口

关闭订单接口

关闭订单需要post的xml数据

退款查询接口

对账单接口

短链接转换接口

刷卡支付提交被扫支付

基础返回结果

统一支付接口在 return_code为 SUCCESS的时候有返回

微信分配的公众账号ID

微信支付分配的商户号

微信支付分配的终端设备号

随机字符串，不长于32 位

签名

SUCCESS/FAIL

统一支付接口在return_code 和result_code 都为SUCCESS 的时候有返回

交易类型:JSAPI、NATIVE、APP

微信生成的预支付ID，用于后续接口调用中使用

trade_type为NATIVE时有返回，此参数可直接生成二维码展示出来进行扫码支付

网关url地址

密钥

请求的参数

debug信息

初始化函数

获取入口地址,不包含参数值

设置入口地址,不包含参数值

获取密钥

设置密钥

获取带参数的请求URL @return String

创建md5摘要,规则是:按参数名称a-z排序,遇到空值的参数不参加签名。

获取参数值

设置参数值

获取debug信息

设置debug信息

对账单下载接口

退款明细查询接口

密钥

应答的参数

debug信息

原始内容

获取服务器通知数据方式，进行参数获取

获取密钥

设置密钥

获取参数值

设置参数值

是否财付通签名,规则是:按参数名称a-z排序,遇到空值的参数不参加签名 @return boolean

获取debug信息

设置debug信息

是否财付通签名,规则是:按参数名称a-z排序,遇到空值的参数不参加签名 @return boolean

Native

签名开放平台账户的唯一标识时间戳 32 位内的随机串，防重发商品唯一id

发货通知

公众平台账户的AppId 购买用户的OpenId 交易单号第三方订单号发货时间戳发货状态，1 表明成功，0 表明失败，失败时需要在deliver_msg 填上失败原因发货状态信息，失败时可以填上UTF8 编码的错误提示信息，比如“该商品已退款签名签名方法

订单查询

公众平台账户的AppId 查询订单的关键信息数据 linux 时间戳签名签名方法

订单查询

微信支付维权接口，官方API：https://mp.weixin.qq.com/htmledition/res/bussiness-course2/wxm-payment-kf-api.pdf

标记客户的投诉处理状态

支付该笔订单的用户 ID 投诉单号

代理请求注意！使用代理必然导致网络访问节点增加，会加重响应延时，因此建议准备至少2-3秒的延迟时间的准备，如果增加2-3秒后远远超过5秒的微信服务器等待时间，需要慎重使用，否则可能导致用户无法收到消息。此外这个类中的方法也可以用于模拟服务器发送消息到自己的服务器进行测试。

默认代理请求超时时间（毫秒）

获取Xml结果。

是否使用WeiWeiHiKey，如果使用，则token为WeiWeiHiKey 代理请求超时时间（毫秒）

获取Xml结果

代理请求超时时间（毫秒）

对接Souidea（P2P）平台，获取Xml结果，使用WeiWeiHiKey对接 WeiWeiHiKey的获取方式请看：

代理请求超时时间（毫秒）

获取ResponseMessge结果

代理请求超时时间（毫秒）

获取ResponseMessge结果

代理请求超时时间（毫秒）

获取微微嗨（前Souidea）开放平台的ResponseMessge结果

代理请求超时时间（毫秒）

获取Souidea开放平台的ResponseMessge结果

代理请求超时时间（毫秒）

获取Souidea开放平台的ResponseMessge结果

代理请求超时时间（毫秒）

使用GET请求测试URL和TOKEN是否可用

代理请求超时时间（毫秒）

签名验证类

在网站没有提供Token（或传入为null）的情况下的默认Token，建议在网站中进行配置。

检查签名是否正确

需要提供：Timestamp、Nonce、Token

检查签名是否正确

返回正确的签名

需要提供：Timestamp、Nonce、Token

返回正确的签名

针对AccessToken无效或过期的自动处理类

使用AccessToken进行操作时，如果遇到AccessToken错误的情况，重新获取AccessToken一次，并重试。使用此方法之前必须使用AccessTokenContainer.Register(_appId, _appSecret);或JsApiTicketContainer.Register(_appId, _appSecret);方法对账号信息进行过注册，否则会出错。

AccessToken或AppId。如果为null，则自动取已经注册的第一个appId/appSecret来信息获取AccessToken。请保留默认值true，不用输入。

使用AccessToken进行操作时，如果遇到AccessToken错误的情况，重新获取AccessToken一次，并重试

第一个参数为accessToken

标记大小

（可选）有大中小三个值，分别为s、m、l。

（可选）Color = [0x000000, 0xffffff]或使用css定义的颜色表。 black 0x000000 silver 0xC0C0C0 gray 0x808080 white 0xFFFFFF maroon 0x800000 red 0xFF0000 purple 0x800080 fuchsia 0xFF00FF green 0x008000 lime 0x00FF00 olive 0x808000 yellow 0xFFFF00 navy 0x000080 blue 0x0000FF teal 0x008080 aqua 0x00FFFF

（可选）指定集合 {A-Z, 0-9} 中的一个大写字母数字字符。不指定时显示A。

自定义icon的地址，图片格式目前仅支持png32的。设置自定义图标标注时，忽略Size、Color、Label三个属性，只设置该属性且该属性前增加-1，如markerStyles=-1, http://api.map.baidu.com/images/marker_red.png，图标大小需小于5k，超过该值会导致加载不上图标的情况发生。

经度longitude（对应GoogleMap的X）

纬度latitude（对应GoogleMap的Y）

将RequestMessageEventBase转换成RequestMessageText类型，其中Content = requestMessage.EventKey

标记大小

（可选）指定集合 {tiny, mid, small} 中的标记大小。如果未设置 size 参数，标记将以其默认（常规）大小显示。

（可选）指定 24 位颜色（例如 color=0xFFFFCC）或集合 {black, brown, green, purple, yellow, blue, gray, orange, red, white} 中预定义的一种颜色。

（可选）指定集合 {A-Z, 0-9} 中的一个大写字母数字字符。

经度longitude

纬度latitude

access_token请求后的JSON返回格式

获取到的凭证

凭证有效时间，单位：秒

获取菜单时候的完整结构，用于接收微信服务器返回的Json信息

GetMenu返回的Json结果

上传临时媒体文件返回结果

上传缩略图返回的meidia_id参数.

上传永久媒体文件返回结果

新增的永久素材的media_id

新增的图片素材的图片URL（仅新增图片素材时会返回该字段）

上传图文消息内的图片获取URL返回结果

用户信息

用户是否订阅该公众号标识，值为0时，拉取不到其余信息

普通用户的标识，对当前公众号唯一

普通用户的昵称

普通用户的头像链接

普通用户的语言，简体中文为zh_CN

整个按钮设置（可以直接用ButtonGroup实例返回JSON对象）

按钮数组，按钮个数应为2~3个

单个按键

类型为click时必须。按钮KEY值，用于消息接口(event类型)推送，不超过128字节

子菜单

子按钮数组，按钮个数应为2~5个

Url按钮

类型为view时必须网页链接，用户点击按钮可打开链接，不超过256字节

事件类型

获取用户地理位置（高级接口下才能用）获取用户地理位置的方式有两种，一种是仅在进入会话时上报一次，一种是进入会话后每隔5秒上报一次。公众号可以在公众平台网站中设置。用户同意上报地理位置后，每次进入公众号会话时，都会在进入时上报地理位置，或在进入会话后每5秒上报一次地理位置，上报地理位置以推送XML数据包到开发者填写的URL来实现。

事件类型

地理位置维度，事件类型为LOCATION的时存在

地理位置经度，事件类型为LOCATION的时存在

地理位置精度，事件类型为LOCATION的时存在

群发的结构，为“send success”或“send fail”或“err(num)”。当send success时，也有可能因用户拒收公众号的消息、系统错误等原因造成少量用户接收失败。err(num)是审核失败的具体原因，可能的情况如下： err(10001), //涉嫌广告 err(20001), //涉嫌政治 err(20004), //涉嫌社会 err(20002), //涉嫌色情 err(20006), //涉嫌违法犯罪 err(20008), //涉嫌欺诈 err(20013), //涉嫌版权 err(22000), //涉嫌互推(互相宣传) err(21000), //涉嫌其他

group_id下粉丝数；或者openid_list中的粉丝数

过滤（过滤是指，有些用户在微信设置不接收该公众号的消息）后，准备发送的粉丝数，原则上，FilterCount = SentCount + ErrorCount

发送成功的粉丝数

发送失败的粉丝数

群发的消息ID

图片消息媒体id，可以调用多媒体文件下载接口拉取数据。

图片链接

地理位置纬度

地理位置经度

地图缩放大小

地理位置信息

文本消息内容

语音消息媒体id，可以调用多媒体文件下载接口拉取数据。

语音格式：amr

语音识别结果，UTF8编码开通语音识别功能，用户每次发送语音给公众号时，微信会在推送的语音消息XML数据包中，增加一个Recongnition字段。注：由于客户端缓存，开发者开启或者关闭语音识别功能，对新关注者立刻生效，对已关注用户需要24小时生效。开发者可以重新关注此帐号进行测试。

事件之订阅

事件类型

事件KEY值，qrscene_为前缀，后面为二维码的参数值（如果不是扫描场景二维码，此参数为空）

二维码的ticket，可用来换取二维码图片（如果不是扫描场景二维码，此参数为空）

事件之取消订阅

事件类型

事件之取消订阅

事件类型

事件KEY值，与自定义菜单接口中KEY值对应

消息标题

消息描述

消息链接

事件之二维码扫描（关注微信）

事件类型

事件KEY值，是一个32位无符号整数，即创建二维码时的二维码scene_id

视频消息媒体id，可以调用多媒体文件下载接口拉取数据。

视频消息缩略图的媒体id，可以调用多媒体文件下载接口拉取数据。

事件之URL跳转视图（View）

事件类型

事件KEY值，设置的跳转URL

文章列表，微信客户端只能输出前10条（可能未来数字会有变化，出于视觉效果考虑，建议控制在8条以内）

需要预先上传多媒体文件到微信服务器，只支持认证服务号。

百度地图静态图片API，文档：http://api.map.baidu.com/lbsapi/cloud/staticimg.htm

获取百度地图静态图片

中心点经度中心点维度返回图片大小会根据此标志调整。取值范围为1或2： 1表示返回的图片大小为size= width * height; 2表示返回图片为(width*2)*(height *2)，且zoom加1 注：如果zoom为最大级别，则返回图片为（width*2）*（height*2），zoom不变。地图级别。高清图范围[3, 18]；低清图范围[3,19] 标记列表，如果为null则不输出标记图片宽度。取值范围：(0, 1024]。图片高度。取值范围：(0, 1024]。

获取谷歌今天静态地图Url。API介绍：https://developers.google.com/maps/documentation/staticmaps/?hl=zh-CN

计算两点GPS坐标的距离（单位：米）

第一点的纬度坐标第一点的经度坐标第二点的纬度坐标第二点的经度坐标

获取维度差

千米

获取经度差

千米

MD5UtilHelper 的摘要说明。

获取大写的MD5签名结果

生成Native支付方式使用的二维码

url编码，添加空格转成%20

需要生成二维码的Url

密钥

请求的参数

debug信息

初始化函数

获取debug信息

获取密钥

设置密钥

设置参数值

获取package带参数的签名包

创建md5摘要,规则是:按参数名称a-z排序,遇到空值的参数不参加签名

创建package签名

创建sha1签名

输出XML

设置debug信息

密钥

appkey

xmlMap

应答的参数

debug信息

原始内容

参与签名的参数列表

初始化函数

获取页面提交的get和post参数

获取密钥

设置密钥

获取参数值

设置参数值

是否财付通签名,规则是:按参数名称a-z排序,遇到空值的参数不参加签名。return boolean

判断微信签名

判断微信维权签名

获取debug信息

设置debug信息

TenpayUtil 的摘要说明。配置文件

随机生成Noncestr

对字符串进行URL编码

对字符串进行URL解码

取时间戳生成随即数,替换交易单号中的后10位流水号

取随机数

微信支付基础信息储存类

密钥 appid paysignkey(非appkey) 支付完成后的回调处理页面,*替换成notify_url.asp所在路径

商户号

密钥

appid

paysignkey(非appkey)

支付完成后的回调处理页面,*替换成notify_url.asp所在路径

微信支付信息集合，Key为商户号（PartnerId）

注册WeixinPayInfo信息

退款接口

ResponseHandler 的摘要说明。

密钥

应答的参数

debug信息

获取服务器通知数据方式，进行参数获取

获取密钥

设置密钥

获取参数值

设置参数值

是否财付通签名,规则是:按参数名称a-z排序,遇到空值的参数不参加签名 @return boolean

显示处理结果。 @param show_url 显示处

@throws IOException

获取debug信息

设置debug信息

是否财付通签名,规则是:按参数名称a-z排序,遇到空值的参数不参加签名 @return boolean

请求内容，无论post和get，都用get方式提供

应答内容

请求方法

错误信息

证书文件

证书密码

ca证书文件

超时时间,以秒为单位

http应答编码

字符编码

设置请求内容

获取结果内容

设置请求方法post或者get

获取错误信息

设置证书信息

设置ca

设置超时时间,以秒为单位

获取http状态码

验证服务器证书

执行http调用

单个按键

类型为scancode_waitmsg时必须。用户点击按钮后，微信客户端将调起扫一扫工具，完成扫码操作后，将扫码的结果传给开发者，同时收起扫一扫工具，然后弹出“消息接收中”提示框，随后可能会收到开发者下发的消息。仅支持微信iPhone5.4.1以上版本，和Android5.4以上版本的微信用户，旧版本微信用户点击后将没有回应，开发者也不能正常接收到事件推送。

单个按键

类型为pic_sysphoto时必须。用户点击按钮后，微信客户端将调起系统相机，完成拍照操作后，会将拍摄的相片发送给开发者，并推送事件给开发者，同时收起系统相机，随后可能会收到开发者下发的消息。仅支持微信iPhone5.4.1以上版本，和Android5.4以上版本的微信用户，旧版本微信用户点击后将没有回应，开发者也不能正常接收到事件推送。

单个按键

类型为pic_photo_or_album时必须。用户点击按钮后，微信客户端将弹出选择器供用户选择“拍照”或者“从手机相册选择”。用户选择后即走其他两种流程。仅支持微信iPhone5.4.1以上版本，和Android5.4以上版本的微信用户，旧版本微信用户点击后将没有回应，开发者也不能正常接收到事件推送。

单个按键

类型为pic_weixin时必须。用户点击按钮后，微信客户端将调起微信相册，完成选择操作后，将选择的相片发送给开发者的服务器，并推送事件给开发者，同时收起相册，随后可能会收到开发者下发的消息。仅支持微信iPhone5.4.1以上版本，和Android5.4以上版本的微信用户，旧版本微信用户点击后将没有回应，开发者也不能正常接收到事件推送。

单个按键

类型为location_select时必须。用户点击按钮后，微信客户端将调起地理位置选择工具，完成选择操作后，将选择的地理位置发送给开发者的服务器，同时收起位置选择工具，随后可能会收到开发者下发的消息。仅支持微信iPhone5.4.1以上版本，和Android5.4以上版本的微信用户，旧版本微信用户点击后将没有回应，开发者也不能正常接收到事件推送。

事件之弹出拍照或者相册发图（pic_photo_or_album）

事件类型

事件KEY值，与自定义菜单接口中KEY值对应

发送的图片信息

事件之扫码推事件且弹出“消息接收中”提示框(scancode_waitmsg)

事件类型

事件KEY值，与自定义菜单接口中KEY值对应

扫描信息

事件之扫码推事件(scancode_push)

事件类型

事件KEY值，与自定义菜单接口中KEY值对应

扫描信息

事件之弹出系统拍照发图(pic_sysphoto)

事件类型

事件KEY值，与自定义菜单接口中KEY值对应

发送的图片信息