客户联系「联系我」管理- 接口文档- 企业微信开发者中心

文章推薦指數: 80 %
投票人數:10人

企业需要使用“客户联系”secret或配置到“可调用应用”列表中的自建应用secret所获取的accesstoken来调用(accesstoken如何获取?)。

使用人员需要配置了客户联系功能。

第 ... 第三方应用开发快速入门 服务端API 客户端API 运营规范 附录 更新日志 联系我们 开发指南开发前必读基本概念介绍获取服务商凭证回调配置企业微信帐号ID安全性全面升级代开发应用安全性升级ID转换接口unionid与external_userid的关联应用授权企业授权应用成员授权应用通讯录权限体系接口调用获取第三方应用凭证获取预授权码设置授权配置获取企业永久授权码获取企业授权信息获取企业凭证获取应用的管理员列表获取应用二维码明文corpid转换为加密corpid回调接口概述推送suite_ticket授权通知事件成员通知事件部门通知事件标签通知事件共享应用事件回调重置永久授权码通知应用管理员变更通知推广二维码接入指引调用接口获取注册码查询注册状态设置授权应用可见范围设置通讯录同步完成回调通知注册完成回调事件自建应用代开发概述企业应用代开发流程与自建应用接口的差异ID转换接口获取带参授权链接代开发应用权限说明代开发应用安全性升级通讯录管理概述成员管理创建成员读取成员更新成员删除成员批量删除成员获取部门成员获取部门成员详情userid与openid互换二次验证邀请成员手机号获取userid获取成员授权列表查询成员用户是否已授权获取选人ticket对应的用户userid转换为open_userid邮箱获取userid部门管理创建部门更新部门删除部门获取部门列表获取子部门ID列表获取单个部门详情标签管理创建标签更新标签名字删除标签获取标签成员增加标签成员删除标签成员获取标签列表异步导入接口概述增量更新成员全量覆盖成员全量覆盖部门获取异步任务结果异步导出接口概述导出成员导出成员详情导出部门导出标签成员获取导出结果导出任务完成通知通讯录回调通知成员通知事件部门通知事件标签通知事件异步任务完成通知通讯录展示组件通讯录搜索通讯录ID转译概述上传需要转译的文件异步通讯录id转译获取异步任务结果异步任务回调通知通讯录userid排序第三方通讯录编辑授权身份验证网页授权登录开始开发构造网页授权链接获取访问用户身份获取访问用户敏感信息扫码授权登录接入指引获取登录用户信息客户联系概述成员对外信息企业服务人员管理获取配置了客户联系功能的成员列表客户联系「联系我」管理客户管理获取客户列表获取客户详情批量获取客户详情修改客户备注信息企业主体unionid转换为第三方external_userid第三方主体unionid转换为第三方external_userid代开发应用external_userid转换客户标签管理管理企业标签编辑客户企业标签在职继承分配在职成员的客户查询客户接替状态分配在职成员的客户群离职继承获取待分配的离职成员列表分配离职成员的客户查询客户接替状态分配离职成员的客户群客户群管理获取客户群列表获取客户群详情客户群opengid转换联系我与客户入群方式客户联系「联系我」管理客户朋友圈概述企业发表内容到客户的朋友圈获取客户朋友圈全部的发表记录消息推送创建企业群发获取企业的全部群发记录发送新客户欢迎语入群欢迎语素材管理统计管理获取「联系客户统计」数据获取「群聊数据统计」数据变更回调事件格式管理商品图册管理聊天敏感词上传附件资源微信客服概述客服帐号管理添加客服帐号删除客服帐号修改客服帐号获取客服帐号列表获取客服帐号链接接待人员管理添加接待人员删除接待人员获取接待人员列表会话分配与消息收发分配客服会话接收消息和事件发送消息发送欢迎语等事件响应消息「升级服务」配置其他基础信息获取获取客户基础信息获取企业状态信息统计管理获取「客户数据统计」企业汇总数据获取「客户数据统计」接待人员明细数据接口调用许可概述与指引订单管理下单购买帐号下单续期帐号获取订单列表获取订单详情获取订单中的帐号列表帐号管理激活帐号获取激活码详情获取企业的帐号列表获取成员的激活详情帐号继承应用管理获取应用的接口许可状态回调通知接口许可失效通知支付成功通知退款结果通知自动激活回调通知自动激活设置设置企业的许可自动激活状态查询企业的许可自动激活状态应用管理获取应用设置工作台自定义展示消息推送概述发送应用消息发送应用模板消息更新模版卡片消息接收消息与事件消息格式事件格式被动回复消息格式撤回应用消息素材管理概述上传临时素材上传图片获取临时素材获取高清语音素材OA打卡获取员工打卡规则获取打卡记录数据获取打卡日报数据获取打卡月报数据获取打卡人员排班信息为打卡人员排班获取设备打卡数据审批概述复制/更新模板到企业获取审批模板详情提交审批申请审批申请状态变化回调通知批量获取审批单号获取审批申请详情获取企业假期管理配置获取成员假期余额修改成员假期余额自建应用审批流程引擎效率工具日程概述日历接口日程接口回调事件直播概述创建预约直播修改预约直播取消预约直播删除直播回放在微信中观看直播或直播回放获取成员直播ID列表获取直播详情获取直播观看明细直播回调事件获取跳转小程序商城的直播观众信息微盘概述空间管理空间权限文件管理文件权限文件分块上传版本和容量管理回调事件企业支付对外收款概述获取对外收款记录获取收款项目的商户单号企业互联概述获取应用共享信息获取下级企业付费版本信息上下游概述获取应用共享信息电子发票概述查询电子发票更新发票状态批量更新发票状态批量查询电子发票家校沟通概述接入指引基础接口获取「学校通知」二维码管理「学校通知」的关注模式发送「学校通知」获取外部联系人详情外部联系人openid转换手机号转外部联系人ID管理「老师可查看班级」模式获取可使用的家长范围网页授权登录开始开发构造网页授权链接获取访问用户身份学生与家长管理创建学生删除学生更新学生批量创建学生批量删除学生批量更新学生创建家长删除家长更新家长批量创建家长批量删除家长批量更新家长读取学生或家长获取部门成员详情设置家校通讯录自动同步模式获取部门家长详情部门管理创建部门更新部门删除部门获取部门列表标准年级对照表修改自动升年级的配置家校通讯录变更回调成员变更事件部门变更事件家校应用上课直播获取老师直播ID列表获取直播详情获取观看直播统计获取未观看直播统计删除直播回放获取观看直播统计V2获取未观看直播统计V2班级收款获取学生付款结果获取订单详情注册成为企业微信服务商,以提供SaaS应用及服务。

