尘锋SCRM开放平台
  1. 收发消息能力
尘锋SCRM开放平台
  • 接入前准备
    • 接口鉴权说明
    • 回调接入指南
    • 报错code码说明
    • 省市区code码
    • 获取附件URL访问签名
    • 更新日志
    • 接口鉴权说明 Copy
  • 对接方案介绍
    • 联系人架构介绍
    • 员工概览
    • ERP打通
    • 客户信息打通
    • 订单打通
    • 微信unionid互通场景
    • 获客助手对接场景
  • API文档
    • 客户
      • 联系人
        • 联系人管理
          • 查询联系人
          • 新增联系人
          • 编辑联系人
          • 删除联系人
          • 编辑联系人状态
          • 获取联系客户统计数据
          • 外部ID
            • 删除联系人外部ID
            • 更新联系人外部ID
            • 绑定外部ID与联系人ID
        • 联系人字段ID
          • 查询联系人自定义字段模板
          • 查询跟进状态列表
          • 查询联系人公海列表
          • 无效&放弃&删除原因查询
          • 联系人类型与标签和自定义字段关联关系
          • 联系人类型
          • 联系人联系方式
          • 多级联选列表
          • 来源
            • 来源列表查询(企业&联系人)
            • 编辑来源
            • 创建来源
        • 标签库
          • 给联系人打标签
          • 好友标签(企业微信标签)
            • 查询好友标签列表
            • 编辑好友标签
            • 新增好友标签
          • 联系人标签
            • 编辑联系人标签值
            • 新增联系人标签组
            • 编辑联系人标签组
            • 新增联系人标签值
            • 查询联系人标签列表
        • 跟进团队
          • 编辑(联系人/企业)共享人
          • 查询创建⼈跟进⼈和共享⼈
        • 跟进提醒
          • 查询跟进提醒
          • 新增跟进提醒
          • 编辑跟进提醒
          • 完成跟进提醒
          • 删除跟进提醒
        • 跟进记录
          • 查询跟进记录
          • 查询跟进记录模板
          • 新增跟进记录
        • 在职继承
          • 分配在职成员联系人
          • 查询接替状态
        • 签到
          • 查询签到记录
        • 行为轨迹
          • 轨迹参数说明
          • 上报轨迹事件
          • 查询轨迹事件
          • 查询旅程项目
      • 企业
        • 企业字段ID
          • 查询企业字段ID
          • 查询企业跟进状态
          • 查询企业公海列表
          • 来源列表查询(企业&联系人)
          • 查询企业类型
          • 查询企业删除原因
          • 查询多级联选
        • 企业管理
          • 查询企业列表
          • 新增企业
          • 编辑企业
          • 删除企业
          • 企业绑定联系人
          • 更新企业跟进人
          • 放弃企业到公海
          • 分配公海中企业
        • 企业标签
          • 查询企业标签
      • 好友
        • 查询好友列表
        • 编辑好友信息
        • 好友关联联系人
        • 好友取消关联联系人
        • unionId上传&关联externalUserId
      • 客户群
        • 查询客户群列表
        • 查询客户群详情
        • 编辑客户群标签
        • 查询群标签列表
        • 查询群聊数据统计-按群主聚合方式
        • 查询群聊数据统计-按自然日聚合方式
    • 销售机会
      • 销售机会管理
        • 查询销售机会列表
        • 新增销售机会
        • 编辑销售机会
        • 删除销售机会
        • 新增销售机会协同人
        • 移除销售机会协同人
        • 销售机会绑定订单
        • 销售机会解绑订单
        • 销售机会阶段变更记录
      • 销售机会字段ID
        • 查询销售机会字段ID
        • 查询销售机会类型
        • 查询销售机会阶段
        • 查询协同角色ID
        • 查询竞争对手
        • 查询丢单原因
        • 查询销售机会多级联选选项
        • 修改销售机会多级联选选项
    • 交易
      • 订单
        • 查询订单列表
        • 新增&编辑订单
        • 查询订单自定义字段ID
        • 修改订单归属人/归属部门
        • 订单发货
        • 查询物流公司列表
        • 查询订单来源
        • 编辑自主下单
      • 售后单
        • 查询售后单列表
        • 创建售后单
        • 售后单操作退款
      • 回款单
        • 查询回款单列表
        • 创建回款单
      • 会员积分
        • 查询会员列表
        • 新增会员
        • 变更会员等级
        • 查询会员等级变更明细
        • 变更会员积分
        • 变更会员成长值
        • 查询会员积分变更明细
        • 使用会员积分
      • 商品类
        • 查询商品列表
        • 查询商品详情
        • 新增商品
        • 商品图片/视频上传
        • 编辑商品库存
    • 员工
      • 查询员工信息
      • 编辑员工信息
      • 部门信息查询
      • 批量为员工启用系统
      • 给员工发送企微通知
    • 预约单
      • 查询预约列表
    • 评论
      • 查询评论列表接口
    • 运营
      • 活码
        • 查询活码详情
        • 查询活码列表
      • 表单
        • 查询表单字段模板
        • 查询表单填写内容
      • sop
        • 查询sop列表
        • 查询sop执行情况列表
      • 素材
        • 查询素材列表
        • 查询素材详情
        • 查询员工发送素材明细
      • 营销任务
        • 查询营销任务执行情况
        • 查询营销任务列表
      • 朋友圈
        • 获取企业发布的朋友圈员工执行情况
        • 获取朋友圈的互动数据
        • 获取企业全部发布列表
      • 获客助手短链
        • 查询获客助手来源及链接信息
        • 查询获客助手配置列表
        • 获取专属短链详情列表
        • 生成用户专属短链接
    • 会话存档
      • 上传会话存档记录
    • 通话短信
      • 查询通话记录列表
      • 电销手机外呼
      • 查询通话录音转文字结果
      • 查询短信记录列表
    • 页面嵌入
      • 页面嵌入配置说明
      • 解密嵌入页面传参
      • 菜单嵌入说明
    • 应用
      • 楼盘管理
        • 查询楼盘
        • 新增楼盘
        • 删除楼盘
      • 外联盟管理
        • 查询外联盟
        • 新增外联盟
        • 编辑外联盟
        • 删除外联盟
        • 启停用外联盟
        • 查询外联盟字段ID
        • 外联盟多级联选选项
  • 事件推送
    • 联系人
      • 新增联系人事件
      • 编辑联系人事件
      • 联系人跟进状态变更事件
      • 删除联系人事件
      • 联系人合并事件
      • 跟进提醒
        • 联系人跟进提醒状态变更
      • 联系人流转
        • 跟进团队变更事件
        • 联系人流转事件
      • 跟进记录
        • 跟进记录操作事件
    • 好友
      • 添加好友事件
      • 好友与联系人绑定事件
      • 好友与联系人解绑事件
      • 好友主动删除员工事件
      • 员工主动删除好友事件
      • 更新好友信息事件
    • 客户群
      • 新增客户群事件
      • 变更客户群事件
      • 解散客户群事件
    • 销售机会
      • 销售机会负责人变更
      • 销售机会协同人变更
      • 销售机会操作事件
    • 企业
      • 企业跟进团队流转事件
      • 企业新增事件
      • 编辑企业事件
      • 企业跟进状态变更事件
      • 企业删除事件
    • 交易
      • 推送说明
      • 订单
        • 新增订单事件
        • 编辑订单事件
        • 订单状态变更事件
        • 订单支付完成事件
        • 删除订单事件
      • 售后单
        • 售后单创建事件
        • 编辑售后单事件
        • 售后单状态变更事件
        • 删除售后单事件
        • 售后单退款成功事件
      • 商品
        • 新增商品事件
        • 商品库存变更事件
        • 编辑商品事件
        • 商品状态变更事件
      • 会员积分
        • 新增会员事件
        • 会员合并事件
        • 成长值变更事件
        • 会员等级变更事件
        • 会员积分变更事件
    • 工单
      • 新增工单事件
      • 流转工单事件
      • 编辑工单事件
    • 运营
      • 提交表单事件
    • 通话短信
      • 通话记录操作事件
      • 短信记录操作事件
    • 预约单
      • 新增预约单事件
    • 应用
      • 楼盘
        • 新增楼盘事件
        • 编辑楼盘事件
        • 删除楼盘事件
      • 外联盟
        • 新增外联盟事件
        • 编辑外联盟事件
        • 删除外联盟事件
        • 启/停外联盟事件
        • 外联盟审批完成事件
  • AIagent
    • 接入说明
      • agent接口鉴权
      • agent回调接入说明
    • 收发消息能力
      • 会话消息事件
      • 回复消息接口
      • 主动发送消息接口
      • AI消息发送结果事件
    • 在线客服对接
      • 会话转人工
      • 发送消息
      • 消息推送事件
      • 获取访客信息
  1. 收发消息能力

