Developer OpenAPI
首页Apifox官网钉钉openAPI
企业微信openAPI
  • openAPI文档
  • 官方文档
首页Apifox官网钉钉openAPI
企业微信openAPI
  • openAPI文档
  • 官方文档
企业内部开发智慧硬件开发第三方应用开发
企业内部开发智慧硬件开发第三方应用开发
  1. 会话分配与消息收发
  • 通讯录管理
    • 成员管理
      • 手机号获取userid
      • 获取成员授权列表
      • 查询成员用户是否已授权
      • 获取选人ticket对应的用户
    • 异步导出接口
      • 导出成员
      • 导出成员详情
      • 导出部门
      • 导出标签成员
      • 获取导出结果
    • 通讯录搜索
      • 通讯录搜索-通讯录单个搜索
      • 通讯录搜索-通讯录批量搜索
    • 通讯录ID转译
      • 上传需要转译的文件
      • 异步通讯录id转译
      • 获取异步任务结果
    • 通讯录userid排序
      POST
  • 客户联系
    • 企业服务人员管理
      • 获取配置了客户联系功能的成员列表
      • 客户联系「联系我」管理-更新企业已配置的「联系我」方式
      • 客户联系「联系我」管理-获取企业已配置的「联系我」方式
      • 客户联系「联系我」管理-删除企业已配置的「联系我」方式
      • 客户联系「联系我」管理-结束临时会话
    • 客户管理
      • 获取客户列表
      • 修改客户备注信息
      • 批量获取客户详情
      • 外部联系人unionid转换
      • 代开发应用external_userid转换
    • 客户标签管理
      • 管理企业标签
        • 管理企业标签-获取企业标签库
        • 管理企业标签-添加企业客户标签
        • 管理企业标签-编辑企业客户标签
        • 管理企业标签-删除企业客户标签
      • 编辑客户企业标签
    • 在职继承
      • 分配在职成员的客户
      • 查询客户接替状态
    • 离职继承
      • 获取待分配的离职成员列表
      • 分配离职成员的客户
      • 查询客户接替状态
      • 分配离职成员的客户群
    • 客户群管理
      • 获取客户群列表
      • 获取客户群详情
      • 客户群opengid转换
    • 客户朋友圈
      • 企业发表内容到客户的朋友圈
        • 企业发表内容到客户的朋友圈-创建发表任务
        • 企业发表内容到客户的朋友圈-获取任务创建结果
      • 获取客户朋友圈全部的发表记录
        • 获取客户朋友圈全部的发表记录-获取企业全部的发表列表
        • 获取客户朋友圈全部的发表记录-获取客户朋友圈企业发表的列表
        • 获取客户朋友圈全部的发表记录-获取客户朋友圈发表时选择的可见范围
        • 获取客户朋友圈全部的发表记录-获取客户朋友圈发表后的可见客户列表
        • 获取客户朋友圈全部的发表记录-获取客户朋友圈的互动数据
    • 消息推送
      • 获取企业的全部群发记录
        • 获取企业的全部群发记录-获取群发记录列表
        • 获取企业的全部群发记录-获取群发成员发送任务列表
        • 获取企业的全部群发记录-获取企业群发成员执行结果
      • 创建企业群发
      • 发送新客户欢迎语
      • 入群欢迎语素材管理-添加
      • 入群欢迎语素材管理-编辑
      • 入群欢迎语素材管理-获取
      • 入群欢迎语素材管理-删除
    • 统计管理
      • 获取「群聊数据统计」数据-按群主聚合的方式
      • 获取「群聊数据统计」数据-按自然日聚合的方式
      • 获取「联系客户统计」数据
    • 管理商品图册
      • 创建商品图册
      • 获取商品图册
      • 删除商品图册
      • 获取商品图册列表
      • 编辑商品图册
    • 管理聊天敏感词
      • 管理聊天敏感词-新建敏感词规则
      • 管理聊天敏感词-获取敏感词规则列表
      • 管理聊天敏感词-获取敏感词规则详情
      • 管理聊天敏感词-修改敏感词规则
      • 管理聊天敏感词 删除敏感词规则
    • 上传附件资源
      POST
  • 家校沟通
    • 基础接口
      • 获取外部联系人详情
      • 发送「学校通知」
      • 获取「学校通知」二维码
      • 管理「学校通知」的关注模式-设置关注「学校通知」的模式
      • 管理「学校通知」的关注模式-获取关注「学校通知」的模式
      • 外部联系人openid转换
      • 获取可使用的家长范围
      • 手机号转外部联系人ID
      • 管理「老师可查看班级」模式-设置「老师可查看班级」的模式
      • 管理「老师可查看班级」模式-获取「老师可查看班级」的模式
    • 学生与家长管理
      • 创建学生
      • 删除学生
      • 更新学生
      • 批量创建学生
      • 批量删除学生
      • 批量更新学生
      • 创建家长
      • 删除家长
      • 更新家长
      • 批量创建家长
      • 批量删除家长
      • 批量更新家长
      • 读取学生或家长
      • 获取部门成员详情
      • 设置家校通讯录自动同步模式
      • 获取部门家长详情
    • 部门管理
      • 创建部门
      • 更新部门
      • 删除部门
      • 获取部门列表
      • 修改自动升年级的配置
  • 微信客服
    • 客服帐号管理
      • 添加客服帐号
      • 删除客服帐号
      • 修改客服帐号
      • 获取客服帐号列表
      • 获取客服帐号链接
    • 接待人员管理
      • 删除接待人员
      • 获取接待人员列表
    • 会话分配与消息收发
      • 分配客服会话
        • 分配客服会话-获取会话状态
        • 分配客服会话-变更会话状态
      • 接收消息和事件-读取消息
        POST
      • 发送消息
        POST
      • 发送欢迎语等事件响应消息
        POST
    • 「升级服务」配置
      • 「升级服务」配置-获取配置的专员与客户群
      • 「升级服务」配置-为客户升级为客户群服务
      • 「升级服务」配置-为客户取消推荐
    • 其他基础信息获取
      • 获取客户基础信息
      • 获取企业状态信息-获取视频号绑定状态
  • 应用管理
    • 设置工作台自定义展示
      • 设置工作台自定义展示-设置应用在工作台展示的模版
      • 设置工作台自定义展示-获取应用在工作台展示的模版
      • 设置工作台自定义展示-设置应用在用户工作台展示的数据
  • 消息推送
    • 撤回应用消息
  • OA
    • 打卡
      • 获取员工打卡规则
      • 获取打卡记录数据
      • 获取打卡日报数据
      • 获取打卡月报数据
      • 获取打卡人员排班信息
      • 为打卡人员排班
      • 获取设备打卡数据
    • 审批
      • 获取审批模板详情
      • 提交审批申请
      • 批量获取审批单号
      • 获取审批申请详情
      • 获取企业假期管理配置
      • 获取成员假期余额
      • 修改成员假期余额
      • 复制/更新模板到企业
  • 效率工具
    • 日程
      • 日历接口
        • 日历接口 创建日历
        • 日历接口 更新日历
        • 日历接口 获取日历详情
        • 日历接口 删除日历
      • 日程接口
        • 日程接口 创建日程
        • 日程接口更新日程
        • 日程接口 获取日程详情
        • 日程接口 取消日程
        • 日程接口 获取日历下的日程列表
    • 会议
      • 创建预约会议
      • 修改预约会议
      • 取消预约会议
      • 获取成员会议ID列表
      • 获取会议详情
    • 直播
      • 创建预约直播
      • 修改预约直播
      • 取消预约直播
      • 在微信中观看直播或直播回放
      • 获取直播详情
      • 获取直播观看明细
      • 获取跳转小程序商城的直播观众信息
  • 家校应用
    • 上课直播
      • 删除直播回放
      • 获取老师直播ID列表
      • 获取直播详情
      • 获取观看直播统计
      • 获取未观看直播统计
    • 班级收款
      • 获取学生付款结果
      • 获取订单详情
  • 企业支付
    • 对外收款
      • 获取对外收款记录
  • 企业互联
    • 获取应用共享信息
  • 上下游
    • 获取应用共享信息
  • 开发指南
    • 企业微信账号ID安全性全面升级
      • 一、企业corpid的升级方案
        • 1.4 corpid转换
      • 二、企业员工userid的升级方案
        • 2.4 userid的转换
      • 三、企业员工external_userid的升级方案
        • 转换external_userid
        • 设置迁移完成
      • 四、企业客户微信unionid的升级方案
        • 4.2 unionid查询external_userid
  • 自建应用代开发
    • 获取带参授权链接
  1. 会话分配与消息收发

