客服管理


上一篇 : 将消息转发到客服 下一篇: 会话控制



目录

1.1 获取客服基本信息

1.2 添加客服帐号

1.3 邀请绑定客服帐号

1.4 设置客服信息

1.5 上传客服头像

1.6 删除客服帐号

1.7 客服管理接口返回码说明

获取客服基本信息

调用说明

http请求方式: GET https://api.weixin.qq.com/cgi-bin/customservice/getkflist?access_token=ACCESS_TOKEN

返回说明

返回数据示例(正确时的JSON返回结果):

{
     "kf_list" : [
        {
           "kf_account" : "test1@test",
           "kf_headimgurl" : "http://mmbiz.qpic.cn/mmbiz/4whpV1VZl2iccsvYbHvnphkyGtnvjfUS8Ym0GSaLic0FD3vN0V8PILcibEGb2fPfEOmw/0",
           "kf_id" : "1001",
           "kf_nick" : "ntest1",
           "kf_wx" : "kfwx1"
        },
        {
           "kf_account" : "test2@test",
           "kf_headimgurl" : "http://mmbiz.qpic.cn/mmbiz/4whpV1VZl2iccsvYbHvnphkyGtnvjfUS8Ym0GSaLic0FD3vN0V8PILcibEGb2fPfEOmw/0",
           "kf_id" : "1002",
           "kf_nick" : "ntest2",
           "kf_wx" : "kfwx2"
        },
        {
           "kf_account" : "test3@test",
           "kf_headimgurl" : "http://mmbiz.qpic.cn/mmbiz/4whpV1VZl2iccsvYbHvnphkyGtnvjfUS8Ym0GSaLic0FD3vN0V8PILcibEGb2fPfEOmw/0",
           "kf_id" : "1003",
           "kf_nick" : "ntest3",
           "invite_wx" : "kfwx3",
           "invite_expire_time" : 123456789,
           "invite_status" : "waiting"
        }
     ]
}

参数说明

参数 说明
kf_account 完整客服帐号,格式为:帐号前缀@公众号微信号
kf_nick 客服昵称
kf_id 客服编号
kf_headimgurl 客服头像
kf_wx 如果客服帐号已绑定了客服人员微信号, 则此处显示微信号
invite_wx 如果客服帐号尚未绑定微信号,但是已经发起了一个绑定邀请, 则此处显示绑定邀请的微信号
invite_expire_time 如果客服帐号尚未绑定微信号,但是已经发起过一个绑定邀请, 邀请的过期时间,为unix 时间戳
invite_status 邀请的状态,有等待确认“waiting”,被拒绝“rejected”, 过期“expired”

调用说明

http请求方式: GET https://api.weixin.qq.com/cgi-bin/customservice/getonlinekflist?access_token=ACCESS_TOKEN

返回说明

返回数据示例(正确时的JSON返回结果):
{
    "kf_online_list" : [
        {
            "kf_account" :
 "test1@test" ,
             "status" : 1,
             "kf_id" :
 "1001" ,
             "accepted_case" : 1
        },
        {
            "kf_account" :
 "test2@test" ,
             "status" : 1,
             "kf_id" :
 "1002" ,
             "accepted_case" : 2
        }
    ]
}

参数说明

参数 说明
kf_account 完整客服帐号,格式为:帐号前缀@公众号微信号
status 客服在线状态,目前为:1、web 在线
kf_id 客服编号
accepted_case 客服当前正在接待的会话数

添加客服帐号

调用说明

http请求方式: POST https://api.weixin.qq.com/customservice/kfaccount/add?access_token=ACCESS_TOKEN POST数据示例如下:
  {
     "kf_account" : "test1@test",
     "nickname" : "客服1"
  }

参数说明

参数 说明
kf_account 完整客服帐号,格式为:帐号前缀@公众号微信号,帐号前缀最多10个字符,必须是英文、数字字符或者下划线,后缀为公众号微信号,长度不超过30个字符
nickname 客服昵称,最长16个字

返回说明

返回数据示例(正确时的JSON返回结果):
  {
     "errcode"
  : 0,
     "errmsg"
  :
 "ok"
  }

主要返回码

返回码 说明
0 成功
65400 API不可用,即没有开通/升级到新客服功能
65403 客服昵称不合法
65404 客服帐号不合法
65405 帐号数目已达到上限,不能继续添加
65406 已经存在的客服帐号

邀请绑定客服帐号