主动发送消息接口

接口说明#

通过企微员工ID(qwUserId)批量发送消息到指定的好友或群。支持一次发送给多个目标(最多100个)

接口信息#

POST https://qw-openapi-tx.dustess.com/ai/v1/agent/msg/directSendMsg?accessToken=

Content-Type: application/json

请求参数#

请求参数名类型说明是否必须
scrmAccountIDstringSCRM账号ID,如:W00000000516true
qwUserIdstring企微员工ID(需要先对该员工进行授权),如:wonBvEDAAA9lHv80telxLj_YHPC6gDXAtrue
targetTypestring目标类型。"single"=单聊,"group"=群聊true
targetIds[]string目标外部ID列表(好友ExternalUserId或群groupId),最多100个true
messages[]object消息列表true
messages.msgTypeint32消息类型。0=文本,1=图片,2=语音,3=文件,4=视频,6=地理位置,9=链接消息,10=小程序消息true
messages.contentstring消息内容(文本消息使用)false
messages.fileURLstring资源地址(图片、语音、文件、视频等类型消息必填)false
messages.contents[]string特殊消息内容(位置、链接、小程序消息使用)false
messages.replyMsgID[]int64被回复的消息ID数组false

消息格式说明#

普通消息#

文本消息#

{
  "msgType": 0,
  "content": "你好,这是一条主动发送的消息"
}