发送消息

POST
http://127.0.0.1/cgi-bin/kf/send_msg
第三方应用开发/微信客服/会话分配与消息收发
最后修改时间:2022-08-30 03:03:37
责任人:未设置

概述#

当微信客户处于“新接入待处理”或“由智能助手接待”状态下,可调用该接口给用户发送消息。
注意仅当微信客户在主动发送消息给客服后的48小时内,企业可发送消息给客户,最多可发送5条消息;若用户继续发送消息,企业可再次下发消息。
支持发送消息类型:文本、图片、语音、视频、文件、图文、小程序、菜单消息、地理位置。
目前该接口允许下发消息条数和下发时限如下:
用户动作允许下发条数限制下发时限
用户发送消息5条48 小时
权限说明:
企业需要使用“微信客服”secret所获取的accesstoken来调用(accesstoken如何获取?)
第三方应用需具有“微信客服权限->管理帐号、分配会话和收发消息”权限

消息类型#

文本消息#

请求示例:
{   "touser" : "EXTERNAL_USERID",   "open_kfid": "OPEN_KFID",   "msgid": "MSGID",   "msgtype" : "text",   "text" : {       "content" : "你购买的物品已发货,可点击链接查看物流状态http://work.weixin.qq.com/xxxxxx"   }}
参数说明:
参数是否必须类型说明
touser是string指定接收消息的客户UserID
open_kfid是string指定发送消息的客服帐号ID
msgid否string指定消息ID
msgtype是string消息类型,此时固定为:text
text是obj文本消息
text.content是string消息内容,最长不超过2048个字节

