拉取订单评价数据

应用场景

商户可以通过该接口拉取用户在微信支付交易记录中针对你的支付记录进行的评价内容。商户可结合商户系统逻辑对该内容数据进行存储、分析、展示、客服回访以及其他使用。如商户业务对评价内容有依赖,可主动引导用户进入微信支付交易记录进行评价。



注意:

1. 该内容所有权为提供内容的微信用户,商户在使用内容的过程中应遵从用户意愿

2. 一次最多拉取200条评价数据,可根据时间区间分批次拉取

3. 接口只能拉取最近三个月以内的评价数据

接口链接

https://api.mch.weixin.qq.com/billcommentsp/batchquerycomment

是否需要证书

需要

请求参数

字段名 变量名 必填 类型 示例值 描述
公众账号ID appid String(32) wx8888888888888888 微信分配的公众账号ID(企业号corpid即为此appId)
商户号 mch_id String(32) 1900000109 微信支付分配的商户号
随机字符串 nonce_str String(32) 5K8264ILTKCH16CQ2502SI8ZNMTM67VS 随机字符串,不长于32位。推荐随机数生成算法
签名 sign String(64) 3AE1368BD96B4644FA5823E024CFE938F1B852EFA87919EDDEE324AE24C8C04F 签名,详见签名生成算法
签名类型 sign_type String(32) HMAC-SHA256 签名类型,目前仅支持HMAC-SHA256,默认就是HMAC-SHA256

开始时间

begin_time

String(19)

20170724000000

按用户评论时间批量拉取的起始时间,格式为yyyyMMddHHmmss

结束时间

end_time

String(19)

20170725000000

按用户评论时间批量拉取的结束时间,格式为yyyyMMddHHmmss

位移

offset

uint(64)

0

指定从某条记录的下一条开始返回记录。接口调用成功时,会返回本次查询最后一条数据的offset。商户需要翻页时,应该把本次调用返回的offset 作为下次调用的入参。注意offset是评论数据在微信支付后台保存的索引,未必是连续的

条数

limit

uint(32)

100

一次拉取的条数, 最大值是200,默认是200

<xml>
<appid>wxe062425f740c30d8</appid>
<mch_id>1900000109</mch_id>
<nonce_str>5K8264ILTKCH16CQ2502SI8ZNMTM67VS</nonce_str>
<offset>0</offset>
<limit>100</limit>
<begin_time>20170724000000</begin_time>
<end_time>20170725000000</end_time>
<sign_type>HMAC-SHA256</sign_type>
<sign>3AE1368BD96B4644FA5823E024CFE938F1B852EFA87919EDDEE324AE24C8C04F</sign>
</xml>

返回结果

失败时,返回以下字段

字段名 变量名 必填 类型 示例值 描述
返回状态码 return_code String(16) FAIL FAIL
返回信息 return_msg String(128) 签名失败

返回信息,如非空,为错误原因

如:签名失败、参数格式错误等。

return_code为SUCCESS时,进一步返回以下字段指明业务失败的原因

字段名 变量名 必填 类型 示例值 描述

业务结果

result_code

string(16)

FAIL

FAIL
此字段是业务标识,表示业务是否成功。目前只在失败时返回这个字段,所以只会出现FAIL值

错误代码

err_code

String(16)

SYSTEMERROR

见错误码列表

错误代码描述

err_code_des

String(128)

签名失败

错误信息描述


举例如下:

<xml>
<return_code><![CDATA[FAIL]]></return_code>
<return_msg><![CDATA[商户证书错误]]></return_msg>
</xml>

成功时,数据以文本表格的方式返回

第一行返回当前查询到的数据最后一条的offset

从第二行开始,每一行表示一笔交易单的评论信息,各参数以逗号隔开, 参数前增加`符号,为标准键盘1左边键的字符。参数内容依次为:评论的时间,支付订单号,评论星级,评论内容


举例如下:

100
`2017-07-01 10:00:05,` 1001690740201411100005734289,`5,`赞,水果很新鲜
`2017-07-01 11:00:05,` 1001690740201411100005734278,`5,`不错,支付渠道很方便
`2017-07-01 11:30:05,` 1001690740201411100005734250,`4,`东西还算符合预期

错误码

错误码 描述 解决方案

SYSTEMERROR

微信支付内部错误

请稍后重试

NO_COMMENT

对应的时间段没有用户的评论数据

请查询其他时间段的评论数据

TIME_EXPIRE

拉取的时间超过3个月

请拉取90天内的数据

PARAM_ERROR

参数错误

请对照文档的请求参数说明检查参数