WxMpCardService (WxJava - MP Java SDK 4.6.0 API)

所有已知实现类:

WxMpCardServiceImpl
```
public interface WxMpCardService
```
卡券相关接口.

作者:

YuJian(mgcnrx11 @ hotmail.com) on 01/11/2016, yuanqixun 2018-08-29

方法概要

所有方法实例方法抽象方法
限定符和类型	方法和说明
`String`	`addTestWhiteList(String openid)` 添加测试白名单.
`WxMpCardCodeCheckcodeResult`	`cardCodeCheckcode(String cardId, List<String> codeList)` 核查code接口
`WxMpCardCodeDepositResult`	`cardCodeDeposit(String cardId, List<String> codeList)` 导入自定义code(仅对自定义code商户)
`WxMpCardCodeDepositCountResult`	`cardCodeDepositCount(String cardId)` 查询导入code数目接口
`void`	`cardCodeUpdate(String cardId, String oldCode, String newCode)` 更改Code接口 https://developers.weixin.qq.com/doc/offiaccount/Cards_and_Offer/Managing_Coupons_Vouchers_and_Cards.html#6
`void`	`cardModifyStock(String cardId, Integer changeValue)` 修改库存接口 https://developers.weixin.qq.com/doc/offiaccount/Cards_and_Offer/Managing_Coupons_Vouchers_and_Cards.html#5
`WxMpCardMpnewsGethtmlResult`	`cardMpnewsGethtml(String cardId)` 图文消息群发卡券获取内嵌html
`void`	`cardPaycellSet(String cardId, Boolean isOpen)` 设置买单接口 https://developers.weixin.qq.com/doc/offiaccount/Cards_and_Offer/Create_a_Coupon_Voucher_or_Card.html#12
`void`	`cardSelfConsumeCellSet(String cardId, Boolean isOpen, Boolean needVerifyCod, Boolean needRemarkAmount)` 设置自助核销 https://developers.weixin.qq.com/doc/offiaccount/Cards_and_Offer/Create_a_Coupon_Voucher_or_Card.html#14
`String`	`consumeCardCode(String code)` 卡券Code核销。
`String`	`consumeCardCode(String code, String cardId)` 卡券Code核销。
`WxMpCardCreateResult`	`createCard(WxMpCardCreateRequest cardCreateMessage)` 创建卡券.
`WxCardApiSignature`	`createCardApiSignature(String... optionalSignParam)` 创建调用卡券api时所需要的签名.
`WxMpCardLandingPageCreateResult`	`createLandingPage(WxMpCardLandingPageCreateRequest createRequest)` 创建卡券货架.
`WxMpCardQrcodeCreateResult`	`createQrcodeCard(String cardId, String outerStr)` 创建卡券二维码.
`WxMpCardQrcodeCreateResult`	`createQrcodeCard(String cardId, String outerStr, int expiresIn)` 创建卡券二维码.
`WxMpCardQrcodeCreateResult`	`createQrcodeCard(String cardId, String outerStr, int expiresIn, String openid, String code, boolean isUniqueCode)` 创建卡券二维码.
`String`	`decryptCardCode(String encryptCode)` 卡券Code解码.
`WxMpCardDeleteResult`	`deleteCard(String cardId)` 删除卡券接口.
`String`	`getCardApiTicket()` 获得卡券api_ticket，不强制刷新卡券api_ticket.
`String`	`getCardApiTicket(boolean forceRefresh)` 获得卡券api_ticket.
`String`	`getCardDetail(String cardId)` 查看卡券详情接口.
`WxUserCardListResult`	`getUserCardList(String openId, String cardId)` 获取用户已领取卡券接口 https://developers.weixin.qq.com/doc/offiaccount/Cards_and_Offer/Managing_Coupons_Vouchers_and_Cards.html#1
`WxMpService`	`getWxMpService()` 得到WxMpService.
`void`	`markCardCode(String code, String cardId, String openId, boolean isMark)` 卡券Mark接口.
`WxMpCardResult`	`queryCardCode(String cardId, String code, boolean checkConsume)` 卡券Code查询.
`String`	`unavailableCardCode(String cardId, String code, String reason)` 将用户的卡券设置为失效状态.

- 方法详细资料
  - getWxMpService
```
WxMpService getWxMpService()
```
    得到WxMpService.
    
    返回:
    
    WxMpService wx mp service
  - getCardApiTicket
```
String getCardApiTicket()
                 throws WxErrorException
```
    获得卡券api_ticket，不强制刷新卡券api_ticket.
    
    返回:
    
    卡券api_ticket card api ticket
    
    抛出:
    
    WxErrorException - 异常
    
    另请参阅:
    
    #getCardApiTicket(boolean)#getCardApiTicket(boolean)
  - getCardApiTicket
