尧图网站设计 尧图网站设计YAOTU DESIGN
ARTICLE DETAIL

资讯详情

深耕网站设计与一线实操的经验洞察。

【企业微信】基于IPAD协议的群发接口技术规范:支持联系人与客户群消息推送的API系统设计

【企业微信】基于IPAD协议的群发接口技术规范:支持联系人与客户群消息推送的API系统设计 一、简要总结本文档为企业微信控制台群发接口完整规范所有接口采用POST请求、application/json格式uuid 为必传唯一实例标识核心服务地址为[172.0.0.18083](172.0.0.18083)朋友圈任务、成员客户列表接口使用本地 8085/8083 端口共6 个核心接口覆盖群发全流程支持联系人群发isroom0与客户群群发isroom1返回统一以errcode0标识请求成功。功能导图功能文档调用示例请求参数{ uuid: 1688853790599424, id: 109948045799913290, //消息id seq: 0, //默认 sendtype: 0 //默认 }返回响应{ data: { listdata: [ { now_cnt: 110129274704417637, total_cnt: 110129274704417637, time_stamp: 1680439372, keywords: [ 555 //如果是群消息则 这里是名字关键词筛选 ], id: 110129274704417637, seq: 9704108, content: [ { atList: [], content: sadfdsafsad } ], msg_send_vids: [ 1688853790599424 ] } ], is_end: false, seq: 0 }, errcode: 0, errmsg: ok }五、详细总结1. 基础请求规范请求方式POST内容类型application/json必传参数uuidString 类型企业微信实例唯一标识服务地址核心群发接口http://172.0.0.18083朋友圈任务http://127.0.0.1:8085成员客户列表http://127.0.0.1:8083返回规范errcode0表示请求成功errmsgok 为成功提示。2. 核心接口详情表格接口序号接口功能请求 URL核心参数关键说明1.11.1确认群发消息/wxwork/oksendgroupuuid、msgid、isroom、vidsisroom0 联系人群发1 客户群群发vids 客户群需填群 ID1.11.2获取未发送群发列表/wxwork/GetGroupMsgListuuid返回 listdata消息列表、is_end、seq1.11.3获取客户群发送列表/wxwork/QueryGroupSendRequuid、id、keywordsid 群发任务 IDkeywords 支持关键词筛选群聊1.11.4获取群发任务详情/wxwork/GetGroupMsgInfouuid、id、seq、sendtypeid 消息 IDseq/sendtype 默认传 01.11.5朋友圈任务执行/wxwork/oksendsnsmsguuid、msgidmsgid 朋友圈任务 ID本地 8085 端口1.11.6管理员查成员客户列表/wxwork/MemberCustomerStatuuid、vid、limit、start_indexlimit 默认 500start_index 首次传 0分页查询3. 消息内容支持类型未发送群发列表返回的 content 支持文本、图片、视频、文件、网页链接、小程序6 类消息包含 file_id、aes_key、md5、size 等媒体文件核心字段。4. 分页与筛选规则客户群列表支持keywords 关键词筛选无筛选传空数组。成员客户列表start_index0为首次查询下次查询为上一次 start_indexlimitnext_start-1 表示无更多数据。六、关键问题问题 1如何区分联系人群发和客户群群发答案通过isroom参数区分isroom0为联系人群发isroom1为客户群群发客户群群发时需在vids参数中填写对应客户群 ID联系人群发 vids 可空。问题 2获取未发送群发列表接口返回的核心数据有哪些答案核心返回数据为data.listdata未发送消息数组单条消息包含id消息唯一 ID、content消息内容、time_stamp时间戳、seq序号、now_cnt/total_cnt发送计数同时返回is_end是否最后一页、seq分页序号。问题 3管理员查询企业成员客户列表的分页参数如何使用答案必传vid成员 IDlimit默认500单次查询数量start_index首次查询传0后续分页需传入上一次 start_indexlimit返回next_start-1时表示已查询完所有客户数据。
返回列表