简要描述:

  • 请求接口后,调用

接口版本:

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

请求URL:

  • ws://xx.com

请求方式:

  • websocket

请求头:

参数名 是否必须 类型 说明

请求参数:

参数名 是否必须 类型 说明
action string sendMessageV1
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,例如 164851762487827
send_name string 发送者头像名称,没有则默认值
send_avatar string 发送者头像,全路径,没有则默认值
to_uid string 接收者uid,例如 24
to_name string 接收者头像名称,没有则默认值
to_avatar string 接收者头像,全路径,没有则默认值
uid_key string 客服uid和游客uid,中间用 _ 连接,例如 24_164851762487827
type string 类型【1=文字,2=图片,3=语音,4=视频,5=文件,6=链接】
content string 发送者头像,全路径,没有则默认值

返回示例:

正确时返回:

{
  "action": "sendMessageV1",
  "status": 200,
  "msg": "发送成功",
  "data": {
    "link_type": "ws",
    "module": "unionchat",
    "device_type": "pc",
    "group_type": "one",
    "uid_key": "24_164851762487827",
    "key": "a4923dec987c960a15d6ad3076cec028",
    "domain": "yht.com",
    "send_uid": "164851762487827",
    "send_name": "131****0001-8",
    "send_avatar": "http://yht.com/uploads/user/avatar/2021-08-14/61178f7a1ac2c.png",
    "to_uid": 24,
    "to_name": "kevin01",
    "to_avatar": "https://kf.unioncms.cn/uploads/preview/avatar/2021/10/19/616e3f2da878a.jpg",
    "type": 1,
    "content": "😜😜😜😀😀",
    "msg_id": "1648524584292382"
  }
}

错误时返回:

{}

返回参数说明:

参数名 类型 说明
content string 内容
created_at string 时间
msg_id string 信息id
send_avatar string 发送者头像
send_nickname string 发送者昵称
send_uid string 谁发的【客服uid或者用户ip】
to_uid string 发给谁【客服uid或者用户ip】
type string 类型【1=文字,2=图片,3=语音,4=视频,5=文件】
uid_key string 会话唯一key

备注:

文档更新时间: 2022-03-29 13:47   作者:admin