# 回调消息

手机U聊客户端用户可以通过公众号操作界面操作收到的消息,并将操作结果通过U聊系统回调API反馈给业务系统。

# 客户端菜单点击事件消息格式

新公众平台支持为所有公众号配置客户端菜单,效果如图:

菜单示意图

当用户点击客户端菜单的某一项,根据菜单项配置的类型不同,U聊后台会给对接系统发送一条消息类型为7的事件消息,该事件消息也可由公众平台代为处理。

对于消息类型为7-客户端菜单点击事件的消息,消息体reply格式如下:

{
    "CreateTime":1426841235979,
    "Event": "click",
    "EventKey": "xxxxxxxx"
}
  • CreateTime: 菜单项点击时间

  • Event: 暂时支持click-用户触发点击事件;view-用户客户端直接转跳web url事件

  • EventKey: Event为click类型时,为一串系统自定义的key,系统可以按此key做个性化处理和应答;

    Event为view类型时,key为用户转跳的url

业务系统所需要做的就是配置好公众号的消息处理URL(按需设置,非必须)和 状态处理URL(按需设置,非必须),并按照约定开发相关的接口(接口详情参考下文)即可。

具体设置过程参考 申请公众号账号

# 消息接口详情

消息类型与消息格式

# 消息投递状态接口

当有需要时,U聊系统可以通过主动调用反馈接入系统已发送消息的投递状态。

  • 提供方:接入系统

  • 发起方:U聊服务端

  • 接口路径:接入系统提供

  • 调用方式:HTTP POST

  • 请求格式:application/json;charset=UTF-8

  • 请求编码:UTF-8

  • 请求参数:

    属性 说明
    token 消息ID已发送消息的唯一标识
    status 消息投递状态
    userid 消息对应用户账号id
    accessToken U聊系统回调令牌,对接可以在公众平台配置回调令牌(可选)。如配置该令牌,U聊系统回调会带上该令牌参数,对接系统可凭借此调用判断是否合法的U 聊后台调用

    # 参数详细说明:

    • status
      说明
      0 已发送,已成功发送到U聊服务器即此状态,不会再次通知接入系统
      1 已送达,用户手机已接受消息,但是尚未阅读
      2 已读, 用户已阅读消息
      98 不满足发送权限,目标用户不属于公众号发布范围内,拒绝投递该消息
      99 报文格式非法,服务器在投递消息时无法解析该消息,无法投递该消息

# 响应

  • 应答格式:application/json;charset=UTF-8
  • 应答编码:UTF-8
  • 应答数据:暂未使用。

# 用户回复消息处理接口

U聊收到用户回复给接入系统消息时,主动通知接入系统处理消息时调用的接口。

  • 提供方:接入系统

  • 发起方:U聊服务端

  • 接口路径:接入系统提供

  • 调用方式:HTTP POST

  • 请求格式:application/json;charset=UTF-8

  • 请求编码:UTF-8

  • 请求参数:

    属性 说明
    reply 用户回复给接入系统的消息格式报文体
    userid 用户OA账号,即登陆OA的用户名,用于标识消息发送者
    type 用户回复消息类型
    accessToken U聊系统回调令牌,对接可以在公众平台配置回调令牌(可选)。如配置该令牌,U聊系统回调会带上该令牌参数,对接系统可凭借此调用判断是否合法的U聊后台调用

    # 参数详细说明:

    • type
      说明
      1 文本消息
      2 图片消息
      5 语音消息
      6 视频消息
      7 菜单点击事件消息
      8 文件附件消息

# 响应

  • 应答格式:application/json;charset=UTF-8
  • 应答编码:UTF-8
  • 应答数据:暂未使用。
上次更新: 3/10/2021, 5:36:02 PM