发送应用消息
接口定义
支持推送普通文本消息、广播消息、@人消息、帖子消息、图片/文件消息、链接消息
请求方式:POST
Content-Type: application/json;charset=utf-8
参数说明
属性 |
类型 |
非空 |
描述 |
accessToken |
string |
* |
调用接口凭证 |
各个消息类型的具体POST格式参考以下文档
消息类型
普通文本消息
发送普通文本消息
请求示例
POST https:
Content-Type: application/json
{
"msgType":"txt",
"chatId":"test@test.com",
"msg":"测试发送文字"
}
请求参数
属性 |
类型 |
非空 |
描述 |
msgType |
string |
* |
消息类型,普通文本消息为:txt |
chatId |
string |
* |
消息接受者uid |
msg |
string |
* |
消息内容 |
返回示例
{
"code":"10000",
"var":{
"mid":"0:1ch#AAAAAVvrjxAAAABZl3"
}
}
返回码
返回码 |
说明 |
10000 |
正常返回 |
10001 |
未知错误 |
10006 |
无权限操作 |
10008 |
超过限制 |
返回参数
属性 |
类型 |
说明 |
code |
string |
返回码 |
var |
object |
返回数据 |
-- mid |
string |
消息mid |
广播消息
发送广播消息.
请求示例
POST https:
Content-Type: application/json
{
"msgType":"txt",
"chatId":"#10529#T",
"msg":"广播",
"broadcast":true
}
请求参数
属性 |
类型 |
非空 |
描述 |
msgType |
string |
* |
消息类型,广播的原消息类型 |
chatId |
string |
* |
广播讨论uid |
msg |
string |
* |
消息内容 |
broadcast |
boolean |
* |
是否广播 |
返回示例
{
"code":"10000",
"var":{
"mid":"0:1ch#AAAAAVvrjxAAAABZl3"
}
}
返回码
返回码 |
说明 |
10000 |
正常返回 |
10001 |
未知错误 |
10006 |
无权限操作 |
10008 |
超过限制 |
返回参数
属性 |
类型 |
说明 |
code |
string |
返回码 |
var |
object |
返回数据 |
-- mid |
string |
消息mid |
设置广播/撤回广播
设置/撤回广播消息
请求示例
POST https:
Content-Type: application/json
{
"chatId":"#10529#T",
"mid":"0:1ch#AAAAAVvsydgAAADTl0",
"broadcast":true
}
请求参数
属性 |
类型 |
非空 |
描述 |
chatId |
string |
* |
广播uid |
mid |
string |
* |
要设置/撤销广播的消息mid |
broadcast |
boolean |
* |
true设置,false撤回 |
返回示例
{
"code": "10000"
}
返回码
返回码 |
说明 |
10000 |
正常返回 |
10001 |
未知错误 |
10006 |
无权限操作 |
返回参数
@人消息
发送@人消息
请求示例
POST https:
Content-Type: application/json
{
"msgType":"txt",
"chatId":"#10530#T",
"msg":"at人@test",
"atUser":"#7#U"
}
请求参数
属性 |
类型 |
非空 |
描述 |
msgType |
string |
* |
消息类型 |
chatId |
string |
* |
消息接受者uid |
msg |
string |
* |
消息内容 |
atUser |
string |
* |
@对象的uid,"all"表示@全部人 |
返回示例
{
"code":"10000",
"var":{
"mid":"0:1ch#AAAAAVvrjxAAAABZl3"
}
}
返回码
返回码 |
说明 |
10000 |
正常返回 |
10001 |
未知错误 |
10006 |
无权限操作 |
10008 |
超过限制 |
返回参数
属性 |
类型 |
说明 |
code |
string |
返回码 |
var |
object |
返回数据 |
-- mid |
string |
消息mid |
帖子消息
发送帖子消息
请求示例
POST https:
Content-Type: application/json
{
"msgType":"post",
"chatId":"#10530#T",
"msg":"帖子消息",
"post":{
"title":"帖子标题",
"content":"帖子内容"
}
}
请求参数
属性 |
类型 |
非空 |
描述 |
msgType |
string |
* |
消息类型,帖子消息为:post |
chatId |
string |
* |
消息接受者uid |
msg |
string |
* |
消息内容 |
post |
string |
* |
帖子信息 |
-- title |
string |
* |
帖子标题 |
-- content |
string |
* |
帖子内容 |
返回示例
{
"code":"10000",
"var":{
"mid":"0:1ch#AAAAAVvrjxAAAABZl3"
}
}
返回码
返回码 |
说明 |
10000 |
正常返回 |
10001 |
未知错误 |
10006 |
无权限操作 |
10008 |
超过限制 |
返回参数
属性 |
类型 |
说明 |
code |
string |
返回码 |
var |
object |
返回数据 |
-- mid |
string |
消息mid |
图片/文件消息
发送图片/文件消息需要两个步骤:1上传文件 2发送文件消息
1、先将文件上传到服务器临时区域,获取到临时文件fileId
2、发送文件消息,传参fileId
请求示例(上传文件)
POST https://api.lunkr.cn/api/files/upload?accessToken=ACCESS_TOKEN
请求参数
上传文件流,参数name="file" Content-Disposition: form-data
返回示例
{
"code":"10000",
"var":{
"fileId":"MTU0MjE2Mzg3NjkxM+e+oeaFlS5QTkc="
}
}
返回码
返回码 |
说明 |
10000 |
正常返回 |
10008 |
超过限制 |
20301 |
文件检查失败 |
20302 |
文件找不到 |
返回参数
属性 |
类型 |
说明 |
code |
string |
返回码 |
var |
object |
返回数据 |
-- fileId |
string |
文件id |
请求示例(发送文件消息)
POST https:
Content-Type: application/json
{
"msgType":"file",
"chatId":"#10530#T",
"msg":"文件消息",
"file":{
"fileId":"MTU0MjE2Mzg3NjkxM+e+oeaFlS5QTkc="
}
}
请求参数
属性 |
类型 |
非空 |
描述 |
msgType |
string |
* |
消息类型,文件消息为:file |
chatId |
string |
* |
消息接受者uid |
msg |
string |
* |
消息内容 |
file |
object |
* |
文件内容 |
-- fileId |
string |
* |
上一步得到的临时文件fileId |
返回示例
{
"code":"10000",
"var":{
"mid":"0:1ch#AAAAAVvrjxAAAABZl3"
}
}
返回码
返回码 |
说明 |
10000 |
正常返回 |
10001 |
未知错误 |
10008 |
超过限制 |
20301 |
文件检查失败 |
20302 |
文件找不到 |
返回参数
属性 |
类型 |
说明 |
code |
string |
返回码 |
var |
object |
返回数据 |
-- mid |
string |
消息mid |
链接消息
发送链接消息,用户在论客收到该链接消息后,打开可跳转到对应url,url后缀附带token=${token}&uid=${uid},可以约定相应协议,论客客户端识别到该字段后,会将论客用户登录得到的sessionId替换${token},用户userId替换${uid}
请求示例
POST https:
Content-Type: application/json
{
"msgType":"card",
"chatId":"#10530#T",
"msg":"链接消息",
"card":{
"type":"richCardMsg",
"logo":"http://gz.mailtech.cn/kaoqin/logo.jpg",
"subject":"10月考勤",
"content":"卡片链接正文长文",
"url":"https://www.ss.com/h5?app_id=abc&token=${token}&uid=${uid}",
"buttons":[
{
"title":"绑定",
"action":"open",
"url":"http:;//cac.cn/bind.html"
},
{
"title":"解绑",
"action":"open",
"url":"http:;//cac.cn/unbind.html"
}
]
}
}
请求参数
属性 |
类型 |
非空 |
描述 |
msgType |
string |
* |
消息类型,链接消息为:card |
chatId |
string |
* |
消息接受者uid |
msg |
string |
* |
消息内容 |
card |
string |
* |
链接内容 |
-- type |
string |
thirdAppMsg |
链接消息类型,默认thirdAppMsg,富卡片链接类型richCardMsg |
-- logo |
string |
* |
链接logo |
-- subject |
string |
* |
标题,当只想显示logo图片+正文长文时,subject可不传 |
-- content |
string |
|
正文长文 |
-- url |
string |
* |
论客客户端点击后要跳转到的目标url |
-- buttons |
array |
|
动作按钮 |
------title |
string |
|
按钮名称 |
------action |
string |
|
按钮动作 |
------url |
string |
|
按钮触发跳转url |
返回示例
{
"code":"10000",
"var":{
"mid":"0:1ch#AAAAAVvrjxAAAABZl3"
}
}
返回码
返回码 |
说明 |
10000 |
正常返回 |
10001 |
未知错误 |
10006 |
无权限操作 |
10008 |
超过限制 |
返回参数
属性 |
类型 |
说明 |
code |
string |
返回码 |
var |
object |
返回数据 |
-- mid |
string |
消息mid |