客服相关接口

客服接口

开发者在根据开发文档的要求完成开发后,使用6.0.2版及以上版本的微信用户在与公众号进行客服沟通,公众号使用不同的客服账号进行回复后,用户可以看到对应的客服头像和昵称。

请注意,必须先在公众平台官网为公众号设置微信号后才能使用该能力。

每个公众号最多添加10个客服账号。

添加客服帐号

  • 请求方式:POST
  • 接口地址:https://api.weixin.qq.com/customservice/kfaccount/add?access_token=ACCESS_TOKEN
  • 请求JSON:
{
  "kf_account": "test1@test",
  "nickname": "客服1",
  "password": "pswmd5"
}Code language: JSON / JSON with Comments (json)
  • 正确返回:{"errcode": 0, "errmsg": "ok"}

修改客服帐号

  • 请求方式:POST
  • 接口地址:https://api.weixin.qq.com/customservice/kfaccount/update?access_token=ACCESS_TOKEN
  • 请求JSON:
{
  "kf_account": "test1@test",
  "nickname": "客服1",
  "password": "pswmd5"
}Code language: JSON / JSON with Comments (json)
  • 正确返回:{"errcode": 0, "errmsg": "ok"}

删除客服帐号

  • 请求方式:GET
  • 接口地址:https://api.weixin.qq.com/customservice/kfaccount/del?access_token=ACCESS_TOKEN
  • 请求JSON:
{
  "kf_account": "test1@test",
  "nickname": "客服1",
  "password": "pswmd5"
}Code language: JSON / JSON with Comments (json)
  • 返回:{"errcode": 0, "errmsg": "ok"}

设置客服帐号的头像

  • 头像图片文件必须是jpg格式,推荐使用640 * 640大小的图片以达到最佳效果。
  • 请求方式:POST/FORM
  • 接口地址:http://api.weixin.qq.com/customservice/kfaccount/uploadheadimg?access_token=ACCESS_TOKEN&kf_account=KFACCOUNT
  • 调用示例:使用curl命令,用FORM表单方式上传一个多媒体文件。
  • 正确返回:{"errcode": 0, "errmsg": "ok"}

获取所有客服账号

  • 获取客服基本信息,包括客服工号、客服昵称、客服登录账号。
  • 请求方式:GET
  • 接口地址:https://api.weixin.qq.com/cgi-bin/customservice/getkflist?access_token=ACCESS_TOKEN
  • 正确返回示例:
{
  "kf_list": [
    {
      "kf_account": "test1@test",
      "kf_nick": "test1",
      "kf_id": "1001",
      "kf_headimgurl": "http://mmbiz.qpic.cn/..."
    },
    {
      "kf_account": "test2@test",
      "kf_nick": "test2",
      "kf_id": "1002",
      "kf_headimgurl": "http://mmbiz.qpic.cn/..."
    },
    {
      "kf_account": "test3@test",
      "kf_nick": "test3",
      "kf_id": "1003",
      "kf_headimgurl": "http://mmbiz.qpic.cn/..."
    }
  ]
}Code language: JSON / JSON with Comments (json)

接口的统一参数说明

参数是否必须说明
access_token调用接口凭证
kf_account完整客服账号,格式为:账号前缀@公众号微信号
kf_nick客服昵称
kf_id客服工号
nickname客服昵称,最长6个汉字或12个英文字符
password客服账号登录密码,格式为密码明文的32位加密MD5值。该密码仅用于在公众平台官网的多客服功能中使用,若不使用多客服功能,则不必设置密码
media该参数仅在设置客服头像时出现,是form-data中媒体文件标识,有filename、filelength、content-type等信息

客服接口-发消息

  • 接口地址:POST https://api.weixin.qq.com/cgi-bin/message/custom/send?access_token=ACCESS_TOKEN

发送文本消息:

{
  "touser": "OPENID",
  "msgtype": "text",
  "text": {
    "content": "Hello World"
  }
}Code language: JSON / JSON with Comments (json)

发送图片消息:

{
  "touser": "OPENID",
  "msgtype": "image",
  "image": {
    "media_id": "MEDIA_ID"
  }
}Code language: JSON / JSON with Comments (json)

补充说明

客服接口-发消息”(接口地址:POST https://api.weixin.qq.com/cgi-bin/message/custom/send?access_token=ACCESS_TOKEN),各类型消息的 JSON 结构如下:

发送语音消息

{
  "touser": "OPENID",
  "msgtype": "voice",
  "voice": {
    "media_id": "MEDIA_ID"
  }
}Code language: JSON / JSON with Comments (json)

发送视频消息

{
  "touser": "OPENID",
  "msgtype": "video",
  "video": {
    "media_id": "MEDIA_ID",
    "thumb_media_id": "MEDIA_ID",
    "title": "TITLE",
    "description": "DESCRIPTION"
  }
}Code language: JSON / JSON with Comments (json)

发送音乐消息

{
  "touser": "OPENID",
  "msgtype": "music",
  "music": {
    "title": "MUSIC_TITLE",
    "description": "MUSIC_DESCRIPTION",
    "musicurl": "MUSIC_URL",
    "hqmusicurl": "HQ_MUSIC_URL",
    "thumb_media_id": "THUMB_MEDIA_ID"
  }
}Code language: JSON / JSON with Comments (json)

发送图文消息

图文消息条数限制在10条以内,注意,如果图文数超过10,则将会无响应。

{
  "touser": "OPENID",
  "msgtype": "news",
  "news": {
    "articles": [
      {
        "title": "Happy Day",
        "description": "Is Really A Happy Day",
        "url": "URL",
        "picurl": "PIC_URL"
      },
      {
        "title": "Happy Day",
        "description": "Is Really A Happy Day",
        "url": "URL",
        "picurl": "PIC_URL"
      }
    ]
  }
}Code language: JSON / JSON with Comments (json)

开发注意事项补充

  • 语音/视频media_id 需为临时素材(上传接口返回)的 ID,且语音格式需符合微信限制(如 amr/mp3,大小不超过 2MB/5MB 等,参考前序章节)。
  • 视频/音乐thumb_media_id 为缩略图素材 ID;音乐消息中的 musicurlhqmusicurl 需为有效的音频链接。
  • 图文消息:单条图文建议包含 titledescriptionurl(点击跳转)、picurl(封面图),最多 8 条(旧版限制常提 10 条,当前官方多为 8 条,以最新文档为准,图中强调不超过 10 条)。
  • 所有消息均需替换 OPENID 为目标用户,接口调用需携带有效的 access_token

发表回复

您的邮箱地址不会被公开。 必填项已用 * 标注