# 接入系统发送u聊消息
企业的信息系统通过u聊开放的接口向u聊用户发送的消息,仅限企业自身使用。群消息的类型支持 文本、图片、音频、文件、链接、审批、卡片的等消息类型,但是消息体格式和普通消息、工作通知消息不一样。
注意:企业组织架构外部人员收不到该条消息。
接入系统发送u聊消息给U聊用户有两种形式:
群发
单发
使用者只需要在java程序中调用相应的http接口就可以发起消息推送请求。
java代码调用发送接口范例如下:
private static final String multinotifyUrl = "http://172.21.34.30:11000/upchat-public-gateway/api/app/v2/multinotify";
private static final String apikey = "9e3b9304aa6fe2cd458190f5dfgdfg090795";
String userid = request.getUserid();
.....
//向用户发消息
Map<String, String> m = new HashMap<String, String>();
m.put("apikey", apikey);
m.put("userids", userid);
m.put("content", "解析结果:" + parsedResult);
m.put("type", String.valueOf("1"));
String result = HttpClientUtil.doPost(multinotifyUrl, m, "utf-8");
# 消息接口详情
消息格式参考:消息类型与消息格式
# 接入系统消息推送个人接口
接入系统消息推送接口,提供往用户点对点发送消息的服务。该消息接口不需要用户关注该系统的服务号。
提供方:U聊服务端
发起方:接入系统
# 请求地址
| /upchat-public-gateway/api/app/notify |
调用方式:HTTP POST
请求格式:application/x-www-form-urlencoded;charset=utf-8
请求编码:UTF-8
# 请求参数
| 属性 | 必填 | 说明 |
|---|---|---|
| apikey | 消息发送凭据 | |
| userid | 用户OA账号,即登陆OA的用户名 | |
| content | 消息内容 | |
| type | 发送类型 | |
| payload | 否 | 对接系统和手机客户端传递的不可见交换数据(格式见附录6) |
| payload_type | 否 | payload字段填写时,本字段为必填(零钱转账交易状态,取值:wallet_trans_st) |
| push | 否 | 推送到用户手机是否在通知栏明文显示推送内容,支持文本、富文本、账单消息,取值:true,显示明文,不填或者其他值,不显示明文,和现在方式保持一致 |
# 参数详细说明 :
content
类型 说明 文本消息 直接填写消息内容 图片消息或富文本消息 取值格式见消息类型与消息格式 文件附件格式 取值见消息类型与消息格式 互动型消息 取值参考消息类型与消息格式 互动型消息的变更类回执 取值参考消息类型与消息格式 type
值 说明 1 文本消息 2 图片消息,需要先调用接口将图片上传到服务器 3 富文本消息-图文消息,需要先调用接口将图片上传到服务器 4 富文本消息-账单消息 5 语音消息,需要先调用接口将语音文件上传到服务器 6 视频消息,需要先调用接口将视频文件上传到服务器 8 文件附件消息,如word、excel等文件,需要事先将文件上传到服务器 70 互动型消息 45 互动型消息的变更类回执
# 响应
响应格式:application/json;charset=UTF-8
响应编码:UTF-8
返回值:
属性 说明 status 应答码,0表示成功,非0时异常信息见msg msg 异常信息 token 消息ID,status为0时才会有该字段,返回已投递的消息的唯一标识,供后续使用
# 接入系统给所有订阅者群发消息
接入系统消息推送接口,提供往所有订阅该服务号的用户群发消息的服务。该消息接口仅仅发送给已订阅该服务号的用户。
提供方:U聊服务端
发起方:接入系统
# 请求地址
| /upchat-public-gateway/api/app/notifyattentions |
调用方式:HTTP POST
请求格式:application/x-www-form-urlencoded;charset=utf-8
请求编码:UTF-8
# 请求参数
| 属性 | 必填 | 说明 |
|---|---|---|
| apikey | 消息发送凭据 | |
| content | 消息内容 | |
| type | 发送类型 | |
| payload | 否 | 对接系统和手机客户端传递的不可见交换数据(格式见附录6) |
| payload_type | 否 | payload字段填写时,本字段为必填(零钱转账交易状态,取值:wallet_trans_st) |
| push | 否 | 推送到用户手机是否在通知栏明文显示推送内容,支持文本、富文本、账单消息,取值:true,显示明文,不填或者其他值,不显示明文,和现在方式保持一致 |
# 参数详细说明 :
content
类型 说明 文本消息 直接填写消息内容 图片消息或富文本消息 取值格式见消息类型与消息格式 文件附件格式 取值见消息类型与消息格式 互动型消息 取值参考消息类型与消息格式 互动型消息的变更类回执 取值参考消息类型与消息格式 type
值 说明 1 文本消息 2 图片消息,需要先调用接口将图片上传到服务器 3 富文本消息-图文消息,需要先调用接口将图片上传到服务器 4 富文本消息-账单消息 5 语音消息,需要先调用接口将语音文件上传到服务器 6 视频消息,需要先调用接口将视频文件上传到服务器 8 文件附件消息,如word、excel等文件,需要事先将文件上传到服务器 70 互动型消息 45 互动型消息的变更类回执 # 响应
响应格式:application/json;charset=UTF-8
响应编码:UTF-8
返回值:
属性 说明 status 应答码,0表示成功,非0时异常信息见msg msg 异常信息 tokens 消息ID数组,status为0时才会有该字段,返回已投递的消息的唯一标识,供后续使用;token总数为发送给订阅者消息的总数。 响应范例
{
"status":"0",
"msg":"成功",
"tokens":
["hEINF-74","hEINF-75","hEINF-76","hEINF-77","hEINF-78","hEINF-79"]
}
# 接入系统消息消息多用户推送接口
接入系统消息推送接口,提供往多个用户用户点对点发送消息的服务。该消息接口不需要用户关注该系统的服务号。
提供方:U聊服务端
发起方:接入系统
# 请求地址
| /upchat-public-gateway/api/app/multinotify |
调用方式:HTTP POST
请求格式:application/x-www-form-urlencoded;charset=utf-8
请求编码:UTF-8
# 请求参数
| 属性 | 必填 | 说明 |
|---|---|---|
| apikey | 消息发送凭据 | |
| userids | 用户OA账号,即登陆OA的用户名,多个用户userid采用半角逗号[,]分隔 | |
| content | 消息内容 | |
| type | 发送类型 | |
| push | 否 | 推送到用户手机是否在通知栏明文显示推送内容,支持文本、富文本、账单消息,取值:true,显示明文,不填或者其他值,不显示明文,和现在方式保持一致 |
# 参数详细说明 :
content
类型 说明 文本消息 直接填写消息内容 图片消息或富文本消息 取值格式见消息类型与消息格式 文件附件格式 取值见消息类型与消息格式 互动型消息 取值参考消息类型与消息格式 互动型消息的变更类回执 取值参考消息类型与消息格式 type
值 说明 1 文本消息 2 图片消息,需要先调用接口将图片上传到服务器 3 富文本消息-图文消息,需要先调用接口将图片上传到服务器 4 富文本消息-账单消息 5 语音消息,需要先调用接口将语音文件上传到服务器 6 视频消息,需要先调用接口将视频文件上传到服务器 7 菜单点击事件消息,消息reply格式详细见消息类型与消息格式 8 文件附件消息,如word、excel等文件,需要事先将文件上传到服务器 # 响应
响应格式:application/json;charset=UTF-8
响应编码:UTF-8
返回值:
属性 说明 status 应答码,0表示成功,非0时异常信息见msg msg 异常信息 tokens ["token1","token2","..."]消息ID,status为0时才会有该字段,返回已投递的多条消息的唯一标识,供后续使用,tokens中元素个数为成功发送用户个数。