```
String getCardApiTicket(boolean forceRefresh)
                 throws WxErrorException
```
```
 获得卡券api_ticket.
 获得时会检查卡券apiToken是否过期，如果过期了，那么就刷新一下，否则就什么都不干

 详情请见：http://mp.weixin.qq.com/wiki/7/aaa137b55fb2e0456bf8dd9148dd613f.html#.E9.99.84.E5.BD.954-.E5.8D.A1.E5.88.B8.E6.89.A9.E5.B1.95.E5.AD.97.E6.AE.B5.E5.8F.8A.E7.AD.BE.E5.90.8D.E7.94.9F.E6.88.90.E7.AE.97.E6.B3.95
 
```
    参数:
    
    forceRefresh - 强制刷新
    
    返回:
    
    卡券api_ticket card api ticket
    
    抛出:
    
    WxErrorException - 异常
  - createCardApiSignature
```
WxCardApiSignature createCardApiSignature(String... optionalSignParam)
                                   throws WxErrorException
```
```
 创建调用卡券api时所需要的签名.

 详情请见：http://mp.weixin.qq.com/wiki/7/aaa137b55fb2e0456bf8dd9148dd613f.html#.E9.99.84.E5.BD
 .954-.E5.8D.A1.E5.88.B8.E6.89.A9.E5.B1.95.E5.AD.97.E6.AE.B5.E5.8F.8A.E7.AD.BE.E5.90.8D.E7.94
 .9F.E6.88.90.E7.AE.97.E6.B3.95
 
```
    参数:
    
    optionalSignParam - 参与签名的参数数组。可以为下列字段：app_id, card_id, card_type, code, openid, location_id
    注意：当做wx.chooseCard调用时，必须传入app_id参与签名，否则会造成签名失败导致拉取卡券列表为空
    
    返回:
    
    卡券Api签名对象 wx card api signature
    
    抛出:
    
    WxErrorException - 异常
  - decryptCardCode
```
String decryptCardCode(String encryptCode)
                throws WxErrorException
```
    卡券Code解码.
    
    参数:
    
    encryptCode - 加密Code，通过JSSDK的chooseCard接口获得
    
    返回:
    
    解密后的Code string
    
    抛出:
    
    WxErrorException - 异常
  - queryCardCode
```
WxMpCardResult queryCardCode(String cardId,
                             String code,
                             boolean checkConsume)
                      throws WxErrorException
```
    卡券Code查询. 文档地址： https://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1451025272&anchor=1
    
    参数:
    
    cardId - 卡券ID代表一类卡券
    
    code - 单张卡券的唯一标准
    
    checkConsume - 是否校验code核销状态，填入true和false时的code异常状态返回数据不同
    
    返回:
    
    WxMpCardResult对象 wx mp card result
    
    抛出:
    
    WxErrorException - 异常
  - consumeCardCode
```
String consumeCardCode(String code)
                throws WxErrorException
```
    卡券Code核销。核销失败会抛出异常
    
    参数:
    
    code - 单张卡券的唯一标准
    
    返回:
    
    调用返回的JSON字符串。可用 com.google.gson.JsonParser#parse 等方法直接取JSON串中的errcode等信息。
    
    抛出:
    
    WxErrorException - 异常
  - consumeCardCode
```
String consumeCardCode(String code,
                       String cardId)
                throws WxErrorException
```
    卡券Code核销。核销失败会抛出异常.
    
    参数:
    
    code - 单张卡券的唯一标准
    
    cardId - 当自定义Code卡券时需要传入card_id
    
    返回:
    
    调用返回的JSON字符串。可用 com.google.gson.JsonParser#parse 等方法直接取JSON串中的errcode等信息。
    
    抛出:
    
    WxErrorException - 异常
  - markCardCode
```
void markCardCode(String code,
                  String cardId,
                  String openId,
                  boolean isMark)
           throws WxErrorException
```
    卡券Mark接口. 开发者在帮助消费者核销卡券之前，必须帮助先将此code（卡券串码）与一个openid绑定（即mark住），才能进一步调用核销接口，否则报错。
    
    参数:
    
    code - 卡券的code码
    
    cardId - 卡券的ID
    
    openId - 用券用户的openid
    
    isMark - 是否要mark（占用）这个code，填写true或者false，表示占用或解除占用
    
    抛出:
    
    WxErrorException - 异常
  - getCardDetail
