第三方应用开发
基础
数据与智能专区
应用接收专区通知
连接微信
客户联系
办公
小程序接入对外收款
第三方应用开发
服务端API
微信客服
客服账号管理
获取客服账号链接
获取客服账号链接
最后更新:2024/03/04

企业可通过此接口获取带有不同参数的客服链接,不同客服账号对应不同的客服链接。获取后,企业可将链接嵌入到网页等场景中,微信用户点击链接即可向对应的客服账号发起咨询。企业可依据参数来识别用户的咨询来源等。

 

请求方式: POST(HTTPS

请求地址: https://qyapi.weixin.qq.com/cgi-bin/kf/add_contact_way?access_token=ACCESS_TOKEN

请求示例:

{
	"open_kfid": "OPEN_KFID",
    "scene": "12345"
}

参数说明:

参数必须类型说明
access_tokenstring调用接口凭证
open_kfidstring客服账号ID
scenestring场景值,字符串类型,由开发者自定义。
不多于32字节
字符串取值范围(正则表达式):[0-9a-zA-Z_-]*
1. 若scene非空,返回的客服链接开发者可拼接scene_param=SCENE_PARAM参数使用,用户进入会话事件会将SCENE_PARAM原样返回。其中SCENE_PARAM需要urlencode,且encode前的原始长度不能超过128字节
如 https://work.weixin.qq.com/kf/kfcbf8f8d07ac7215f?enc_scene=ENCGFSDF567DF&scene_param=a%3D1%26b%3D2
2. 返回的客服链接,不能修改或复制参数到其他链接使用。否则进入会话事件参数校验不通过,导致无法回调。

权限说明:
调用的应用需要满足如下的权限

应用类型权限要求
自建应用配置到「 微信客服- 可调用接口的应用」中
第三方应用具有“微信客服->获取基础信息”权限
代开发自建应用具有“微信客服->获取基础信息”权限
微信客服组件应用具有“管理接入的微信客服->获取企业授权接入的客服账号->客服账号信息与链接”权限,仅可获取企业已授权的客服账号链接

注: 从2023年12月1日0点起,不再支持通过系统应用secret调用接口,存量企业暂不受影响 查看详情

返回结果:

{
   "errcode": 0,
   "errmsg": "ok",
   "url":"https://work.weixin.qq.com/kf/kfcbf8f8d07ac7215f?enc_scene=ENCGFSDF567DF"
}

参数说明:

参数类型说明
errcodeint32返回码
errmsgstring对返回码的文本描述内容
urlstring客服链接,开发者可将该链接嵌入到H5页面中,用户点击链接即可向对应的微信客服账号发起咨询。开发者也可根据该url自行生成需要的二维码图片
上一篇获取客服账号列表
下一篇添加接待人员
    本节内容
服务端API
基础
数据与智能专区
应用接收专区通知
连接微信
客户联系
办公
小程序接入对外收款
客户端API
小程序
基础
连接微信
办公
WECOM-JSSDK
JS-SDK
基础
连接微信
办公
更新日志
联系我们