1. api快速入门
系统使用说明
  • api模块
    • api接入说明
    • api快速入门
      • 如何发送一条消息
      • 通过接口实现群发
      • 加密externalUserId打通方案
      • unionId打通方案
      • 企业级API消息回调签名说明
      • 获取externalUserId和wecomChatid
      • 加密手机号加好友方案
      • 加密版接口
    • api最佳实践
      • 联系人群聊相关最佳实践
      • 消息相关最佳实践
      • AI 课程助手
  • 使用指南
    • 使用指南
      • 如何获取小程序参数
      • 配置报警机器人流程
      • 飞书报警检测配置教程
      • 企微报警机器人配置教程
      • 客户联系权限配置方法
      • 异地登录助手
    • 多IM托管说明
      • 飞书 托管说明
      • 钉钉 托管说明
      • Instagram 托管说明
      • 小红书 托管说明
      • 微信小店 托管说明
  1. api快速入门

如何发送一条消息

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

准备工作#

1.注册并创建企业#

2.登录托管账号#

3.查看接口文档#

该接口在接口文档中企业级接口内部的【发送消息接口】位置

4.获取必要前置参数#

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

调用接口#

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

1.返回代码errcode#

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

2.执行结果#

当该接口调用成功后,接口将会向您返回errcode:0,而托管账号此时将向指定用户或群聊 发送一条【群发123456789】的文本消息,您可在手机端查看和验证~
修改于 2025-10-11 09:21:30
上一页
api接入说明
下一页
通过接口实现群发
Built with