API接口文档
    API接口文档
    • 接入说明
    • 快速入门
      • 如何发送一条消息
      • 通过接口实现群发
      • 加密externalUserId打通方案
      • unionId打通方案
      • 企业级API消息回调签名说明
    • 接口文档
      • 企业级接口
        • 企业级接口说明
        • 成员接口
          • 成员信息
            • 获取企业成员列表
            • 通过邮箱或uid获取成员详情
            • 激活成员
          • 部门信息
            • 获取部门列表
            • 获取部门成员
          • 企业内小组管理
            • 创建小组
            • 查询小组
            • 删除小组
          • 获取企业信息
            • 获取企业基础信息
          • 通过成员userid获取账号botId
            • 通过成员userid获取账号botId
          • 通过账号botId获取成员userid
            • 通过账号botId获取成员userid
          • 获取小组API信息
            • 获取企业内各小组API配置信息
            • 修改API配置信息
        • 客户接口
          • 客户信息管理
            • 获取客户列表
            • 查询客户详情
            • 企业微信外部联系人externalUserId转系统wxid
            • 系统wxid转换企业微信外部联系人externalUserId
            • 删除客户接口
            • 添加客户接口
            • 服务商id打通接口
            • 新增客户回调—RPA
            • 客户信息变更回调
            • 删除客户或者被客户删除回调
            • 修改备注手机号
            • 修改描述
            • 修改称呼
            • 修改备注
            • 客户id置换接口
            • 客户同步接口
            • 通过好友申请
            • 好友申请回调
            • 添加跟进记录v2
          • 标签管理
            • 获取自定义标签列表
            • 添加自定义标签
            • 更新自定义标签
            • 删除自定义标签
            • 增/删自定义标签
            • 添加自定义标签组
            • 删除自定义标签组
            • 修改自定义标签组名
            • 获取标签列表
            • 获取底层标签列表
            • 获取标签详情
            • 创建标签
            • 修改标签组
            • 修改标签
            • 删除标签组
            • 删除标签
            • 通过底层编辑客户企业标签
        • 托管账号接口
          • 账号操作管理
            • 获取企业内各小组托管账号信息
            • 账号托管事件回调
            • 新建托管账号
            • 删除托管账号
            • 重启托管账号
            • 查询托管账号状态
            • 输入托管账号验证码
            • 账号限制事件回调
            • 托管账号昵称变更回调
          • 托管账号标签
            • 创建托管账号标签
            • 删除托管账号标签
            • 更新托管账号标签
            • 获取托管账号标签列表
            • 给托管账号打/删标签
        • 群聊接口
          • 群聊欢迎语管理
            • 新建入群欢迎语
            • 查询入群欢迎语
            • 更新入群欢迎语
          • 群聊操作管理
            • 创建群聊
            • 将客户移出群聊
            • 将客户拉入群聊
            • 群聊改名
            • 群聊禁止改名
            • 群聊转移群主
            • 设置群管理员
            • 解散群聊
            • 修改托管账号在群聊中的昵称
            • 群活码
            • 禁止互相添加为联系人
            • 退出群聊接口
          • 群聊黑名单管理
            • 拉入群聊黑名单
            • 移出群聊黑名单
            • 获取群聊黑名单列表
          • 群聊防骚扰管理
            • 获取群聊防骚扰策略列表
            • 获取防骚扰策略生效的群聊列表
            • 应用防骚扰策略
          • 获取群聊信息
            • 获取群列表
            • 获取群二维码
            • 企业微信群chatid转系统群roomwxid
            • 系统群roomwxid转企业微信群chatid
            • 查询群详情
            • 群聊同步接口
        • 营销功能接口
          • 极速群发
            • 创建极速群发任务
            • 删除定时极速群发
            • 极速群发回调
            • 获取极速群发失败详情
          • 朋友圈
            • 查询朋友圈详情
            • 删除朋友圈
            • 朋友圈点赞回调
            • 朋友圈评论回调
            • 创建朋友圈
            • 创建朋友圈回调
            • 获取朋友圈列表
            • 朋友圈评论接口
            • 朋友圈点赞接口
          • 素材
            • 动态素材管理
              • 创建动态素材
              • 获取动态素材
            • 素材组管理
              • 获取素材组列表
              • 创建素材组
              • 更新素材组
            • 素材管理
              • 获取素材列表
              • 创建素材
              • 修改素材
              • 获取表单素材详情
          • 无限版群发
            • 无限版群发回调
            • 获取无限制群发失败详情
            • 获取群发详情
            • 创建无限版群发
            • 取消无限版群发任务
            • 查询无限版群发任务
        • 会话消息接口
          • 会话接口
            • 加入会话规则
            • 移除会话规则
            • 会话规则列表
            • 标为已读接口
            • 查询过滤规则中回话列表接口
            • 获取会话小结信息接口
            • 会话超时跟进回调
            • 设置免打扰接口
            • 设置成员上班时间
            • 自动结束会话
          • 消息接口
            • 发送消息
            • API发送消息结果回调
            • 接收消息回调 POST
            • 获取指定托管账号的聊天历史
            • 撤回消息
            • 发送消息(企微id)
          • 队列发送消息
            • 获取配置
            • 更新配置
            • 队列发送消息接口
            • 队列发送消息接口(企微id)
            • 队列发消息接口回调
        • 渠道合作接口
          • 侧边栏SDK
          • SSO概述
          • 聊天工作台 iframe 接入
          • 小组控制台 iframe 接入
        • 操作日志接口
          • 获取聚合聊天操作日志
      • 小组级接口
        • 小组级接口说明
        • 基础接口
          • 获取托管企业微信列表
          • 获取个人微信授权到期及首次扫码登录的时间
          • 获取联系人列表
          • 获取群列表
          • 获取群列表(不包含成员信息)
          • 发送系统通知
          • 获取自定义标签列表
          • 获取组内员工列表
        • 群聊接口
          • 加入群聊
          • 退出群聊事件回调
          • 加入群聊事件回调
          • 更改群名事件回调
          • 创建群聊
          • 通过联系人id获取联系人所在群聊
        • 会话接口
          • 开发建议
          • 获取指定会话
          • 获取会话列表
          • 会话事件回调
          • 分配会话
        • 加好友接口
          • 通过手机号加好友接口
          • 添加好友回调
          • 好友通过后回调
          • 群聊加好友接口
          • 通过企微id群聊加好友
        • 消息接口
          • 企微id发消息
          • 聊天历史
          • 小组级接收消息回调
          • 发送消息
        • 群发接口
          • 创建群发
          • 创建群发 Copy
          • 重发群发
          • 取消群发
          • 删除群发
          • 群发回调
          • 获取群发任务的失败列表
          • 获取群发任务的没有发送的列表
          • 获取群发任务的进度
      • 渠道级接口
        • 渠道级接口文档说明
        • 获取代理商token
        • 获取企业基础信息
        • 代理商下企业注册回调
      • 自建应用依赖接口
        • 自建应用依赖接口说明
        • 客户信息接口
          • 新增客户回调
          • 修改客户备注
          • 添加跟进记录
        • 雷达接口
          • 雷达访问接口
        • id信息获取接口
          • 获取chatId
          • 通过unionId获取chatId
      • 废弃接口
        • 会话小结
        • 渠道二维码管理
          • 获取渠道列表(企业控制台数据)
        • 秒回数据同步
        • 获取客户列表(2023/12/05 废弃)
        • 获取群列表
        • 获取客户详情
        • 获取群信息
        • 绑定企业微信官方ID
        • 通过externalUserId获取chatId
        • 获取群列表(2023/2/05 废弃)
        • 获取成员详情
        • 编辑客户企业标签
        • 加入群聊
    • 更新日志
      • 更新日志
    • 最佳实践
      • 联系人群聊相关最佳实践
      • 消息相关最佳实践
      • AI 课程助手

    接入说明

    接口类型#


    企业级接口#

    说明:
    用于获取企业下全部托管账号的数据信息(客户数据、账号信息、成员信息),进而实现大部分的RPA功能(群发、拉群、SOP等),使用企业级接口调用凭证实现接口调用。

    小组级接口#

    说明:
    小组级接口用于获取本小组下托管账号的数据信息(客户数据、账号信息、成员信息),进而实现大部分的RPA功能(群发、拉群、SOP等),使用小组级接口调用凭证实现接口调用。

    渠道级接口#

    说明:
    渠道级接口用于获取渠道下全部企业的企业数据信息(企业名称、状态、企业token等),使用渠道级接口调用凭证实现接口调用。

    接口架构#


    信息
    渠道级接口数据范围为,该渠道名下所有企业;可以通过获取渠道名下企业的企业级token进行数据获取、功能实现。
    企业级接口数据范围为,该企业下所有小组;可以通企业级token调用相关接口进行数据获取、功能实现。
    小组级接口数据范围为,该小组下所有托管账号;可以通小组级token调用相关接口进行数据获取、功能实现。
    3HqLNM7Ogv.png

    API接口ID信息汇总#

    img_v3_02dv_fa549647-700a-49a9-97ac-60829bf3e7fg_MIDDLE_WEBP.png

    接口ID信息获取途径:#

    unionid#

    参考:unionId打通方案

    externalUserId#

    获取途径:调用接口【获取客户列表】

    ImContactid#

    获取途径:调用接口【获取客户列表】

    chat_id/wecomChatid#

    获取途径:调用接口【获取群列表】

    imRoomId/roomWxid#

    获取途径:
    1.
    调用接口【企业微信群chatid转系统群roomwxid】
    2.
    系统内部获取:
    小组工作台——>群聊列表——>外部群
    img_v3_02a7_31da193e-843e-4dd2-acc4-e7275a39a91g.jpg

    wecomUserId/wxUserId(User_id)#

    获取途径:
    1.
    调用接口:【获取企业成员列表】
    2.
    系统内部获取:
    小组工作台——>托管账号——>托管账号列表
    image.png

    botId#

    获取途径:
    1.
    调用接口:【获取企业内各小组托管账号信息】中的托管账号id
    2.
    系统内部获取:
    小组工作台——>托管账号——>托管账号列表
    image.png

    imBotId#

    获取途径:
    1.
    调用接口:【获取企业内各小组托管账号信息】中的托管账号对应成员的wxid
    2.
    系统内部获取:
    小组工作台——>托管账号——>托管账号列表
    image.png
    下一页
    如何发送一条消息
    Built with