企业客服接口说明

向企业号客服发送客服消息

• 接口说明

该接口用于向客服人员发送消息，支持文本、图片、文件消息。sender和receiver有且只有一个类型为kf。当receiver为kf时，表示向客服发送用户咨询的问题消息。当sender为kf时，表示客服从其它IM工具回复客户，并同步消息到客服的微信上

• 请求说明

Https请求方式: POST

https://qyapi.weixin.qq.com/cgi-bin/kf/send?access_token=ACCESS_TOKEN

请求包结构体为：

text消息请求：

{
   "sender":
   {
       "type": "userid",
       "id": "lisi"
   },
   "receiver":
   {
       "type": "kf",
       "id": "zhangsan"
   },
   "msgtype": "text",
   "text":
   {
       "content":"hello!"
   }
}

• 参数说明

参数	必须	说明
sender	是	发送人
receiver	是	接收人
type	是	用户类型，有下面几种 1. kf 客服 2. userid 客户，企业员工userid 3. openid 客户，公众号openid
id	是	用户ID，ID类型由type指定
msgtype	是	消息类型，此时固定为：text
content	是	消息内容

image消息请求：

{
   "sender":
   {
       "type": "userid",
       "id": "lisi"
   },
   "receiver":
   {
       "type": "kf",
       "id": "zhangsan"
   },
   "msgtype": "image",
   "image":
   {
       "media_id":"MEDIA_ID"
   }
}

参数	必须	说明
sender	是	发送人
receiver	是	接收人
type	是	用户类型，有下面几种 1. kf 客服 2. userid 客户，企业员工userid 3. openid 客户，公众号openid
id	是	用户ID，ID类型由type指定
msgtype	是	消息类型，此时固定为：image
media_id	是	图片media_id，可以调用上传素材文件接口获取

• 返回结果

{
   "errcode": 0,
   "errmsg": "ok"
}

file消息请求：

{
   "sender":
   {
       "type": "userid",
       "id": "lisi"
   },
   "receiver":
   {
       "type": "kf",
       "id": "zhangsan"
   },
   "msgtype": "file",
   "file":
   {
       "media_id":"MEDIA_ID"
   }
}

参数	必须	说明
sender	是	发送人
receiver	是	接收人
type	是	用户类型，有下面几种 1. kf 客服 2. userid 客户，企业员工userid 3. openid 客户，公众号openid
id	是	用户ID，ID类型由type指定
msgtype	是	消息类型，此时固定为：file
media_id	是	文件media_id，可以调用上传素材文件接口获取。文件须大于4字节

• 返回结果

{
   "errcode": 0,
   "errmsg": "ok"
}

voice消息请求：

{
   "sender":
   {
       "type": "userid",
       "id": "lisi"
   },
   "receiver":
   {
       "type": "kf",
       "id": "zhangsan"
   },
   "msgtype": "voice",
   "voice":
   {
       "media_id":"MEDIA_ID"
   }
}

参数	必须	说明
sender	是	发送人
receiver	是	接收人
type	是	用户类型，有下面几种 1. kf 客服 2. userid 客户，企业员工userid 3. openid 客户，公众号openid
id	是	用户ID，ID类型由type指定
msgtype	是	消息类型，此时固定为：voice
media_id	是	语音media_id，可以调用上传素材文件接口获取。size须大于4字节

• 返回结果

{
   "errcode": 0,
   "errmsg": "ok"
}

获取客服列表

• 请求说明

Https请求方式: GET

https://qyapi.weixin.qq.com/cgi-bin/kf/list?access_token=ACCESS_TOKEN&type=TYPE

• 参数说明

参数	必须	说明
type	否	客服类型 1. internal 只获取内部客服列表 2. external 只获取外部客服列表 不填时，同时返回内部、外部客服列表

• 返回结果

{
   "errcode": 0,
   "errmsg": "ok",
   
   "internal":
   {
       "user": ["zhangsan", "lisi"],
       "party": [2, 3, 4],
       "tag": [10]
   },
   "external":
   {
       "user": ["zhangsan", "lisi"],
       "party": [2, 3, 4],
       "tag": [10]
   }
}