最新更新時(shí)間:2020.10.10 版本說(shuō)明
商戶可以通過(guò)該接口拉取用戶在微信支付交易記錄中針對(duì)你的支付記錄進(jìn)行的評(píng)價(jià)內(nèi)容。
商戶可結(jié)合商戶系統(tǒng)邏輯對(duì)該內(nèi)容數(shù)據(jù)進(jìn)行存儲(chǔ)、分析、展示、客服回訪以及其他使用。如商戶業(yè)務(wù)對(duì)評(píng)價(jià)內(nèi)容有依賴(lài),可主動(dòng)引導(dǎo)用戶進(jìn)入微信支付交易記錄進(jìn)行評(píng)價(jià)。
1. 該內(nèi)容所有權(quán)為提供內(nèi)容的微信用戶,商戶在使用內(nèi)容的過(guò)程中應(yīng)遵從用戶意愿
2. 一次最多拉取200條評(píng)價(jià)數(shù)據(jù),可根據(jù)時(shí)間區(qū)間分批次拉取
3. 接口只能拉取最近三個(gè)月以?xún)?nèi)的評(píng)價(jià)數(shù)據(jù)
適用對(duì)象:直連商戶 服務(wù)商
請(qǐng)求URL: https://api.mch.weixin.qq.com/billcommentsp/batchquerycomment
請(qǐng)求方式: POST
數(shù)據(jù)格式: XML
是否需要證書(shū): 是
參數(shù)名 | 變量 | 類(lèi)型 | 必填 | 描述 |
---|---|---|---|---|
應(yīng)用ID | appid | string[1,32] | 是 | 微信分配的應(yīng)用ID 示例值:wx8888888888888888 |
商戶號(hào) | mch_id | string[1,32] | 是 | 微信支付分配的商戶號(hào) 示例值:1900000109 |
子商戶應(yīng)用ID | sub_appid | string[1,32] | 否 | 微信分配的子商戶應(yīng)用ID,如需在支付完成后獲取sub_openid則此參數(shù)必傳。 注意:僅適用于服務(wù)商模式 示例值:wx8888888888888888 |
子商戶號(hào) | sub_mch_id | string[1,32] | 是 | 微信支付分配的子商戶號(hào) 注意:僅適用于服務(wù)商模式 示例值:1900000109 |
隨機(jī)字符串 | nonce_str | string[1,32] | 是 | 隨機(jī)字符串,不長(zhǎng)于32位。推薦隨機(jī)數(shù)生成算法 示例值:5K8264ILTKCH16CQ2502SI8ZNMTM67VS |
簽名 | sign | string[1,64] | 是 | 簽名,詳見(jiàn)簽名生成算法 示例值:C380BEC2BFD727A4B6845133519F3AD6 |
簽名類(lèi)型 | sign_type | string[1,32] | 否 | 簽名類(lèi)型,目前僅支持HMAC-SHA256,默認(rèn)就是HMAC-SHA256 示例值:HMAC-SHA256 |
開(kāi)始時(shí)間 | begin_time | string[1,19] | 是 | 按用戶評(píng)論時(shí)間批量拉取的起始時(shí)間,格式為yyyyMMddHHmmss 示例值:20170724000000 |
結(jié)束時(shí)間 | end_time | string[1,19] | 是 | 按用戶評(píng)論時(shí)間批量拉取的結(jié)束時(shí)間,格式為yyyyMMddHHmmss 示例值:20170724500000 |
位移 | offset | uint64 | 是 | 指定從某條記錄的下一條開(kāi)始返回記錄。接口調(diào)用成功時(shí),會(huì)返回本次查詢(xún)最后一條數(shù)據(jù)的offset。商戶需要翻頁(yè)時(shí),應(yīng)該把本次調(diào)用返回的offset 作為下次調(diào)用的入?yún)ⅰW⒁鈕ffset是評(píng)論數(shù)據(jù)在微信支付后臺(tái)保存的索引,未必是連續(xù)的 示例值:0 |
條數(shù) | limit | uint32 | 否 | 一次拉取的條數(shù), 最大值是200,默認(rèn)是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>
失敗時(shí),返回以下字段
參數(shù)名 | 變量 | 類(lèi)型 | 必填 | 描述 |
---|---|---|---|---|
返回狀態(tài)碼 | return_code | string[1,16] | 是 | SUCCESS/FAIL 此字段是通信標(biāo)識(shí),非交易標(biāo)識(shí),交易是否成功需要查看result_code來(lái)判斷 示例值:SUCCESS |
返回信息 | return_msg | string[1,128] | 否 | 返回信息,如非空,為錯(cuò)誤原因 簽名失敗 參數(shù)格式校驗(yàn)錯(cuò)誤 示例值:簽名失敗 |
返回狀態(tài)碼(return_code)為SUCCESS的時(shí)候,包含以下字段,進(jìn)一步返回以下字段指明業(yè)務(wù)失敗的原因
參數(shù)名 | 變量 | 類(lèi)型 | 必填 | 描述 |
---|---|---|---|---|
業(yè)務(wù)結(jié)果 | result_code | string[1,16] | 是 | FAIL 此字段是業(yè)務(wù)標(biāo)識(shí),表示業(yè)務(wù)是否成功。目前只在失敗時(shí)返回這個(gè)字段,所以只會(huì)出現(xiàn)FAIL值 示例值:FAIL |
錯(cuò)誤代碼 | err_code | string[1,16] | 是 | 見(jiàn)錯(cuò)誤碼列表 示例值:SYSTEMERROR |
錯(cuò)誤代碼描述 | err_code_des | string[1,128] | 否 | 錯(cuò)誤信息描述 示例值:簽名失敗 |
<xml>
<return_code><![CDATA[FAIL]]></return_code>
<return_msg><![CDATA[商戶證書(shū)錯(cuò)誤]]></return_msg>
</xml>
成功時(shí),數(shù)據(jù)以文本表格的方式返回
第一行返回當(dāng)前查詢(xún)到的數(shù)據(jù)最后一條的offset
從第二行開(kāi)始,每一行表示一筆交易單的評(píng)論信息,各參數(shù)以逗號(hào)隔開(kāi), 參數(shù)前增加`符號(hào),為標(biāo)準(zhǔn)鍵盤(pán)1左邊鍵的字符。參數(shù)內(nèi)容依次為:評(píng)論的時(shí)間,支付訂單號(hào),評(píng)論星級(jí),評(píng)論內(nèi)容
舉例如下:
100
`2017-07-01 10:00:05,` 1001690740201411100005734289,`5,`贊,水果很新鮮
`2017-07-01 11:00:05,` 1001690740201411100005734278,`5,`不錯(cuò),支付渠道很方便
`2017-07-01 11:30:05,` 1001690740201411100005734250,`4,`東西還算符合預(yù)期
錯(cuò)誤碼 | 描述 | 解決方案 |
---|---|---|
SYSTEMERROR | 微信支付內(nèi)部錯(cuò)誤 | 請(qǐng)稍后重試 |
NO_COMMENT | 對(duì)應(yīng)的時(shí)間段沒(méi)有用戶的評(píng)論數(shù)據(jù) | 請(qǐng)查詢(xún)其他時(shí)間段的評(píng)論數(shù)據(jù) |
TIME_EXPIRE | 拉取的時(shí)間超過(guò)3個(gè)月 | 請(qǐng)拉取90天內(nèi)的數(shù)據(jù) |
PARAM_ERROR | 參數(shù)錯(cuò)誤 | 請(qǐng)對(duì)照文檔的請(qǐng)求參數(shù)說(shuō)明檢查參數(shù) |