消息接口
该接口用于企业应用中需要消息通知的场景。通过本接口,电子流可以将审批信息推送给WeLink端的审批人员。审批人员点击待审批消息即可在手机上完成审批操作。
接口说明
请求方式: POST (HTTPS)
请求地址: https://open.welink.huaweicloud.com/api/messages/v2/send
认证方式: access_token,请参考获取access_token。
原V1接口,支持type=u的认证,仍然可以使用,但不推荐。
请求头部:
Content-Type: application/json
x-wlk-Authorization: access_token
请求参数:
{
"publicAccID": "HX1234567890",
"msgRange": 0,
"toUserList": ["john@welink", "john@1234"],
"msgTitle": "{\"EN\": \"hello world\", \"CN\": \"你好\"}",
"msgContent": "{\"CN\": \"欢迎使用\", \"EN\":\"Welcome\"}",
"urlType": "html",
"urlPath": "h5://demo.com",
"msgOwner": "John",
"createTime": "1487289600000"
}
请求参数说明:
参数 | 参数类型 | 必填 | 说明 |
---|---|---|---|
toUserList | List | 是 | 成员ID列表(消息接收者,多个接收者用','分隔,最多支持1000个)。 |
msgRange | String | 是 | 0:按用户推送,2:全员推送 |
publicAccID | String | 是 | 公众号ID,请联系WeLink企业管理员创建一个企业公众号,并获取该帐号ID。 |
msgTitle | String | 是 | 标题,不超过128个字节,超过会自动截断,如果不需要双语,可直接传string如“出差电子流” ,需要双语则参考请求包体示例,传入{json}string对象。 |
msgContent | String | 是 | 描述,不超过512个字节,超过会自动截断,如果不需要双语,可直接传string如“张三提交了一个去上海的出差申请” ,双语场景同上。 |
urlType | String | 是 | 链接类型定义,如"html",则可跳转到http://url地址 。 |
urlPath | String | 是 | 点击后跳转的链接,如需要跳转到微码,参考推送消息实现免登。 |
msgOwner | String | 是 | 消息所有者,如“差旅管理”。 |
createTime | String | 否 | 消息创建时间,可不传系统将自动生成推送时间。 |
请求示例:
curl -X POST \
'https://open.welink.huaweicloud.com/api/messages/v1/send?=' \
-H 'Content-Type: application/json' \
-H 'x-wlk-Authorization: access_token' \
-d '{"请求参数 json格式"}'
响应格式说明
正常返回结果:
{
"code":"0",
"message":"ok"
}
异常返回结果:
{
"code":"51019", //错误码
"message":"用户未关注或者推送账号不存在", //错误提示
"failedUserId":["zhangsan", "lisi"] //因为userId推送失败,会显示失败人员信息
}
返回参数说明:
参数 | 说明 |
---|---|
code | 数据正常返回“0”,如果发生错误,会返回对应的错误码。 |
message | 返回信息,包括接口请求发生错误时的详细信息。 |
错误码说明:
错误码 | 说明 |
---|---|
51002 | 推送消息异常 |
51003 | 没有传入公众号ID |
51010 | 该公众号在系统中不存在 |
51018 | 单次发送用户数最大1000人 |
51019 | 不能给非粉丝用户推送消息 |
51036 | 用户未登录 |
51042 | 用户列表不能为空 |