```
String getCardDetail(String cardId)
              throws WxErrorException
```
    查看卡券详情接口. 详见 https://mp.weixin.qq.com/wiki/14/8dd77aeaee85f922db5f8aa6386d385e.html#.E6.9F.A5.E7.9C.8B.E5.8D.A1.E5.88.B8.E8.AF.A6.E6.83.85
    
    参数:
    
    cardId - 卡券的ID
    
    返回:
    
    返回的卡券详情JSON字符串
    [注] 由于返回的JSON格式过于复杂，难以定义其对应格式的Bean并且难以维护，因此只返回String格式的JSON串。
    可由 com.google.gson.JsonParser#parse 等方法直接取JSON串中的某个字段。
    
    抛出:
    
    WxErrorException - 异常
  - addTestWhiteList
```
String addTestWhiteList(String openid)
                 throws WxErrorException
```
    添加测试白名单.
    
    参数:
    
    openid - 用户的openid
    
    返回:
    
    string string
    
    抛出:
    
    WxErrorException - 异常
  - createCard
```
WxMpCardCreateResult createCard(WxMpCardCreateRequest cardCreateMessage)
                         throws WxErrorException
```
    创建卡券.
    
    参数:
    
    cardCreateMessage - 请求
    
    返回:
    
    result wx mp card create result
    
    抛出:
    
    WxErrorException - 异常
  - createQrcodeCard
```
WxMpCardQrcodeCreateResult createQrcodeCard(String cardId,
                                            String outerStr)
                                     throws WxErrorException
```
    创建卡券二维码.
    
    参数:
    
    cardId - 卡券编号
    
    outerStr - 二维码标识
    
    返回:
    
    WxMpCardQrcodeCreateResult wx mp card qrcode create result
    
    抛出:
    
    WxErrorException - 异常
  - createQrcodeCard
```
WxMpCardQrcodeCreateResult createQrcodeCard(String cardId,
                                            String outerStr,
                                            int expiresIn)
                                     throws WxErrorException
```
    创建卡券二维码.
    
    参数:
    
    cardId - 卡券编号
    
    outerStr - 二维码标识
    
    expiresIn - 指定二维码的有效时间，范围是60 ~ 1800秒。不填默认为365天有效
    
    返回:
    
    WxMpCardQrcodeCreateResult wx mp card qrcode create result
    
    抛出:
    
    WxErrorException - 异常
  - createQrcodeCard
```
WxMpCardQrcodeCreateResult createQrcodeCard(String cardId,
                                            String outerStr,
                                            int expiresIn,
                                            String openid,
                                            String code,
                                            boolean isUniqueCode)
                                     throws WxErrorException
```
    创建卡券二维码.
    
    参数:
    
    cardId - 卡券编号
    
    outerStr - 用户首次领卡时，会通过领取事件推送给商户；对于会员卡的二维码，用户每次扫码打开会员卡后点击任何url，会将该值拼入url中，方便开发者定位扫码来源
    
    expiresIn - 指定二维码的有效时间，范围是60 ~ 1800秒。不填默认为365天有效
    
    openid - 指定领取者的openid，只有该用户能领取。bind_openid字段为true的卡券必须填写，非指定openid不必填写。
    
    code - 卡券Code码,use_custom_code字段为true的卡券必须填写，非自定义code和导入code模式的卡券不必填写。
    
    isUniqueCode - 指定下发二维码，生成的二维码随机分配一个code，领取后不可再次扫描。填写true或false。默认false，注意填写该字段时，卡券须通过审核且库存不为0。
    
    返回:
    
    WxMpCardQrcodeCreateResult wx mp card qrcode create result
    
    抛出:
    
    WxErrorException - 异常
  - createLandingPage
```
WxMpCardLandingPageCreateResult createLandingPage(WxMpCardLandingPageCreateRequest createRequest)
                                           throws WxErrorException
```
    创建卡券货架.
    
    参数:
    
    createRequest - 货架创建参数
    
    返回:
    
    WxMpCardLandingPageCreateResult wx mp card landing page create result
    
    抛出:
    
    WxErrorException - 异常
  - unavailableCardCode
```
String unavailableCardCode(String cardId,
                           String code,
                           String reason)
                    throws WxErrorException
```
    将用户的卡券设置为失效状态. 详见:https://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1451025272&anchor=9
    
    参数:
    
    cardId - 卡券编号
    
    code - 用户会员卡号
    
    reason - 设置为失效的原因
    
    返回:
    
    result string
    
    抛出:
    
    WxErrorException - 异常
  - deleteCard
```
WxMpCardDeleteResult deleteCard(String cardId)
                         throws WxErrorException
```
    删除卡券接口.
    
    参数:
    
    cardId - 卡券id
    
    返回:
    
    删除结果 wx mp card delete result
    
    抛出:
    
    WxErrorException - 异常
  - cardCodeDeposit
```
WxMpCardCodeDepositResult cardCodeDeposit(String cardId,
                                          List<String> codeList)
                                   throws WxErrorException
```
    导入自定义code(仅对自定义code商户)
    
    参数:
    
    cardId - 卡券id
    
    codeList - 需导入微信卡券后台的自定义code，上限为100个。
    
    返回:
    
    the wx mp card code deposit result
    
    抛出:
    
    WxErrorException - the wx error exception
  - cardCodeDepositCount
