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

机器人回调接口标准

POST
https://api.worktool.ymdyes.cn/robot/robotInfo/callBack/test/{{robot_id}}
注:
1.
请开发者开发此POST回调接口接收数据,接口返回值响应码应为200,响应内容不限
2.
开发完成后调用【机器人配置回调】将接口地址绑定到机器人
3.
目前只会回调一次且不做失败重试
4.
请提前记录每次调用发送指令消息的返回值(data值为messageId),回调时与此messageId对应
5.
如果一次发送指令含多条串行指令,同一messageId消息会回调多次

错误码列表#

        //指令执行成功
        const val SUCCESS = 0
        //数据格式错误
        const val ERROR_ILLEGAL_DATA = 101011
        //非法操作
        const val ERROR_ILLEGAL_OPERATION = 101012
        //非法权限
        const val ERROR_ILLEGAL_PERMISSION = 101013

        //创建群失败
        const val ERROR_CREATE_GROUP = 201011
        //群改名失败
        const val ERROR_GROUP_RENAME = 201012
        //群拉人失败
        const val ERROR_GROUP_ADD_MEMBER = 201013
        //群踢人失败
        const val ERROR_GROUP_REMOVE_MEMBER = 201014
        //改群公告失败
        const val ERROR_GROUP_CHANGE_ANNOUNCEMENT = 201015
        //改群备注失败
        const val ERROR_GROUP_CHANGE_REMARK = 201016
        //查找聊天窗失败
        const val ERROR_INTO_ROOM = 201101
        //发送消息失败
        const val ERROR_SEND_MESSAGE = 201102
        //按钮寻找失败
        const val ERROR_BUTTON = 201103
        //目标寻找失败
        const val ERROR_TARGET = 201104
        //转发失败
        const val ERROR_RELAY = 201105
        //重复添加
        const val ERROR_REPEAT = 201106
        //文件下载异常
        const val ERROR_FILE_DOWNLOAD = 201107
        //文件存储异常
        const val ERROR_FILE_STORAGE = 201108

请求参数

Body 参数application/json

示例
{
    "messageId": "990000200110099239",
    "errorCode": 0,
    "errorReason": "",
    "runTime": 1666238534935,
    "timeCost": 2.5,
    "type": 203,
    "rawMsg": "{\"messageId\":\"1582945256466776064\",\"titleList\":[\"第一个接收者\",\"第二个接收者\",\"第三个接收者\"],\"textType\":0,\"receivedContent\":\"测试一下发送消息\",\"type\":203,\"showMessageHistory\":false}",
    "successList": ["第一个接收者","第三个接收者"],
    "failList": ["第二个接收者"]
}

请求示例代码

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/robot/robotInfo/callBack/test/worktool1' \
--header 'Content-Type: application/json' \
--data-raw '{
    "messageId": "990000200110099239",
    "errorCode": 0,
    "errorReason": "",
    "runTime": 1666238534935,
    "timeCost": 2.5,
    "type": 203,
    "rawMsg": "{\"messageId\":\"1582945256466776064\",\"titleList\":[\"第一个接收者\",\"第二个接收者\",\"第三个接收者\"],\"textType\":0,\"receivedContent\":\"测试一下发送消息\",\"type\":203,\"showMessageHistory\":false}",
    "successList": ["第一个接收者","第三个接收者"],
    "failList": ["第二个接收者"]
}'

返回响应

🟢200成功
application/json
Body

示例
{}
修改于 2023-05-22 06:00:01
上一页
删除机器人回调
下一页
删除机器人回调(旧)
Built with