了解更多第三方应用开发服务端API客户联系企业服务人员管理客户联系「联系我」管理调试工具 客户联系「联系我」管理 目录权限说明配置客户联系「联系我」方式获取企业已配置的「联系我」方式获取企业已配置的「联系我」列表更新企业已配置的「联系我」方式删除企业已配置的「联系我」方式结束临时会话结束语定义附录权限说明调用相关接口应满足如下的权限要求:企业需要使用“客户联系”secret或配置到“可调用应用”列表中的自建应用secret所获取的accesstoken来调用(accesstoken如何获取?)。

使用人员需要配置了客户联系功能。

第三方调用时,应用需具有“企业客户权限->客户联系->配置「联系我」二维码”权限。

第三方/自建应用调用时,传入的userid和partyid需要在此应用的可见范围内。

配置的使用成员必须在企业微信激活且已经过实名认证。

临时会话的二维码具有有效期,添加企业成员后仅能在指定有效期内进行会话,仅支持医疗行业企业创建。

临时会话模式可以配置会话结束时自动发送给用户的结束语。

 配置客户联系「联系我」方式企业可以在管理后台-客户联系-加客户中配置成员的「联系我」的二维码或者小程序按钮,客户通过扫描二维码或点击小程序上的按钮,即可获取成员联系方式,主动联系到成员。

企业可通过此接口为具有客户联系功能的成员生成专属的「联系我」二维码或者「联系我」按钮。

如果配置的是「联系我」按钮,需要开发者的小程序接入小程序插件。

注意:通过API添加的「联系我」不会在管理端进行展示,每个企业可通过API最多配置50万个「联系我」。

用户需要妥善存储返回的config_id,config_id丢失可能导致用户无法编辑或删除「联系我」。

临时会话模式不占用「联系我」数量,但每日最多添加10万个,并且仅支持单人。

