企微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. 指令消息

发送自定义path小程序(定制)

POST
https://api.worktool.ymdyes.cn/wework/sendRawMessage
功能介绍:
发送自定义标题、副标题和icon图片的小程序样式消息
小程序需要是和企微同属一个企业且绑定关联的小程序
由机器人发送指定内容小程序消息到相应的好友或群聊中,支持外部群
定制接口需联系管理员申请付费授权
注意:
1.
如果给用户或群聊添加了备注名就要使用备注名发送(如果使用备注则企微版本必须>=4.0.12)
2.
减号-和英文括号()为保留字请勿在人名/群名/备注名中使用
3.
群名定义尽量短,一般不要超过12个汉字

请求参数

Query 参数
robotId
string 
客户端链接唯一标识
必需
示例值:
{{robot_id}}
Header 参数
Content-Type
string 
必需
示例值:
application/json
Body 参数application/json
object {0}
示例
{}

示例代码

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 '{}'

返回响应

🟢200成功
application/json
Body
code
number 
必需
message
string 
必需
data
string 
必需
示例
{
  "code": 0,
  "message": "string",
  "data": "string"
}
上一页
发送链接(定制)
下一页
消息撤回(定制)
Built with