带@群内员工的文本消息#


{
  "msgType": 0,
  "content": "@#客服# 你好,这是一条主动发送的消息" // 需要@群成员时,使用 @#xx# 包住@对象的名字,可以是全名或前缀,会自动根据群成员名称进行匹配@
}

图片消息#

{
  "msgType": 1,
  "fileURL": "https://example.com/image.png"
}

语音消息#

{
  "msgType": 2,
  "fileURL": "https://example.com/voice.amr"
}

文件消息#

{
  "msgType": 3,
  "fileURL": "https://example.com/file.pdf"
}

视频消息#

{
  "msgType": 4,
  "fileURL": "https://example.com/video.mp4"
}

特殊消息格式(使用contents)#

特殊消息格式需要将序列化的JSON字符串放在contents中,只取第一个值

位置消息#

{
  "msgType": 6,
  "contents": [
    "{\"address\":\"福建省厦门市集美区侨英街道龙荷二里万科云城15-38号\",\"latitude\":24.604396,\"longitude\":118.078909,\"name\":\"微风乐集·听风的歌(万科云城店)\",\"precision\":0.0}"
  ]
}

链接消息#

{
  "msgType": 9,
  "contents": [
    "{\"desc\":\"百度\",\"thumbUrl\":\"https://picx.zhimg.com/v2-d6f44389971daab7e688e5b37046e4e4_720w.jpg?source=172ae18b\",\"title\":\"百度首页\",\"url\":\"https://www.baidu.com\"}"
  ]
}

小程序消息#

