帮助中心

4001-微信模板消息发送(微信模板)

2019-04-23

接口编号 4001

接口说明

向用户发送微信模板消息。

注:支持批量发送,最大数据行数限制100。

请求说明

  • HTTP请求方式:POST

  • 返回数据格式:JSON

  • 请求路径:api/WXMessage/SendByWxTemp

请求参数

字段类型为空长度描述
WxTemplateIdstring1~64微信模板编号(在微信后台查找)
MsgTypestring
自定义参数,表示消息类型 (自己定义一个类型,便于后期统计)  BUED-积分过期提醒,VGDS-等级降级提醒,VGUS-等级晋级提醒,BUEC-积分即将过期提醒,BUGV-积分变动提醒
MessagesList<WXMessageItem>
消息内容

数据结构(WXMessageItem)

字段类型为空长度描述
OldCodestring1~16Vip线下code号,说明:必须是关注微信公众号的会员,才能触达模板消息(WxOpenId,OldCode不能同时为空)
TmpValueList<WXKeyValue>
消息对应关键字,和内容 见例子
Urlstring1-200跳转地址
WxOpenIdstring
WxOpenId,OldCode不能同时为空
Idlong
系统编号
WxNostring
微信号码

数据结构(WXKeyValue)

字段类型为空长度描述
Namestring1~16消息替换块名称
Valuestring
消息替换块值

请求参数示例代码(json对象)

{
   "WxTemplateId": "-ddWCPH-bQPThbYIoGqYD_ff5D0SNVRc9WxVxz9bYxM",
   "MsgType": "BUED",
   "Messages": [
       {
           "WxOpenId": "oV5mxvz2KRy_Ey8DEIulG0HQpyeU",
           "Url": "http://www.baidu.com",
           "TmpValue": [
               {
                   "Name": "first",
                   "Value": "头部"
               },
               {
                   "Name": "keyword1",
                   "Value": "过期积分"
               },
               {
                   "Name": "keyword2",
                   "Value": "过期时间"
               },
               {
                   "Name": "remark",
                   "Value": "尾部"
               }
           ]
       }
   ]
}
{
   "WxTemplateId": "ylBLqakJuYT8uT2Qb0QYGX6V9hhYiQaaWUttXWFOesU",
   "MsgType": "VGDS",
   "Messages": [
       {
           "WxOpenId": "oV5mxvz2KRy_Ey8DEIulG0HQpyeU",
           "Url": "http://www.baidu.com",
           "TmpValue": [
               {
                   "Name": "first",
                   "Value": "头部"
               },
               {
                   "Name": "account",
                   "Value": "账户"
               },
               {
                   "Name": "time",
                   "Value": "时间"
               },
               {
                   "Name": "type",
                   "Value": "类型-降级"
               },
               {
                   "Name": "remark",
                   "Value": "尾部"
               }
           ]
       }
   ]
}
{
   "WxTemplateId": "ylBLqakJuYT8uT2Qb0QYGX6V9hhYiQaaWUttXWFOesU",
   "MsgType": "VGUS",
   "Messages": [
       {
           "WxOpenId": "oV5mxvz2KRy_Ey8DEIulG0HQpyeU",
           "Url": "http://www.baidu.com",
           "TmpValue": [
               {
                   "Name": "first",
                   "Value": "头部"
               },
               {
                   "Name": "account",
                   "Value": "账户"
               },
               {
                   "Name": "time",
                   "Value": "时间"
               },
               {
                   "Name": "type",
                   "Value": "类型-晋级"
               },
               {
                   "Name": "remark",
                   "Value": "尾部"
               }
           ]
       }
   ]
}
{
   "WxTemplateId": "ILUDDv0K9Cmpm9XfoThnFx1D7erDnlX2Fm_QdPI4V44",
   "MsgType": "BUEC",
   "Messages": [
       {
           "WxOpenId": "oV5mxvz2KRy_Ey8DEIulG0HQpyeU",
           "Url": "http://www.baidu.com",
           "TmpValue": [
               {
                   "Name": "first",
                   "Value": "头部"
               },
               {
                   "Name": "keyword1",
                   "Value": "会员卡号"
               },
               {
                   "Name": "keyword2",
                   "Value": "即将过期积分"
               },
               {
                   "Name": "keyword3",
                   "Value": "当前有效积分"
               },
               {
                   "Name": "remark",
                   "Value": "尾部"
               }
           ]
       }
   ]
}
{
   "WxTemplateId": "PP0D96N2P43y10FbLj9tHSkIlW_M0692M-cDtN-A554",
   "MsgType": "BUGV",
   "Messages": [
       {
           "WxOpenId": "oV5mxvz2KRy_Ey8DEIulG0HQpyeU",
           "Url": "http://www.baidu.com",
           "TmpValue": [
               {
                   "Name": "first",
                   "Value": "头部"
               },
               {
                   "Name": "keyword1",
                   "Value": "用户名"
               },
               {
                   "Name": "keyword2",
                   "Value": "时间"
               },
               {
                   "Name": "keyword3",
                   "Value": "积分变动"
               },
               {
                   "Name": "keyword4",
                   "Value": "积分余额"
               },
               {
                   "Name": "keyword5",
                   "Value": "变动原因"
               },
               {
                   "Name": "remark",
                   "Value": "尾部"
               }
           ]
       }
   ]
}

系统级返回结果示例(json)

{
   "Status": true,
   "StatusCode": 200,
   "Msg": "成功",
   "Timestamp": "20150622093101",
   "Sign": "6ECC9BF07C69E80F6D8552FF7B2E7A8FCA2CC80E",
   "Result": 见业务返回结果示例,
}

业务返回结果示例(json对象):

内容1,代表所影响行数


2603