客服回复消息回调

来自企业号开发者接口文档
跳转至: 导航搜索

回调企业

客服给用户回复的消息、客服人员新增或删除事件,通过http协议回调给开发者。企业号在用http协议推送时,会打上keep-alive选项,如果企业支持则保持长连接,此连接根据消息量可以有多个。

注意事项

1、 回调时,一个数据包可包含多个消息或事件(多个Item节点)

2、 当回调失败时(连接失败、请求超时等),最大重试间隔20分钟,最大重试时长1天

3、 企业在收到数据包时,需回复XML里的PackageId节点值,表示成功接收,否则企业号侧认为回调失败。PackageId企业内唯一

报文格式如下

解密前:

<xml>
   <Encrypt><![CDATA[ENCRYPT_DATA]]></Encrypt>
   <ToUserName>CORPID</ToUserName>
   <AgentType>kf_internal</AgentType>
</xml>

解密后:

<xml>
   <AgentType>kf_internal</AgentType>
   <ToUserName>CORPID</ToUserName>
   <ItemCount>3</ItemCount>
   <PackageId>3156175696255</PackageId>
   <Item>
       <FromUserName><![CDATA[UserID]]></FromUserName>
       <CreateTime>1348831860</CreateTime>
       <MsgType><![CDATA[text]]></MsgType>
       <Content><![CDATA[test message]]></Content>
       <MsgId>1234567890123456</MsgId>
       <Receiver>
           <Type>userid</Type>
           <Id>lisi</Id>
       </Receiver>
   </Item>
   <Item>
       <FromUserName><![CDATA[UserID]]></FromUserName>
       <CreateTime>1348831860</CreateTime>
       <MsgType><![CDATA[image]]></MsgType>
       <PicUrl><![CDATA[this is a url]]></PicUrl>
       <MediaId><![CDATA[media_id]]></MediaId>
       <MsgId>1234567890123456</MsgId>
       <Receiver>
           <Type>userid</Type>
           <Id>lisi</Id>
       </Receiver>
   </Item>
   <Item>
       <FromUserName><![CDATA[UserID]]></FromUserName>
       <CreateTime>1348831860</CreateTime>
       <MsgType><![CDATA[event]]></MsgType>
       <Event><![CDATA[subscribe]]></Event>
   </Item>
</xml>
参数 说明
参数 描述
AgentType 应用类型,这里有两种类型
1. kf_internal
企业号内部客服,客户为企业号通讯录成员
2. kf_external
企业号外部客服,客户为服务号openid
ToUserName 企业号CorpID
ItemCount Item数量
Item Item,客服消息、事件的 XML节点
PackageId 回调包ID,uint64类型,企业内唯一。



接收消息

text消息

<Item>
   <FromUserName><![CDATA[UserID]]></FromUserName>
   <CreateTime>1348831860</CreateTime>
   <MsgType><![CDATA[text]]></MsgType>
   <Content><![CDATA[test message]]></Content>
   <MsgId>1234567890123456</MsgId>
   <Receiver>
       <Type>userid</Type>
       <Id>lisi</Id>
   </Receiver>
</Item>
参数 说明
FromUserName 客服UserID
CreateTime 消息创建时间(整型)
MsgType 消息类型,此时固定为:text
Content 消息内容
MsgId 消息id,64位整型
Receiver 接收人
Type 接收人类型,包括以下类型
1. userid
企业号通讯录成员ID
2. openid
服务号成员openid
Id 接收人的值,类型由Type指定

image消息

<Item>
   <FromUserName><![CDATA[fromUser]]></FromUserName>
   <CreateTime>1348831860</CreateTime>
   <MsgType><![CDATA[image]]></MsgType>
   <PicUrl><![CDATA[this is a url]]></PicUrl>
   <MediaId><![CDATA[media_id]]></MediaId>
   <MsgId>1234567890123456</MsgId>
   <Receiver>
       <Type>userid</Type>
       <Id>lisi</Id>
   </Receiver>
</Item>
参数 说明
FromUserName 客服UserID
CreateTime 消息创建时间(整型)
MsgType 消息类型,此时固定为:image
PicUrl 图片链接
MediaId 图片media_id,可以调用获取素材文件接口拉取数据
MsgId 消息id,64位整型
Receiver 接收人
Type 接收人类型,包括以下类型
1. userid
企业号通讯录成员ID
2. openid
服务号成员openid
Id 接收人的值,类型由Type指定