临时会话模式的二维码,添加好友完成后该二维码即刻失效。

 请求方式:POST(HTTPS)请求地址:https://qyapi.weixin.qq.com/cgi-bin/externalcontact/add_contact_way?access_token=ACCESS_TOKEN请求示例: { "type":1, "scene":1, "style":1, "remark":"渠道客户", "skip_verify":true, "state":"teststate", "user":["zhangsan","lisi","wangwu"], "party":[2,3], "is_temp":true, "expires_in":86400, "chat_expires_in":86400, "unionid":"oxTWIuGaIt6gTKsQRLau2M0AAAA", "conclusions": { "text": { "content":"文本消息内容" }, "image": { "media_id":"MEDIA_ID" }, "link": { "title":"消息标题", "picurl":"https://example.pic.com/path", "desc":"消息描述", "url":"https://example.link.com/path" }, "miniprogram": { "title":"消息标题", "pic_media_id":"MEDIA_ID", "appid":"wx8bd80126147dfAAA", "page":"/path/index.html" } } } 参数说明: 参数必须说明access_token是调用接口凭证type是联系方式类型,1-单人,2-多人scene是场景,1-在小程序中联系,2-通过二维码联系style否在小程序中联系时使用的控件样式,详见附表remark否联系方式的备注信息,用于助记,不超过30个字符skip_verify否外部客户添加时是否无需验证,默认为truestate否企业自定义的state参数,用于区分不同的添加渠道,在调用“获取外部联系人详情”时会返回该参数值,不超过30个字符user否使用该联系方式的用户userID列表,在type为1时为必填,且只能有一个party否使用该联系方式的部门id列表,只在type为2时有效is_temp否是否临时会话模式,true表示使用临时会话模式,默认为falseexpires_in否临时会话二维码有效期,以秒为单位。

该参数仅在is_temp为true时有效,默认7天,最多为14天chat_expires_in否临时会话有效期,以秒为单位。

该参数仅在is_temp为true时有效,默认为添加好友后24小时,最多为14天unionid否可进行临时会话的客户unionid,该参数仅在is_temp为true时有效,如不指定则不进行限制conclusions否结束语,会话结束时自动发送给客户,可参考“结束语定义”,仅在is_temp为true时有效注意,每个联系方式最多配置100个使用成员(包含部门展开后的成员)当设置为临时会话模式时(即is_temp为true),联系人仅支持配置为单人,暂不支持多人使用unionid需要调用方(企业或服务商)的企业微信“客户联系”中已绑定微信开发者账户 返回结果: { "errcode":0, "errmsg":"ok", "config_id":"42b34949e138eb6e027c123cba77fAAA", "qr_code":"http://p.qpic.cn/wwhead/duc2TvpEgSdicZ9RrdUtBkv2UiaA/0" } 参数说明: 参数说明errcode返回码errmsg对返回码的文本描述内容config_id新增联系方式的配置idqr_code联系我二维码链接,仅在scene为2时返回 获取企业已配置的「联系我」方式获取企业配置的「联系我」二维码和「联系我」小程序按钮。

