API接口文档 (小组级)
  1. 快速入门
API接口文档 (小组级)
  • 接入说明
  • 快速入门
    • 加密手机号加好友方案
    • 加密版接口
    • 如何发送一条消息
    • 通过接口实现群发
    • 加密externalUserId打通方案
    • unionId打通方案
  • 接口文档
    • 小组级接口
      • 小组级接口说明
      • 基础接口
        • 获取托管企业微信列表
        • 获取个人微信授权到期及首次扫码登录的时间
        • 获取联系人列表
        • 获取群列表
        • 获取群列表(不包含成员信息)
        • 发送系统通知
        • 获取自定义标签列表
        • 获取组内员工列表
      • 群聊接口
        • 加入群聊
        • 退出群聊事件回调
        • 加入群聊事件回调
        • 更改群名事件回调
        • 创建群聊
        • 通过联系人id获取联系人所在群聊
      • 会话接口
        • 开发建议
        • 获取指定会话
        • 获取会话列表
        • 会话事件回调
        • 分配会话
        • 消息置顶
      • 加好友接口
        • 通过手机号加好友接口
        • 加好友任务成功回调
        • 好友通过后回调
        • 群聊加好友接口
      • 消息接口
        • 获取原图
        • 发送消息
        • 小组级接收消息回调
        • 聊天历史
        • 企微id发消息
      • 群发接口
        • 创建群发
        • 创建群发 Copy
        • 重发群发
        • 取消群发
        • 删除群发
        • 群发回调
        • 获取群发任务的失败列表
        • 获取群发任务的没有发送的列表
        • 获取群发任务的进度
    • 自建应用依赖接口
      • 自建应用依赖接口说明
      • 客户信息接口
        • 修改客户备注
        • 添加跟进记录
      • 雷达接口
        • 雷达访问接口
      • id信息获取接口
        • 获取chatId
        • 通过unionId获取chatId
    • 废弃接口
      • 会话小结
      • 渠道二维码管理
        • 获取渠道列表(企业控制台数据)
      • 通过企微id群聊加好友
      • 新增客户
      • 获取成员详情
      • 获取客户列表(2023/12/05 废弃)
      • 秒回数据同步
      • 获取群列表
      • 获取客户详情
      • 获取群信息
      • 绑定企业微信官方ID
      • 通过externalUserId获取chatId
      • 获取群列表(2023/2/05 废弃)
  • 更新日志
    • 更新日志
  1. 快速入门

如何发送一条消息

提示
本系统是一款可以帮助您集中管理多个托管账号 进行高效运营的SaaS软件系统。
该系统功能丰富,包括但不限于批量加好友、打标签、定时群发、自动回复等。
在可视化界面之外,我们开放了丰富的API接口供您进行自动化调用。
当您需要调用API接口(而非可视化界面)来管理您所在企业的托管账号时,您需要仔细阅读此文档。
现在,让我们从一个简单的例子【给好友或群聊发送一条消息】开始 快速入门,以下是操作步骤,请仔细阅读。

准备工作#

1.注册并创建企业#

参照本文档中【创建者必看】进行操作

2.登录托管账号#

参照本文档中【使用者必看-1.登录】
参照本文档中【使用者必看-2.进行账号托管】

3.查看接口文档#

该接口在接口文档中企业级接口内部的【发送消息接口】位置
img_v3_029e_f81a15d8-67ce-46db-93a4-a9b5de716d3g.jpg

4.获取必要前置参数#

4.1 token获取方法
登录企业控制台,找到数据打通模块中的API接入,点击复制API设置中的token值就可以成功获取该参数了。
G7jDmnxYif.jpg
4.2 externalRequestId
该字段为发送消息的自定义请求id,由您自定义,会在回调中原样带回该字段,需要保证唯一。
4.3 imBotId、imContactId 获取方法
调用【获取客户列表】接口,可在返回值获取参数 imBotId、imContactId。
imBotId:托管账号对应成员的系统wxid
imContactId:外部联系人id
4.4 imRoomId 获取方式
首先调用【获取群列表】接口,调用成功后该接口将返回参数wecomChatId,成功获取wecomChatId参数后接着调用【企业微信群chatid转系统群roomwxid】接口,成功调用后将返回wxid(roomwxid)。
imRoomId:群聊的系统wxid
【注】该字段为非必要字段,当您需要通过发送群聊消息来触达特定群聊或人员时需要加入此参数。若仅希望通过单聊信息进行触达,则该字段不用添加。
4.5 messageType
参照接口文档,该参数为发送消息类型。
您可以自行选择需要的类型进行发送,在这里我们发送一条文本【群发123456789】,试试看~

调用接口#

当您成功获取上述必要字段后,并且保证托管账号在线的情况下,就可以进行该接口的调用了,在成功调用该接口后应该注意接口的返回代码与托管账号是否执行该动作。

1.返回代码errcode#

0: 成功 1: token不正确 2: 参数验证不通过 6: 没有发送权限 -2: 没有找到bot -3: 找到了多个bot

2.执行结果#

当该接口调用成功后,接口将会向您返回errcode:0,而托管账号此时将向指定用户或群聊 发送一条【群发123456789】的文本消息(如图),您可在手机端查看和验证~
BfMByeTk68.jpg
上一页
加密版接口
下一页
通过接口实现群发
Built with