新添加的客服帐号是不能直接使用的,只有客服人员用微信号绑定了客服账号后,方可登录Web客服进行操作。此接口发起一个绑定邀请到客服人员微信号,客服人员需要在微信客户端上用该微信号确认后帐号才可用。尚未绑定微信号的帐号可以进行绑定邀请操作,邀请未失效时不能对该帐号进行再次绑定微信号邀请。

调用说明

http请求方式: POST https://api.weixin.qq.com/customservice/kfaccount/inviteworker?access_token=ACCESS_TOKEN POST数据示例如下:
  {
     "kf_account" : "test1@test",
     "invite_wx" : "test_kfwx"
  }

参数说明

参数 说明
kf_account 完整客服帐号,格式为:帐号前缀@公众号微信号
invite_wx 接收绑定邀请的客服微信号

返回说明

返回数据示例(正确时的JSON返回结果):
  {
     "errcode"
  : 0,
     "errmsg"
  :
 "ok"
  }

主要返回码

返回码 说明
0 成功
65400 API不可用,即没有开通/升级到新版客服
65401 无效客服帐号
65407 邀请对象已经是本公众号客服
65408 本公众号已发送邀请给该微信号
65409 无效的微信号
65410 邀请对象绑定公众号客服数量达到上限(目前每个微信号最多可以绑定5个公众号客服帐号)
65411 该帐号已经有一个等待确认的邀请,不能重复邀请
65412 该帐号已经绑定微信号,不能进行邀请

设置客服信息

调用说明

http请求方式: POST https://api.weixin.qq.com/customservice/kfaccount/update?access_token=ACCESS_TOKEN POST数据示例如下:
  {
     "kf_account" : "test1@test",
     "nickname" : "客服1"
  }

参数说明

参数 说明
kf_account 完整客服帐号,格式为:帐号前缀@公众号微信号
nickname 客服昵称,最长16个字

返回说明

返回数据示例(正确时的JSON返回结果):
  {
     "errcode"
  : 0,
     "errmsg"
  :
 "ok"
  }

主要返回码

返回码 说明
0 成功
65400 API不可用,即没有开通/升级到新版客服功能
65401 无效客服帐号
65403 客服昵称不合法

上传客服头像

调用说明

http请求方式: POST/FORM
https://api.weixin.qq.com/customservice/kfaccount/uploadheadimg?access_token=ACCESS_TOKEN&kf_account=KFACCOUNT

  调用示例(使用curl命令,用FORM表单方式上传一个多媒体文件):
curl -F media=@test.jpg "https://api.weixin.qq.com/customservice/kfaccount/uploadheadimg?access_token=ACCESS_TOKEN&kf_account=KFACCOUNT"

参数说明

参数 说明
kf_account 完整客服帐号,格式为:帐号前缀@公众号微信号
media form-data 中媒体文件标识,有filename、filelength、content-type 等信息,文件大小为5M 以内

返回说明

返回数据示例(正确时的JSON返回结果):
  {
     "errcode"
  : 0,
     "errmsg"
  :
 "ok"
  }

主要返回码

返回码 说明
0 成功
65400 API不可用,即没有开通/升级到新版客服功能
65401 无效客服帐号
65403 客服昵称不合法
40005 不支持的媒体类型
40009 媒体文件长度不合法

删除客服帐号

调用说明

http请求方式: GET https://api.weixin.qq.com/customservice/kfaccount/del?access_token=ACCESS_TOKEN&kf_account=KFACCOUNT

参数说明

参数 说明
kf_account 完整客服帐号,格式为:帐号前缀@公众号微信号

返回说明

返回数据示例(正确时的JSON返回结果):
  {
     "errcode"
  : 0,
     "errmsg"
  :
 "ok"
  }

主要返回码

返回码 说明
0 成功
65400 API不可用,即没有开通/升级到新版客服功能
65401 无效客服帐号

客服管理接口返回码说明

返回码 说明
0 成功
65400 API不可用,即没有开通/升级到新版客服功能
65401 无效客服帐号
65403 客服昵称不合法
65404 客服帐号不合法
65405 帐号数目已达到上限,不能继续添加
65406 已经存在的客服帐号
65407 邀请对象已经是该公众号客服
65408 本公众号已经有一个邀请给该微信
65409 无效的微信号
65410 邀请对象绑定公众号客服数达到上限(目前每个微信号可以绑定5个公众号客服帐号)
65411 该帐号已经有一个等待确认的邀请,不能重复邀请
65412 该帐号已经绑定微信号,不能进行邀请
40005 不支持的媒体类型
40009 媒体文件长度不合法


上一篇 : 将消息转发到客服 下一篇: 会话控制