微信服务通知推送接口

1.功能说明

此接口可推送微信服务通知到指定微信用户

发送前请检查以下配置

​ 微信端:

发送的微信消息模板(templateId)在云城小程序的微信公众平台 真实存在

该微信用户打开并登陆过云城微信小程序

该微信用户在云城微信小程序打开过该子服务并在微信消息授权弹框中同意接收服务通知

​ 云城端:

该微信消息模板在 云城后台 -> 系统管理 -> 微信模板管理 真实存在

该微信消息模板在 云城后台 -> 开放平台管理 -> 服务管理 -> 服务管理 中绑定了该子服务

2.接口说明

2.1.接口定义

path 请求方式 接口描述 调用权限
/messageservice/wxMessage/sendSubscribeMessage POST 推送服务微信服务通知给指定云城小程序用户 子服务

2.2.请求头说明

名称 是否必须 类型 默认值 备注
Authorization true string N/A 添加子服务的access_token,如:Bearer a3cc6613-ebe7-4ab8-9e25-48ed2c9d6c6a
Content-Type true string application/json N/A

2.3.请求参数说明

名称 是否必须 类型 备注
appId true string 云城小程序 appId
templateId true string 微信公众平台消息模板ID
page false string 跳转至小程序页面地址 例:/index
uuid uuid、mobile 必填一项 string 接受方 uuid
mobile 同上,uuid优先级高 string 接收方 手机号
dataList false string 模板中对应的数据值 详见请求示例

2.4.返回参数说明

名称 是否必须 类型 备注
smsg true string 请求结果信息
ret true string 请求是否正常返回状态码:"-1"请求异常 ,"0":请求成功
errorCode true string 请求成功返回null,失败返回code码
msg true string 成功返回"ok",失败返回错误信息
data true boolean 请求成功返回 true ,失败返回 false

3.请求示例

// 请求参数
{
    "appId":"wxcbc9edcd31dd753a" ,
    "uuid" : "olSrN4gVY2vzte71mmGrfs1Tivnc",
    "templateId":"Qhqcg-FCM8aJdwZY4jdo-wbATVpajIA6NBW-U3GRI4w",
    "page":"/index",
    "dataList":[
        {
            "key":"thing1",
            "value":"测试服务消息01"
        },
        {
            "key":"time2",
            "value":"2020-06-01 14:15:00"
        },
        {
            "key":"thing3",
            "value":"2020-06-01 14:15:00"
        },
        {
            "key":"number4",
            "value":"69"
        }
    ]
}

3.1.成功请求返回

{
    "smsg":null,
    "ret":"0",
    "errorCode":null,
    "msg":"发送成功",
    "data":true,
    "time":1591088104759
}

3.2.失败请求返回

{
    "smsg":"发送失败",
    "ret":"-1",
    "errorCode":"100001",
    "msg":"用户拒绝接受消息,如果用户之前曾经订阅过,则表示用户取消了订阅关系",
    "data":false,
    "time":1591099408261
}

results matching ""

    No results matching ""