```
WxMpCardCodeDepositCountResult cardCodeDepositCount(String cardId)
                                             throws WxErrorException
```
    查询导入code数目接口
    
    参数:
    
    cardId - 卡券id
    
    返回:
    
    the wx mp card code deposit count result
    
    抛出:
    
    WxErrorException - the wx error exception
  - cardCodeCheckcode
```
WxMpCardCodeCheckcodeResult cardCodeCheckcode(String cardId,
                                              List<String> codeList)
                                       throws WxErrorException
```
    核查code接口
    
    参数:
    
    cardId - 卡券id
    
    codeList - 已经微信卡券后台的自定义code，上限为100个
    
    返回:
    
    the wx mp card code checkcode result
    
    抛出:
    
    WxErrorException - the wx error exception
  - cardMpnewsGethtml
```
WxMpCardMpnewsGethtmlResult cardMpnewsGethtml(String cardId)
                                       throws WxErrorException
```
    图文消息群发卡券获取内嵌html
    
    参数:
    
    cardId - 卡券id
    
    返回:
    
    the wx mp card mpnews gethtml result
    
    抛出:
    
    WxErrorException - the wx error exception
  - cardModifyStock
```
void cardModifyStock(String cardId,
                     Integer changeValue)
              throws WxErrorException
```
    修改库存接口 https://developers.weixin.qq.com/doc/offiaccount/Cards_and_Offer/Managing_Coupons_Vouchers_and_Cards.html#5
    
    参数:
    
    cardId - 卡券ID
    
    changeValue - 库存变更值，负值为减少库存
    
    抛出:
    
    WxErrorException - the wx error exception
  - cardCodeUpdate
```
void cardCodeUpdate(String cardId,
                    String oldCode,
                    String newCode)
             throws WxErrorException
```
    更改Code接口 https://developers.weixin.qq.com/doc/offiaccount/Cards_and_Offer/Managing_Coupons_Vouchers_and_Cards.html#6
    
    参数:
    
    cardId - 卡券ID
    
    oldCode - 需变更的Code码
    
    newCode - 变更后的有效Code码
    
    抛出:
    
    WxErrorException - the wx error exception
  - cardPaycellSet
```
void cardPaycellSet(String cardId,
                    Boolean isOpen)
             throws WxErrorException
```
    设置买单接口 https://developers.weixin.qq.com/doc/offiaccount/Cards_and_Offer/Create_a_Coupon_Voucher_or_Card.html#12
    
    参数:
    
    cardId - 卡券ID
    
    isOpen - 是否开启买单功能，填true/false
    
    抛出:
    
    WxErrorException - the wx error exception
  - cardSelfConsumeCellSet
```
void cardSelfConsumeCellSet(String cardId,
                            Boolean isOpen,
                            Boolean needVerifyCod,
                            Boolean needRemarkAmount)
                     throws WxErrorException
```
    设置自助核销 https://developers.weixin.qq.com/doc/offiaccount/Cards_and_Offer/Create_a_Coupon_Voucher_or_Card.html#14
    
    参数:
    
    cardId - 卡券ID
    
    isOpen - 是否开启自助核销功能
    
    needVerifyCod - 用户核销时是否需要输入验证码，填true/false，默认为false
    
    needRemarkAmount - 用户核销时是否需要备注核销金额，填true/false，默认为false
    
    抛出:
    
    WxErrorException - the wx error exception
  - getUserCardList
```
WxUserCardListResult getUserCardList(String openId,
                                     String cardId)
                              throws WxErrorException
```
    获取用户已领取卡券接口 https://developers.weixin.qq.com/doc/offiaccount/Cards_and_Offer/Managing_Coupons_Vouchers_and_Cards.html#1
    
    参数:
    
    openId - 需要查询的用户openid
    
    cardId - 卡券ID。不填写时默认查询当前appid下的卡券
    
    返回:
    
    user card list
    
    抛出:
    
    WxErrorException - the wx error exception

接口 WxMpCardService

方法概要

方法详细资料

getWxMpService

getCardApiTicket

getCardApiTicket

createCardApiSignature

decryptCardCode

queryCardCode

consumeCardCode

consumeCardCode

markCardCode

getCardDetail

addTestWhiteList

createCard

createQrcodeCard

createQrcodeCard

createQrcodeCard

createLandingPage

unavailableCardCode

deleteCard

cardCodeDeposit

cardCodeDepositCount

cardCodeCheckcode

cardMpnewsGethtml

cardModifyStock

cardCodeUpdate

cardPaycellSet

cardSelfConsumeCellSet

getUserCardList