file消息

<Item>
   <FromUserName><![CDATA[fromUser]]></FromUserName>
   <CreateTime>1348831860</CreateTime>
   <MsgType><![CDATA[file]]></MsgType>
   <MediaId><![CDATA[media_id]]></MediaId>
   <MsgId>1234567890123456</MsgId>
   <Receiver>
       <Type>userid</Type>
       <Id>lisi</Id>
   </Receiver>
</Item>
参数 说明
FromUserName 客服UserID
CreateTime 消息创建时间(整型)
MsgType 消息类型,此时固定为:file
MediaId 文件media_id,可以调用获取素材文件接口拉取数据
MsgId 消息id,64位整型
Receiver 接收人
Type 接收人类型,包括以下类型
1. userid
企业号通讯录成员ID
2. openid
服务号成员openid
Id 接收人的值,类型由Type指定



voice消息

<Item>
   <FromUserName><![CDATA[fromUser]]></FromUserName>
   <CreateTime>1348831860</CreateTime>
   <MsgType><![CDATA[voice]]></MsgType>
   <MediaId><![CDATA[media_id]]></MediaId>
   <MsgId>1234567890123456</MsgId>
   <Receiver>
       <Type>userid</Type>
       <Id>lisi</Id>
   </Receiver>
</Item>
参数 说明
FromUserName 客服UserID
CreateTime 消息创建时间(整型)
MsgType 消息类型,此时固定为:voice
MediaId 语音media_id,可以调用获取素材文件接口拉取数据
MsgId 消息id,64位整型
Receiver 接收人
Type 接收人类型,包括以下类型
1. userid
企业号通讯录成员ID
2. openid
服务号成员openid
Id 接收人的值,类型由Type指定



link消息

<Item>
   <FromUserName><![CDATA[fromUser]]></FromUserName>
   <CreateTime>1348831860</CreateTime>
   <MsgType><![CDATA[link]]></MsgType>
   <Title><![CDATA[TITLE]]></Title>
   <Description><![CDATA[DESCRIPTION]]></Description>
   <Url><![CDATA[URL]]></Url>
   <PicUrl><![CDATA[PIC_URL]]></PicUrl>
   <MsgId>1234567890123456</MsgId>
   <Receiver>
       <Type>userid</Type>
       <Id>lisi</Id>
   </Receiver>
</Item>
参数 说明
FromUserName 成员UserID
CreateTime 消息创建时间(整型)
MsgType 消息类型,此时固定为:link
Title 标题
Description 描述
Url 链接
PicUrl 图片链接
MsgId 消息id,64位整型
Receiver 接收人
Type 接收人类型,包括以下类型
1. userid
企业号通讯录成员ID
2. openid
服务号成员openid
Id 接收人的值,类型由Type指定



location消息

<Item>
   <FromUserName><![CDATA[fromUser]]></FromUserName>
   <CreateTime>1348831860</CreateTime>
   <MsgType><![CDATA[location]]></MsgType>
   <Location_X>23.134521</Location_X>
   <Location_Y>113.358803</Location_Y>
   <Scale>20</Scale>
   <Label><![CDATA[位置信息]]></Label>
   <MsgId>1234567890123456</MsgId>
   <Receiver>
       <Type>userid</Type>
       <Id>lisi</Id>
   </Receiver>
</Item>
参数 说明
FromUserName 成员UserID
CreateTime 消息创建时间(整型)
MsgType 消息类型,此时固定为:location
Location_X 地理位置纬度
Location_Y 地理位置经度
Scale 地图缩放大小
Label 地理位置信息
MsgId 消息id,64位整型
Receiver 接收人
Type 接收人类型,包括以下类型
1. userid
企业号通讯录成员ID
2. openid
服务号成员openid
Id 接收人的值,类型由Type指定



应用事件

<Item>
   <FromUserName><![CDATA[UserID]]></FromUserName>
   <CreateTime>1348831860</CreateTime>
   <MsgType><![CDATA[event]]></MsgType>
   <Event><![CDATA[subscribe]]></Event>
</Item>
参数 说明
FromUserName 客服UserID
CreateTime 消息创建时间(整型)
MsgType 消息类型,此时固定为:event
Event 事件类型,subscribe(订阅)、unsubscribe(取消订阅)