图片消息#

请求示例:
{   "touser" : "EXTERNAL_USERID",   "open_kfid": "OPEN_KFID",   "msgid": "MSGID",   "msgtype" : "image",   "image" : {        "media_id" : "MEDIA_ID"   }}
请求参数:
参数是否必须类型说明
touser是string指定接收消息的客户UserID
open_kfid是string指定发送消息的客服帐号ID
msgid否string指定消息ID
msgtype是string消息类型,此时固定为:image
image是obj图片消息
image.media_id是string图片文件id,可以调用上传临时素材接口获取

语音消息#

请求示例:
{   "touser" : "EXTERNAL_USERID",   "open_kfid": "OPEN_KFID",   "msgtype" : "voice",   "voice" : {        "media_id" : "MEDIA_ID"   }}
参数说明:
参数是否必须类型说明
touser是string指定接收消息的客户UserID
open_kfid是string指定发送消息的客服帐号ID
msgid否string指定消息ID
msgtype是string消息类型,此时固定为:voice
voice是obj语音消息
voice.media_id是string语音文件id,可以调用上传临时素材接口获取

视频消息#

请求示例:
{   "touser" : "EXTERNAL_USERID",   "open_kfid": "OPEN_KFID",   "msgid": "MSGID",   "msgtype" : "video",   "video" : {        "media_id" : "MEDIA_ID"   }}
参数说明:
参数是否必须类型说明
touser是string指定接收消息的客户UserID
open_kfid是string指定发送消息的客服帐号ID
msgid否string指定消息ID
msgtype是string消息类型,此时固定为:video
video是obj视频消息
video.media_id是string视频媒体文件id,可以调用上传临时素材接口获取
视频消息展现:
img

