本文档详细梳理了企业微信消息发送、撤回、同步及相关辅助操作的23个接口信息,所有接口均采用POST请求方式、application/json的ContentType,核心依赖uuid作为企业微信实例唯一标识实现操作;接口覆盖文本、多媒体、卡片、直播等多类型消息发送,还支持消息撤回、同步离线记录、语音转文字、消息已读、引用消息回复等功能,部分大文件/大视频消息需走大文件上传而非CDN上传,群发消息限制为每天每人一次,各接口调用成功均返回errcode:0、errmsg:ok的标准响应。
对接文档

思维导图

详细总结
本文档为企业微信消息获取及发送的接口开发文档,共包含23个接口的详细调用规则,所有接口均遵循统一的基础请求规范,按功能可分为基础操作、单类型消息发送、群聊专属消息、批量/高级消息四大类,以下为分点详细总结:
一、基础请求通用规则
所有接口的请求方式均为POST,ContentType固定为application/json;
核心必传参数为uuid(String类型),作为每个企业微信实例的唯一标识,所有操作均基于该参数定位具体实例;
接口调用成功的标准返回格式为:{"data": {...}, "errcode": 0, "errmsg": "ok"},失败则返回对应错误码及信息;
部分接口包含kf_id扩展字段,仅用于客服消息回复,正常发送可忽略并填0。
二、消息基础操作接口(5个)
涵盖消息撤回、同步、语音转文字、已读标记等基础功能,关键参数及规则如下:
|
接口名称
|
请求URL
|
核心必传参数
|
功能说明
|
关键规则
|
| --- | --- | --- | --- | --- |
|
撤回消息
|
/wxwork/RevokeMsg
|
uuid、msgid(int)、roomid(long)
|
撤回单聊/群聊消息
|
群消息填群id,单聊填0
|
|
同步消息记录
|
/wxwork/SyncAllData
|
uuid、limit(int)、seq(int)
|
同步离线期间的消息
|
seq建议传消息回调的server_id,is_select=1需继续遍历
|
|
语音转文字
|
/wxwork/SpeechToTextEntity
|
uuid、msgid(int)
|
将语音消息转为文字
|
仅需语音消息的msgid,返回转换后的文本
|
|
已读消息
|
/wxwork/MarkAsRead
|
uuid、send_userid(long)、isRoom(bool)
|
去除聊天小红点
|
send_userid为好友/群id,区分单聊/群聊
|
|
引用消息
|
/wxwork/sendQuoteMsg
|
uuid、send_userid、isRoom、content、quoteMsg
|
回复并引用历史消息
|
quoteMsg需包含原消息完整信息,支持8种消息类型引用
|
三、单类型消息发送接口(13个)
支持文本、多媒体、卡片、位置等单一类型消息发送,部分多媒体接口需CDN相关参数,大文件/大视频需走专属接口并采用大文件上传,核心差异如下:
文本类:SendTextMsg(纯文本)、SendTextAndExpMsg(文本+表情),后者content为对象数组,区分msgtype(0=文本、3=表情);
CDN多媒体类:包含图片(SendCDNImgMsg)、文件(SendCDNFileMsg)、语音(SendCDNVoiceMsg)、视频(SendCDNVideoMsg),均需cdnkey、aeskey、md5、fileSize四大核心参数,语音需加voice_time(时长),视频需加video_duration(时长)/宽高;
大文件/大视频类:SendCDNBigVideoMsg、SendCDNBigFileMsg,禁止走CDN上传,大视频需传封面图imgurl,大文件需传文件名称;
卡片/小程序类:SendLinkMsg(连接卡片)需传url、title、imgurl;SendAppMsg(小程序)需传appid、pagepath、username等十余项参数,封面图需CDN上传参数;
视频号类:SendVideoNumber(视频号作品)、SendVideoNumberZhiBo(视频号直播),均需传封面/缩略图/头像/链接等,包含extras、objectId等专属参数;
其他单类型:SendEmotionMessage(GIF表情)需传表情地址+宽高;SendBusinessCardMsg(名片)需传名片人id/昵称/企业名;SendLocationMsg(位置)需传经度、纬度、详细地址,支持自定义地址描述。
四、群聊专属消息发送接口(2个)
专为群聊设计的@消息接口,支持简单@和格式化组合@,关键规则:
SendTextAtMsg:基础群@,需传atids数组(@的群成员id),isRoom固定为true;
SendTextAtMsgTwo:格式化@,contentva为多类型对象数组,msgtype=5为@类型,vid填0可实现@所有人,支持文本+表情+@的组合发送。
五、批量/高级消息发送接口(2个)
包含群发和多类型组合发送,有严格的调用限制和参数规则:
群发消息(SendGroupsMsg):核心限制为每天每人一次,vids数组仅能填群id或好友id,不可混填;msg_list支持文本、图片、链接、小程序、文件、视频6种消息类型组合发送,每种类型对应固定type值(如0=文本、14=图片);
引用消息(sendQuoteMsg):支持引用8种历史消息(文本/图片/文件/视频/语音/链接/名片/小程序),quoteMsg对象必须包含原消息完整信息,否则显示不全;群聊引用需传quote_roomid,单聊忽略该字段。
六、关键数字与特殊规则
群发消息限制:每天每人仅可发送一次;
大文件/大视频:必须走大文件上传,禁止使用CDN上传;
@所有人:SendTextAtMsgTwo中msgtype=5且vid=0即可实现;
消息同步:SyncAllData的limit为每次返回消息数量,seq为查询下标,建议同步消息回调的server_id。