简要描述:

  • 接口版本:

版本号 制定人 制定日期 修订日期
1.0.0 kevin 2022-03-29

请求URL:

  • ws://xx.com

请求方式:

  • websocket

请求头:

参数名 是否必须 类型 说明

请求参数:

参数名 是否必须 类型 说明
action string getCustomerServiceV1
device_type string 设备类型【app=,pc=PC端,h5=移动端,desktop=桌面端】
group_type string 固定值 one
link_type string ws
module string unionchat
key string 客服key
domain string 域名
send_uid string 发送者uid
send_name string 发送者头像名称,没有则默认值
send_avatar string 发送者头像,全路径,没有则默认值

返回示例:

正确时返回:

{
  "action": "getCustomerServiceV1",
  "status": 200,
  "msg": "获取成功",
  "data": {
    "uid": 24,
    "nickname": "kevin01",
    "avatar": "https://kf.unioncms.cn/uploads/preview/avatar/2021/10/19/616e3f2da878a.jpg",
    "online_status": "1",
    "msg_list": [
      "您好,kevin01为您服务,请问有什么可以帮您?",
      "您好,欢迎使用在线客服\r\n请输入你需要询问的问题!"
    ]
  }
}

错误时返回:

{
    action: "getCustomerService"
    data: []
    msg: "目前客服繁忙,请稍后再试"
    status: 0
}

返回参数说明:

参数名 类型 说明

备注:

文档更新时间: 2022-03-29 11:31   作者:admin
上一篇:
下一篇: