外部系统通过消息接口,可以把系统消息发送到协同平台。
接口调用请求说明
此服务提供了两个不同的URI资源供客户端调用,调用方式如下:
http请求方式:POST 接收人为用户ID:http://ip:port/seeyon/rest/message/userId 接收人为登录名:http://ip:port/seeyon/rest/message/loginName
具体代码调用方式请查看REST接口调用示例
参数说明
此请求为【接收人为用户ID】POST请求,传递参数如下:
{ "userIds": [11111,22222],/***接受人ID**/ "sendUserId" : "3333",/***发起人用户ID;V5.6增加发起者登录名参数【senderLoginName】**/ "content" : 我是消息内容,/***消息内容**/ "url" : [],/***消息连接**/ }
此请求为【接收人为登录名】POST请求,传递参数如下:
{ "sendUserId" : "3333",/***发起人用户ID;V5.6增加发起者登录名参数【senderLoginName】**/ "loginNames" : [张三,李四],/***登录名**/ "content" : 我是消息内容,/***消息内容**/ "url" : [],/***消息连接**/ }
参数 | 是否必须 | 说明 |
---|---|---|
loginNames | 是 | 接收人为登录名,可以多人接收 |
userIds | 是 | 接收人为用户ID,可以多人接收 |
content | 是 | 消息内容:可以是发送人,标题,内容的组合 |
url | 否 | 接收人触发的链接,跟接收人一一对应,如果为空则此接收人没有链接 |
sendUserId | 是 | 发起者ID 与发起者登录名【senderLoginName】填写一个即可 |
senderLoginName(V5.6增加) | 是 | 发起者登录名 与发起者ID【sendUserId】填写一个即可 |
返回参数说明
返回值:ServiceResponse;成功则返回1,失败而没有异常是0,有异常返回是-1,并且返回异常信息