请求方式:POST(HTTPS)请求地址:https://qyapi.weixin.qq.com/cgi-bin/externalcontact/get_contact_way?access_token=ACCESS_TOKEN请求示例: { "config_id":"42b34949e138eb6e027c123cba77fad7" } 参数说明: 参数必须说明access_token是调用接口凭证config_id是联系方式的配置id 返回结果: { "errcode":0, "errmsg":"ok", "contact_way": { "config_id":"42b34949e138eb6e027c123cba77fAAA", "type":1, "scene":1, "style":2, "remark":"testremark", "skip_verify":true, "state":"teststate", "qr_code":"http://p.qpic.cn/wwhead/duc2TvpEgSdicZ9RrdUtBkv2UiaA/0", "user":["zhangsan","lisi","wangwu"], "party":[2,3], "is_temp":true, "expires_in":86400, "chat_expires_in":86400, "unionid":"oxTWIuGaIt6gTKsQRLau2M0AAAA", "conclusions": { "text": { "content":"文本消息内容" }, "image": { "pic_url":"http://p.qpic.cn/pic_wework/XXXXX" }, "link": { "title":"消息标题", "picurl":"https://example.pic.com/path", "desc":"消息描述", "url":"https://example.link.com/path" }, "miniprogram": { "title":"消息标题", "pic_media_id":"MEDIA_ID", "appid":"wx8bd80126147dfAAA", "page":"/path/index" } } } } 参数说明: 参数说明errcode返回码errmsg对返回码的文本描述内容config_id新增联系方式的配置idtype联系方式类型,1-单人,2-多人scene场景,1-在小程序中联系,2-通过二维码联系is_temp是否临时会话模式,默认为false,true表示使用临时会话模式remark联系方式的备注信息,用于助记skip_verify外部客户添加时是否无需验证state企业自定义的state参数,用于区分不同的添加渠道,在调用“获取外部联系人详情”时会返回该参数值style小程序中联系按钮的样式,仅在scene为1时返回,详见附录qr_code联系二维码的URL,仅在scene为2时返回user使用该联系方式的用户userID列表party使用该联系方式的部门id列表expires_in临时会话二维码有效期,以秒为单位chat_expires_in临时会话有效期,以秒为单位unionid可进行临时会话的客户unionidconclusions结束语,可参考“结束语定义” 获取企业已配置的「联系我」列表获取企业配置的「联系我」二维码和「联系我」小程序插件列表。

不包含临时会话。

注意,该接口仅可获取2021年7月10日以后创建的「联系我」请求方式:POST(HTTPS)请求地址:https://qyapi.weixin.qq.com/cgi-bin/externalcontact/list_contact_way?access_token=ACCESS_TOKEN请求示例: { "start_time":1622476800, "end_time":1625068800, "cursor":"CURSOR", "limit":1000 } 参数说明: 参数必须说明access_token是调用接口凭证start_time否「联系我」创建起始时间戳,默认为90天前end_time否「联系我」创建结束时间戳,默认为当前时间cursor否分页查询使用的游标,为上次请求返回的next_cursorlimit否每次查询的分页大小,默认为100条,最多支持1000条 返回结果: { "errcode":0, "errmsg":"ok", "contact_way": [ { "config_id":"534b63270045c9ABiKEE814ef56d91c62f" }, { "config_id":"87bBiKEE811c62f63270041c62f5c9A4ef" } ], "next_cursor":"NEXT_CURSOR" } 参数说明: 参数说明errcode返回码errmsg对返回码的文本描述内容contact_way.config_id联系方式的配置idnext_cursor分页参数,用于查询下一个分页的数据,为空时表示没有更多的分页 更新企业已配置的「联系我」方式更新企业配置的「联系我」二维码和「联系我」小程序按钮中的信息,如使用人员和备注等。

请求方式:POST(HTTPS)请求地址:https://qyapi.weixin.qq.com/cgi-bin/externalcontact/update_contact_way?access_token=ACCESS_TOKEN请求示例: { "config_id":"42b34949e138eb6e027c123cba77fAAA", "remark":"渠道客户", "skip_verify":true, "style":1, "state":"teststate", "user":["zhangsan","lisi","wangwu"], "party":[2,3], "expires_in":86400, "chat_expires_in":86400, "unionid":"oxTWIuGaIt6gTKsQRLau2M0AAAA", "conclusions": { "text": { "content":"文本消息内容" }, "image": { "media_id":"MEDIA_ID" }, "link": { "title":"消息标题", "picurl":"https://example.pic.com/path", "desc":"消息描述", "url":"https://example.link.com/path" }, "miniprogram": { "title":"消息标题", "pic_media_id":"MEDIA_ID", "appid":"wx8bd80126147dfAAA", "page":"/path/index" } } } 参数说明: 参数必须说明access_token是调用接口凭证config_id是企业联系方式的配置idremark否联系方式的备注信息,不超过30个字符,将覆盖之前的备注skip_verify否外部客户添加时是否无需验证style否样式,只针对“在小程序中联系”的配置生效state否企业自定义的state参数,用于区分不同的添加渠道,在调用“获取外部联系人详情”时会返回该参数值user否使用该联系方式的用户列表,将覆盖原有用户列表party否使用该联系方式的部门列表,将覆盖原有部门列表,只在配置的type为2时有效expires_in否临时会话二维码有效期,以秒为单位,该参数仅在临时会话模式下有效chat_expires_in否临时会话有效期,以秒为单位,该参数仅在临时会话模式下有效unionid否可进行临时会话的客户unionid,该参数仅在临时会话模式有效,如不指定则不进行限制conclusions否结束语,会话结束时自动发送给客户,可参考“结束语定义”,仅临时会话模式(is_temp为true)可设置注意:已失效的临时会话联系方式无法进行编辑当临时会话模式时(即is_temp为true),联系人仅支持配置为单人,暂不支持多人返回结果: { "errcode":0, "errmsg":"ok" } 参数说明: 参数说明errcode返回码errmsg对返回码的文本描述内容 删除企业已配置的「联系我」方式删除一个已配置的「联系我」二维码或者「联系我」小程序按钮。