文件消息#

请求示例:
{   "touser" : "EXTERNAL_USERID",   "open_kfid": "OPEN_KFID",   "msgid": "MSGID",   "msgtype" : "file",   "file" : {        "media_id" : "1Yv-zXfHjSjU-7LH-GwtYqDGS-zz6w22KmWAT5COgP7o"   }}
参数说明:
参数是否必须类型说明
touser是string指定接收消息的客户UserID
open_kfid是string指定发送消息的客服帐号ID
msgid否string指定消息ID
msgtype是string消息类型,此时固定为:file
file是obj文件消息
file.media_id是string文件id,可以调用上传临时素材接口获取
文件消息展现:
img

图文链接消息#

请求示例:
{   "touser" : "EXTERNAL_USERID",   "open_kfid": "OPEN_KFID",   "msgid": "MSGID",   "msgtype" : "link",   "link" :   {           "title" : "企业如何增长?企业微信给出3个答案",           "desc" : "今年中秋节公司有豪礼相送",           "url" : "URL",           "thumb_media_id": "MEDIA_ID"   }}
参数说明:
参数是否必须类型说明
touser是string指定接收消息的客户UserID
open_kfid是string指定发送消息的客服帐号ID
msgid否string指定消息ID
msgtype是string消息类型,此时固定为:link
link是obj链接消息
link.title是string标题,不超过128个字节,超过会自动截断
link.desc否string描述,不超过512个字节,超过会自动截断
link.url是string点击后跳转的链接。 最长2048字节,请确保包含了协议头(http/https)
link.thumb_media_id是string缩略图的media_id, 可以通过素材管理接口获得。此处thumb_media_id即上传接口返回的media_id
图文链接消息展现:
img

小程序消息#

请求示例:
{   "touser" : "EXTERNAL_USERID",   "open_kfid": "OPEN_KFID",   "msgid": "MSGID",   "msgtype" : "miniprogram"   "miniprogram" : {       "appid": "APPID",       "title": "欢迎报名夏令营",       "thumb_media_id": "MEDIA_ID",       "pagepath": "PAGE_PATH"   }}
参数说明:
参数是否必须类型说明
touser是string指定接收消息的客户UserID
open_kfid是string指定发送消息的客服帐号ID
msgid否string指定消息ID
msgtype是string消息类型,此时固定为:miniprogram
miniprogram是obj小程序消息
miniprogram.appid是string小程序appid
miniprogram.title否string小程序消息标题,最多64个字节,超过会自动截断
miniprogram.thumb_media_id是string小程序消息封面的mediaid,封面图建议尺寸为520*416
miniprogram.pagepath是string点击消息卡片后进入的小程序页面路径。注意路径要以.html为后缀,否则在微信中打开会提示找不到页面

菜单消息#