参数说明
参数名类型说明是否必填
appNamestring小程序名称true
appidstring小程序IDtrue
pagePathstring页面地址true
thumbUrlstring封面图true
thumbWidthint封面图宽度false
titlestring标题true
typeint类型标识,固定为2true
usernamestring小程序原始ID,必须带有@app后缀true
weappIconUrlstring小程序logotrue
schemastringschema地址,rpa通道必填视通道而定
descstring描述信息false
示例
{
  "msgType": 10,
  "contents": [
    "{\"appName\":\"成都地铁乘车码\",\"appid\":\"wx1b5e2763b9c1e06e\",\"desc\":\"成都地铁乘车码\",\"pagePath\":\"pages/index/index.html\",\"thumbUrl\":\"https://xxx.jpg\",\"thumbWidth\":720,\"title\":\"成都地铁乘车码\",\"type\":2,\"username\":\"gh_27bdf69a27bb@app\",\"weappIconUrl\":\"http://mmbiz.qpic.cn/mmbiz_png/vOGI97uF6r4Oz6aeWdPLgP7D34XiaNaHz7iadb8dc4YE69BqmUsmUIovF8vdAibMnhvpg7Yk1S4yqRzhzYAsjuwiaA/640?wx_fmt=png\\u0026wxfrom=200\",\"schema\":\"weixin://dl/business/?t=xxxxx\"}"
  ]
}

完整请求参数示例:批量发送给多个好友#

{
  "scrmAccountID": "W00000000516",
  "qwUserId": "wonBvEDAAA9lHv80telxLj_YHPC6gDXA",
  "targetType": "single",
  "targetIds": [
    "wmnBvEDAAATUrpUTt5f0RXe-8Iemwqpg",
    "wmnBvEDAAATUrpUTt5f0RXe-8Iemwqph",
    "wmnBvEDAAATUrpUTt5f0RXe-8Iemwqpi"
  ],
  "messages": [
    {
      "msgType": 0,
      "content": "群发消息内容"
    }
  ]
}

响应参数#

响应参数名类型说明
statusint32整体发送状态。0=全部成功,1=部分成功,2=全部失败
totalCountint32总目标数
successCountint32成功发送的目标数
failCountint32失败的目标数
results[]object每个目标的详细发送结果
results.targetIdstring原始传入的目标外部ID
results.successbool该目标是否发送成功
results.errorCodestring错误码(失败时返回,用于判断失败原因类型)

成功响应示例#

全部成功#

{
  "status": 0,
  "totalCount": 1,
  "successCount": 1,
  "failCount": 0,
  "results": [
    {
      "targetId": "wmnBvEDAAATUrpUTt5f0RXe-8Iemwqpg",
      "success": true,
      "errorCode": ""
    }
  ]
}

部分成功#

{
  "status": 1,
  "totalCount": 3,
  "successCount": 2,
  "failCount": 1,
  "results": [
    {
      "targetId": "target_id_1",
      "success": true,
      "errorCode": ""
    },
    {
      "targetId": "target_id_2",
      "success": false,
      "errorCode": "TARGET_NOT_FOUND"
    },
    {
      "targetId": "target_id_3",
      "success": true,
      "errorCode": ""
    }
  ]
}

错误码说明#

错误码说明处理建议
USER_NOT_FOUND未找到对应的员工检查qwUserId是否正确
TARGET_NOT_FOUND未找到对应的目标好友/群检查targetId是否正确,确认好友关系是否存在
CHAT_NOT_FOUND未找到对应的会话确认会话是否存在
SEND_FAILED消息发送失败查看服务端日志排查具体原因
INVALID_MESSAGE消息格式非法检查消息内容格式是否符合要求
CHANNEL_NOT_SUPPORT不支持的渠道类型当前仅支持企微会话存档和ecom渠道
INVALID_TARGET_TYPE目标类型非法targetType仅支持"single"或"group"
EMPTY_TARGETS目标列表不能为空targetIds至少传入一个
EMPTY_MESSAGES消息列表不能为空messages至少传入一条消息
INVALID_ACCOUNT_IDscrmAccountID不能为空必须传入有效的账号ID
INVALID_QW_USER_IDqwUserId不能为空必须传入有效的企微员工ID
TOO_MANY_TARGETS目标数量超过限制单次请求最多支持100个目标

使用限制#

1.
目标数量限制:单次请求最多100个目标
2.
目标类型一致:同一次请求中,所有目标必须是同一类型(要么都是单聊,要么都是群聊)
3.
员工唯一:每次请求只能指定一个发送员工
4.
不支持的消息类型:不支持@消息、引用消息、系统消息、撤回消息等特殊类型
5.
并发发送:多个目标会并发发送,某个目标失败不影响其他目标
修改于 2025-10-21 04:00:44
上一页
回复消息接口
下一页
AI消息发送结果事件
Built with