请求方式:POST(HTTPS)请求地址:https://qyapi.weixin.qq.com/cgi-bin/externalcontact/del_contact_way?access_token=ACCESS_TOKEN请求示例: { "config_id":"42b34949e138eb6e027c123cba77fAAA" } 参数说明: 参数必须说明access_token是调用接口凭证config_id是企业联系方式的配置id 返回结果: { "errcode":0, "errmsg":"ok" } 参数说明: 参数说明errcode返回码errmsg对返回码的文本描述内容结束临时会话将指定的企业成员和客户之前的临时会话断开,断开前会自动下发已配置的结束语。

请求方式:POST(HTTPS)请求地址:https://qyapi.weixin.qq.com/cgi-bin/externalcontact/close_temp_chat?access_token=ACCESS_TOKEN请求示例: { "userid":"zhangyisheng", "external_userid":"woAJ2GCAAAXtWyujaWJHDDGi0mACHAAA" } 参数说明: 参数必须说明access_token是调用接口凭证userid是企业成员的useridexternal_userid是客户的外部联系人userid注意:请保证传入的企业成员和客户之间有仍然有效的临时会话,通过其他方式的添加外部联系人无法通过此接口关闭会话。

 返回结果: { "errcode":0, "errmsg":"ok", } 参数说明: 参数说明errcode返回码errmsg对返回码的文本描述内容 结束语定义字段内容: "conclusions": { "text": { "content":"文本消息内容" }, "image": { "media_id":"MEDIA_ID", "pic_url":"http://p.qpic.cn/pic_wework/XXXXX" }, "link": { "title":"消息标题", "picurl":"https://example.pic.com/path", "desc":"消息描述", "url":"https://example.link.com/path" }, "miniprogram": { "title":"消息标题", "pic_media_id":"MEDIA_ID", "appid":"wx8bd80126147dfAAA", "page":"/path/index" } } } 参数说明: 参数说明text.content消息文本内容,最长为4000字节image.media_id图片的media_idimage.pic_url图片的urllink.title图文消息标题,最长为128字节link.picurl图文消息封面的urllink.desc图文消息的描述,最长为512字节link.url图文消息的链接miniprogram.title小程序消息标题,最长为64字节miniprogram.pic_media_id小程序消息封面的mediaid,封面图建议尺寸为520*416miniprogram.appid小程序appid,必须是关联到企业的小程序应用miniprogram.page小程序page路径text、image、link和miniprogram四者不能同时为空;text与另外三者可以同时发送,此时将会以两条消息的形式触达客户;image、link和miniprogram只能有一个,如果三者同时填,则按image、link、miniprogram的优先顺序取参,也就是说,如果image与link同时传值,则只有image生效;media_id可以通过素材管理接口获得;构造结束语使用image消息时,只能填写meida_id字段,获取含有image结构的联系我方式时,返回pic_url字段。

 附录企业微信为“在小程序中联系”按钮提供了如下的默认样式,用户可根据需要自行选择,style参数和样式的对应关系如下:单人类型:样式1(style=1):样式2(style=2):样式3(style=3):多人类型:样式1(style=1):样式2(style=2):上一篇获取配置了客户联系功能的成员列表下一篇获取客户列表关于腾讯|用户协议|帮助中心©1998 - 2022 TencentInc.AllRightsReserved本节内容权限说明配置客户联系「联系我」方式获取企业已配置的「联系我」方式获取企业已配置的「联系我」列表更新企业已配置的「联系我」方式删除企业已配置的「联系我」方式结束临时会话结束语定义附录



請為這篇文章評分?