企微WorkTool API
首页文档中心合作申请
首页文档中心合作申请
  1. 指令消息
  • 快速入门
  • 功能演示
  • 机器人流程图
  • 消息回调接口规范
  • 常见问题
  • 错误码
  • 指令消息
    • 发送消息
      POST
    • 推送任意图片/音视频/文件
      POST
    • 转发消息(不推荐)
      POST
    • 创建外部群
      POST
    • 修改群信息(含拉人等)
      POST
    • 解散群
      POST
    • 推送微盘图片
      POST
    • 推送腾讯文档
      POST
    • 推送收集表
      POST
    • 推送微盘文件
      POST
    • 按手机号添加好友
      POST
    • 从外部群添加好友
      POST
    • 修改好友信息
      POST
    • 修改群成员备注
      POST
    • 删除联系人
      POST
    • 添加待办
      POST
    • 清空客户端指令
      POST
    • 批量发送指令
      POST
    • 切换企业(定制)
      POST
    • 发送链接(定制)
      POST
    • 发送自定义path小程序(定制)
      POST
    • 消息撤回(定制)
      POST
  • 机器人配置
    • 机器人后端通讯加密
    • 机器人集成微信对话开放平台
    • 获取机器人信息
    • 查询机器人是否在线
    • 查询机器人登录日志
    • 获取机器人企业列表(定制)
  • 群管理
    • 群列表查询
  • 历史消息
    • 历史消息列表查询
    • 指令消息API调用查询
    • 指令执行结果查询
    • 机器人消息回调日志列表查询
  • 机器人回调配置
    • 机器人消息回调配置
    • 机器人配置回调
    • 查询机器人回调
    • 删除机器人回调
    • 机器人回调接口标准
    • 删除机器人回调(旧)
    • 机器人配置回调(旧)
  • 回调接口Demo
    • QA回调接口Demo2(复读机)
    • QA回调接口Demo3(不回复)
  1. 指令消息

发送消息

POST
/wework/sendRawMessage
功能介绍:
由机器人发送指定内容消息到相应的好友或群聊中,支持@指定人
注意:
1.
at所有人可以填入"@所有人"(应为群主或群管理)
2.
减号- 空格和英文括号()为保留字请勿在人名/群名/备注名中使用
3.
群名定义尽量短,一般不要超过12个汉字(调小企微内字体设置更佳)
4.
存在重名问题考虑设置好友备注名或群备注名(不要以数字开头,企微搜索bug!长度不要超长被...截断)
5.
建议titleList仅填一个,因为有失败重试机制,防止多个批量重试导致重发
6.
指令接口IP请求限流为60QPM,如果请求量过大可使用批量发送指令减少总请求次数(https://worktool.apifox.cn/api-147612959)
注意:本文档所有接口的请求为QPM为60(每分钟60次请求),超过QPM的请求会被拦截丢弃,多次频繁被拦截则会对IP拦截。

请求参数

Query 参数
robotId
string 
客户端链接唯一标识
必需
示例值:
{{robot_id}}
Header 参数
Content-Type
string 
必需
示例值:
application/json
Body 参数application/json
socketType
integer 
必需
通讯类型 固定值=2
list
array [object {4}] 
必需
type
integer 
必需
消息类型 固定值=203
titleList
array[string]
昵称或群名
必需
receivedContent
string 
必需
发送文本内容 (\n换行)
atList
array[string]
可选
at的人(at所有人用"@所有人")
示例
{
  "socketType": 2,
  "list": [
    {
      "type": 203,
      "titleList": [
        "仑哥(这里改成你的微信昵称或群名)"
      ],
      "receivedContent": "你好~"
    }
  ]
}

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location -g --request POST 'https://api.worktool.ymdyes.cn/wework/sendRawMessage?robotId=worktool1' \
--header 'Content-Type: application/json' \
--data-raw '{
    "socketType":2,
    "list":[
        {
            "type":203,
            "titleList":[
                "仑哥(这里改成你的微信昵称或群名)"
            ],
            "receivedContent":"你好~"
        }
    ]
}'

返回响应

🟢200成功
application/json
Body
code
number 
必需
message
string 
必需
data
string 
必需
示例
{
  "code": 0,
  "message": "string",
  "data": "string"
}
修改于 2024-11-12 01:42:50
上一页
错误码
下一页
推送任意图片/音视频/文件
Built with