# EB代码组件进行IM接口调用

来源快照：`result_data_new_260518.json`

- 来源 ID：`1202102088724660353`
- 模块：工作消息
- 目录：管理员操作指南 - 机器人设置
- space ID：`1159418347111063584`
- 原文链接：未提供
- 产品基线：未提供

## 正文

# **EB代码组件进行IM接口调用**

本节将详细介绍使用EB代码组件进行IM部分接口调用，满足机器人场景化需求，在动作流中获取消息详情、发送单聊/群聊消等。

# **EB代码组件介绍**

![](https://weapp.eteams.cn/papi/file/preview?fileId=1202103055040692227&type=redirect&customParam=%7B%22isExtDist%22%3Atrue%2C%22distributeId%22%3A%22%22%2C%22externalId%22%3A%22%22%2C%22appId%22%3A%22%22%7D)

**分组标识固定填写：em_msg_esb** ，配置调用接口请求输入参数、输出参数。

输入/输出参数快速导入（后续直接将相应接口入参/出参导入即可）：

![](https://weapp.eteams.cn/papi/file/preview?fileId=1202109209588588556&type=redirect&customParam=%7B%22isExtDist%22%3Atrue%2C%22distributeId%22%3A%22%22%2C%22externalId%22%3A%22%22%2C%22appId%22%3A%22%22%7D)

入参主要分为两部分：url、params。url为调用接口地址，入参字段导入后，url固定填写相应接口地址；params为具体接口调用参数字段。

# **机器人webhook接口推送消息**

url字段值：/robot/sendMsg

输入参数字段JSON导入格式：

{ "url": "", "params": { "token": "", "txt": "", "rMsgId": "", "rGroupId": "", "atUser": [ { "cid": "", "uid": "" } ] } }

输入参数字段解析：

**名称**| **类型**| **说明**| **是否必填**  
---|---|---|---  
url| string| 接口地址| 是  
params| object| 接口调用参数|   
token| string| 机器人token| 是  
txt| string| 文本消息内容| 是  
rMsgId| string| 引用消息ID| 否  
rGroupId| string| 引用消息群组ID| 否  
atUser| []user| @人员列表| 否  
atUser.cid| string| @人员CID| 是  
atU| | |   
  
# **批量获取消息详情**

url字段值：/msg/batchQueryMsgDetail

输入参数字段JSON导入格式：

{ "url": "", "params": { "msgIds": [""], "separate": 0, "user": { "uid": "", "cid": "" }, "msgSource": { "flag": 0, "group_id": "", "user": { "uid": "", "cid": "" } }, "filterEmoji": 0 } }

输入参数字段解析：

**名称**| **类型**| **说明**  
---|---|---  
entityCommentTxt| string| 富文本-由消息组装成事项评论内容，用于事项群中批量消息转事项评论  
details| []object| 消息详细信息  
details.msg| string| 原始消息内容  
details.rMsgId| string| 回复消息ID  
details.senderName| string| 消息发送人名称  
details.mkind| int| 消息内容包含的消息类型  
details.fromUid| string| 发送人UID  
details.refMsgId| string| 引用消息ID  
details.fromCid| string| 发送人CID  
details.kind| int| 消息种类  
[details.id](http://details.id)| int| 消息ID  
details.time| int| 消息发送时间  
details.content| string| 提取文本内容  
entityComment| string| 普通文本-由消息组装成事项评论内容，用于事项群中批量消息转事项评论  
currTime| string| 服务器当前纳秒时间  
content| string| 提取消息文本内容，多条消息拼接  
images| []string| 消息中包含的图片文件列表  
files| []string| 消息中包含的附件Id列表  
  
# **发送单聊消息**

url字段值：/send/sendSingleMsg

输入参数字段JSON导入格式：

 _// 文本消息_ { "url": "", "params": { "sender": { "cid": "", "uid": "", "name": "" }, "robotToken": "", "reciver": { "cid": "", "uid": "" }, "txt": "", "userShow": { "cid": "", "uid": "", "name": "" }, "susUsers": [ { "cid": "", "uid": "" } ], "txtAsMK": 1 } } _// 图片消息_ { "url": "", "params": { "sender": { "cid": "", "uid": "", "name": "" }, "robotToken": "", "reciver": { "cid": "", "uid": "" }, "userShow": { "cid": "", "uid": "", "name": "" }, "susUsers": [ { "cid": "", "uid": "" } ], "img": { "t": "", "h": "", "w": "", "nm": "", "src": "", "s": "" }, "txtAsMK": 1 } }

输入参数字段解析：

**名称**| **类型**| **说明**| **是否必填**  
---|---|---|---  
url| string| 接口地址| 是  
params| object| 接口调用参数|   
robotToken| string| 机器人token| 是（使用sender可不填）  
sender| user| 消息发送人| 是（使用robotToken可不填）  
sender.cid| string| 发送人CID|   
sender.uid| string| 发送人UID|   
[sender.name](http://sender.name)| string| 发送人名称| 否  
reciver| user| 消息接收人| 是  
reciver.cid| string| 接收人CID|   
reciver.uid| string| 接收人UID|   
txt| string| 发送文本消息内容| 否  
img| object| 发送图片信息| 否  
img.t| string| 图片格式类型，如：image/png| 否  
img.h| string| 图片高度| 否  
img.w| string| 图片宽| 否  
img.nm| string| 图片名称| 否  
img.src| string| 图片文件ID| 否  
img.s| string| 图片大小| 否  
userShow| user| 显示发送人（用于代理场景）| 否  
userShow.cid| string| 人员CID|   
userShow.uid| string| 人员UID|   
susUsers| []user| 代理@显示（用于代理场景）| 否  
susUsers.cid| string| 人员CID|   
susUsers.uid| string| 人员UID|   
txtAsMK| int| 是否将txt解析为makedown格式（0801基线支持）| 否  
  
# **发送群聊消息**

url字段值：/send/sendGroupMsg

输入参数字段JSON导入格式：

 _  
// 文本消息_ { "params": { "rMsgId": "#string", "txt": "#string", "robotToken": "#string", "sender": { "uid": "#string", "cid": "#string" }, "receiverFilter": { "user_filter": [ { "filter_type": "#int", "users": [ { "uid": "#string", "cid": "#string" } ] } ] }, "susUsers": [ { "uid": "#string", "cid": "#string" } ], "groupId": "#string", "atUsers": [ { "uid": "#string", "cid": "#string" } ], "txtAsMK": 1 }, "url": "#string" } _// 图片消息_ { "params": { "rMsgId": "#string", "img": { "t": "", "h": "", "w": "", "nm": "", "src": "", "s": "" }, "robotToken": "#string", "sender": { "uid": "#string", "cid": "#string" }, "receiverFilter": { "user_filter": [ { "filter_type": "#int", "users": [ { "uid": "#string", "cid": "#string" } ] } ] }, "susUsers": [ { "uid": "#string", "cid": "#string" } ], "groupId": "#string", "atUsers": [ { "uid": "#string", "cid": "#string" } ], "txtAsMK": 1 }, "url": "#string" }

输入参数字段解析：

**名称**| **类型**| **说明**| **是否必填**  
---|---|---|---  
url| string| 接口地址| 是  
params| object| 接口调用参数|   
sender| user| 消息发送人| 是（使用robotToken可不填）  
sender.cid| string| 发送人CID|   
sender.uid| string| 发送人UID|   
robotToken| string| 机器人token（传递则以机器人身份发送消息，sender字段失效）| 是（使用sender可不填）  
groupId| string| 群ID| 是  
rMsgId| string| 回复引用消息ID| 否  
txt| string| 文本消息内容| 是  
img| object| 发送图片信息| 否  
img.t| string| 图片格式类型，如：image/png| 否  
img.h| string| 图片高度| 否  
img.w| string| 图片宽| 否  
img.nm| string| 图片名称| 否  
img.src| string| 图片文件ID| 否  
img.s| string| 图片大小| 否  
file| object| 发送文件信息| 否  
[file.id](http://file.id)| string| 文件ID| 否  
file.nm| string| 文件名称| 否  
file.t| string| 文件类型| 否  
file.s| string| 文件大小| 否  
atUsers| []user| @人员里列表| 否  
susUsers| []user| 代理@显示用户（代理场景使用）| 否  
receiverFilter| object| 消息接收过滤条件| 否  
receiver_filter.user_filter| []object| 用户过滤条件|   
user_filter.filter_type| int| 过滤类型(0. 不过滤 1. 指定用户接收 2. 过滤普通用户 3. 过滤管理员)|   
user_filter.users| []user| 过滤条件用户集合|   
txtAsMK| int| 是否将txt解析为makedown格式（0801基线支持）| 否  
  
# **获取AI消息摘要内容**

url字段值：/ai/getGroupMsgSummary

输入参数字段JSON导入格式：

{ "params": { "group_id": "#string", "user": { "uid": "#string", "cid": "#string" }, "msgRange": { "ext": "#string", "msgIds": [], "num": "#int", "mNum": "#int", "type": "#int", "key": "#string", "fNum": "#int" } }, "url": "#string" }

输入参数字段解析：

**名称**| **类型**| **说明**| **是否必填**  
---|---|---|---  
url| string| 接口地址| 是  
params| object| 接口调用参数|   
user| user| 触发用户| 是  
user.cid| string| 触发人团队CID|   
user.uid| string| 触发人|   
group_id| string| 触发群组|   
msgRange| string| 消息范围| 是  
msgRange.num| string| 数量| 否  
msgRange.type| string| 类型：4 消息摘要| 是  
msgRange.key| string| 消息内容关键词| 否  
msgRange.msgIds| string| 指定消息列表| 否  
msgRange.mNum| string| 最大拉取消息数量（推荐值：100）| 否  
msgRange.fNum| string| 未达到拉取数量，填充条数(推荐值：5)| 否  
msgRange.ext| string| 透传数据| 否  
  
输出参数字段JSON导入格式：

{ "datas": "#string" }

**名称**| **类型**| **说明**  
---|---|---  
datas| string| 可摘要的消息内容  
  
# **批量查询群信息**

url字段值：/group/syncGroupInfo

输入参数字段JSON导入格式：

{ "url": "", "params": { "type": 0, "groups": [ { "group_id": "", "client_uc": 0 } ] } }

输入参数字段解析：

**名称**| **类型**| **说明**| **是否必填**  
---|---|---|---  
url| string| 接口地址| 是  
params| object| 接口调用参数|   
type| int| 群类型（固定传0即可）| 是  
groups| []object| 需要获取的群信息| 是  
[groups.group](http://groups.group)_id| string| 群组ID| 是  
groups.client_uc| int| 群信息本地uc（固定传0即可）| 是  
  
输出参数字段JSON导入格式：
    
    
    {
        "datas": [
            {
                "custom": 0,
                "groupinfo": {
                    "avatar": "",
                    "corp_id": "",
                    "create_source": 0,
                    "create_time": 0,
                    "destroy_time": 0,
                    "gcid": "",
                    "group_id": "",
                    "gt_id": "0",
                    "history": 0,
                    "host_cid": "",
                    "host_uid": "",
                    "identity_status": 0,
                    "join_flag": 0,
                    "last_time": 0,
                    "mask": 1,
                    "max_num": 23,
                    "name": "",
                    "on_off": 0,
                    "robot_number": 0,
                    "rs_onoff": 0,
                    "state": 0,
                    "user_num": 0
                }
            }
        ]
    }

输出参数字段解析：

**名称**| **类型**| **说明**  
---|---|---  
group_id| string| 群ID  
avatar| string| 群头像  
name| string| 群名称  
user_num| string| 群人数  
create_time| string| 群创建时间戳  
last_time| string| 群最后活跃时间