请求示例:
{  "touser": "EXTERNAL_USERID",  "open_kfid": "OPEN_KFID",  "msgid": "MSGID",  "msgtype": "msgmenu",  "msgmenu": {    "head_content": "您对本次服务是否满意呢? ",    "list": [      {        "type": "click",        "click":        {            "id": "101",            "content": "满意"        }      },      {        "type": "click",        "click":        {            "id": "102",            "content": "不满意"        }      },      {        "type": "view",        "view":        {            "url": "https://work.weixin.qq.com",            "content": "点击跳转到自助查询页面"        }      },      {        "type": "miniprogram",        "miniprogram":        {            "appid": "wx123123123123123",            "pagepath": "pages/index?userid=zhangsan&orderid=123123123",            "content": "点击打开小程序查询更多"        }      }    ],    "tail_content": "欢迎再次光临"  }}
参数说明:
参数必须类型说明
touser是string指定接收消息的客户UserID
open_kfid是string指定发送消息的客服帐号ID
msgid否string指定消息ID
msgtype是string消息类型,此时固定为:msgmenu
msgmenu是obj菜单消息
msgmenu.head_content否string起始文本 不多于1024字节
msgmenu.list否obj[]菜单项配置
msgmenu.list.type是string菜单类型。 click-回复菜单 view-超链接菜单 miniprogram-小程序菜单
msgmenu.list.click否objtype为click的菜单项
msgmenu.list.click.id否string菜单ID。 不少于1字节 不多于64字节
msgmenu.list.click.content是string菜单显示内容 不少于1字节 不多于128字节
msgmenu.list.view否objtype为view的菜单项
msgmenu.list.view.url是string点击后跳转的链接。 不少于1字节 不多于2048字节
msgmenu.list.view.content是string菜单显示内容。 不少于1字节 不多于1024字节
msgmenu.list.miniprogram否objtype为miniprogram的菜单项
msgmenu.list.miniprogram.appid是string小程序appid。 不少于1字节 不多于32字节
msgmenu.list.miniprogram.pagepath是string点击后进入的小程序页面。 不少于1字节 不多于1024字节
msgmenu.list.miniprogram.content是string菜单显示内容。 不多于1024字节
msgmenu.tail_content否string结束文本 不多于1024字节
其中,“满意”和“不满意”两个菜单当用户点击后,用户会自动回复一条文本消息,同时附带对应的菜单ID。
菜单消息展现:
img

地理位置消息#

请求示例:
{   "touser" : "EXTERNAL_USERID",   "open_kfid": "OPEN_KFID",   "msgid": "MSGID",   "msgtype" : "location",   "location": {            "name": "测试小区",            "address": "实例小区,不真实存在,经纬度无意义",            "latitude": 0,            "longitude": 0    }}
参数说明:
参数是否必须类型说明
touser是string指定接收消息的客户UserID
open_kfid是string指定发送消息的客服帐号ID
msgid否string指定消息ID
msgtype是string消息类型,此时固定为:location
location是obj地理位置消息
location.name否string位置名
location.address否string地址详情说明
location.latitude是float纬度,浮点数,范围为90 ~ -90
location.longitude是float经度,浮点数,范围为180 ~ -180
权限说明:
企业需要使用“微信客服”secret所获取的accesstoken来调用(accesstoken如何获取?)
第三方应用需具有“微信客服权限->管理帐号、分配会话和收发消息”权限
文档ID: 31152
原文档地址:
https://open.work.weixin.qq.com/api/doc/90000/90135/94677
https://open.work.weixin.qq.com/api/doc/90001/90143/94700

请求参数

Query 参数
access_token
string 
调用接口凭证
必需
示例值:
{{accesstoken}}
Body 参数application/json
可选
One of
msgtype
string 
必需
消息类型,此时固定为:text
text
object 
文本消息
必需
示例
{
  "msgtype": "string",
  "text": {
    "content": "string",
    "menu_id": "string"
  }
}

示例代码

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 'http://127.0.0.1/cgi-bin/kf/send_msg?access_token={{accesstoken}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "msgtype": "string",
    "text": {
        "content": "string",
        "menu_id": "string"
    }
}'

返回响应

🟢200成功
application/json
Body
errcode
integer <int32>
可选
errmsg
string 
可选
msgid
string 
可选
消息ID。如果请求参数指定了msgid,则原样返回,否则系统自动生成并返回。 不多于32字节 字符串取值范围(正则表达式):[0-9a-zA-Z_-]*
示例
{
  "errcode": 0,
  "errmsg": "string",
  "msgid": "string"
}
上一页
接收消息和事件-读取消息
下一页
发送欢迎语等事件响应消息
Built with