投放卡券

来自企业号开发者接口文档
跳转至: 导航搜索

发送卡券消息

  • 请求说明

Https请求方式: POST

https://qyapi.weixin.qq.com/cgi-bin/message/send?access_token=ACCESS_TOKEN

该接口可以对用户发送微信卡券消息

请求JSON数据包示例:

{
  "touser": "UserID1|UserID2|UserID3",
  "toparty": " PartyID1 | PartyID2 ",
  "totag": " TagID1 | TagID2 ",
  "msgtype": "card",
  "agentid": 1,
  "card": {
      "card_id": "pFS7Fjg8kV1IdDz01r4SQwMkuCKc""
   }
 }
  • 参数说明
参数 必须 说明
touser 成员ID列表(消息接收者,多个接收者用‘|’分隔,最多支持1000个)。特殊情况:指定为@all,则向关注该企业应用的全部成员发送
toparty 部门ID列表,多个接收者用‘|’分隔,最多支持100个。当touser为@all时忽略本参数
totag 标签ID列表,多个接收者用‘|’分隔。当touser为@all时忽略本参数
msgtype 消息类型,此时固定为:card (只支持消息型应用)
agentid 企业应用的id,整型。可在应用的设置页面查看
card_id 卡券ID
  • 权限说明

管理组需具备该卡券的投放权限,第三方套件管理组默认具备创建的卡券的投放权限。

  • 返回说明

返回JSON数据包示例:

{
 "errcode":0,
 "errmsg":"ok",
}

获取卡券图文消息内容

  • 请求说明

Https请求方式: POST

https://qyapi.weixin.qq.com/cgi-bin/card/mpnews/gethtml?access_token=ACCESS_TOKEN

支持开发者调用该接口获取卡券嵌入图文消息的标准格式代码,将返回代内容填入到图文消息中content字段,即可将卡券嵌入图文消息发送。目前只支持嵌入保密图文消息。

请求JSON数据包示例:

{ 
 "agentid":0,
 "card_id": "pFS7Fjg8kV1IdDz01r4SQwMkuCKc"
}
  • 参数说明
参数 必须 说明
access_token 调用接口凭证
agentid 应用ID
card_id 卡券ID
  • 权限说明

需具备该卡券的投放权限,第三方套件管理组默认具备创建的卡券的投放权限。

  • 返回说明

返回JSON数据包示例:

{
  "errcode":0,
  "errmsg":"ok",
  "content":"<iframeclass=\"res_iframecard_iframejs_editor_card\"data-src=\"http: \/\/mp.weixin.qq.com\/bizmall\/appmsgcard?  action=show&biz=MjM5OTAwODk4MA%3D%3D&cardid=p1Pj9jnXTLf2nF7lccYScFUYqJ0&wechat_card_js=1#wechat_redirect\">"
 }

创建卡券二维码

  • 请求说明

Https请求方式: POST

https://qyapi.weixin.qq.com/cgi-bin/card/qrcode/create?access_token=ACCESS_TOKEN

开发者可调用该接口生成一张卡券二维码供用户扫码后添加卡券到卡包。

请求JSON数据包示例:

 {
   "action_name": "QR_CARD", 
   "expire_seconds": 1800,
   "action_info": {
   "card": {
       "card_id": "pFS7Fjg8kV1IdDz01r4SQwMkuCKc", 
       "openid": "oFS7Fjl0WsZ9AMZqrI80nbIq8xrA",
        "is_unique_code": false ,
        "outer_id" : 1
        }
     }
  }
  • 参数说明
参数 必须 说明
access_token 调用接口凭证
card_id 卡券ID
openid 指定领取者的openid,只有该用户能领取。bind_openid字段为true的卡券必须填写,非指定openid不必填写。
expire_seconds 指定二维码的有效时间,范围是60 ~ 1800秒。不填默认为永久有效。
is_unique_code 指定下发二维码,生成的二维码随机分配一个code,领取后不可再次扫描。填写true或false。默认false。
outer_id 领取场景值,用于领取渠道的数据统计,默认值为0,字段类型为整型,用户领取卡券后触发的事件推送中会带上此自定义场景值。
  • 权限说明

卡券管理员,即有创建卡券权限的管理组以及有授权套件的第三方套件管理组。

  • 返回说明

返回JSON数据包示例:

{
   "errcode": 0,
   "errmsg": "ok",
   "ticket":      "gQHB8DoAAAAAAAAAASxodHRwOi8vd2VpeGluLnFxLmNvbS9xL0JIV3lhX3psZmlvSDZmWGVMMTZvAAIEsNnKVQMEIAMAAA==",//获取ticket后需调用换取二维码接口获取二维码图片,详情见字段说明。
   "expire_seconds": 1800,
   "url": "http://weixin.qq.com/q/BHWya_zlfioH6fXeL16o ",
   "show_qrcode_url":"https://mp.weixin.qq.com/cgi-bin/showqrcode?ticket=gQH98DoAAAAAAAAAASxodHRwOi8vd2VpeGluLnFxLmNvbS9xL0czVzRlSWpsamlyM2plWTNKVktvAAIE6SfgVQMEgDPhAQ%3D%3D"
 }
  • 参数说明
参数 说明
errcode 错误码
errmsg 错误信息
ticket 可以通过https://mp.weixin.qq.com/cgi-bin/showqrcode?ticket=TICKET获取二维码
url 二维码图片解析后的地址,开发者可根据该地址自行生成需要的二维码图片
show_qrcode_url 二维码显示地址,点击后跳转二维码页面